0

0

Python schema 校验的 pydantic + jsonschema 组合

舞夢輝影

舞夢輝影

发布时间:2026-02-24 20:57:10

|

666人浏览过

|

来源于php中文网

原创

pydantic模型转json schema时字段缺失需用field显式声明description/examples,union/optional生成的nullable需自定义generatejsonschema处理;校验不一致因jsonschema仅做结构检查,不执行pydantic运行时逻辑,关键路径应使用model_validate()。

python schema 校验的 pydantic + jsonschema 组合

pydantic 模型转 jsonschema 时字段缺失或类型错乱

直接调用 model.json_schema() 通常能生成可用 schema,但常见字段如 descriptionexamplesnullable 不会自动出现,除非你在字段注解里显式加了 Field(..., description="...")。更隐蔽的问题是:如果用了 Union[str, None]Optional[str],生成的 schema 默认带 "type": ["string", "null"],但某些 JSON Schema 验证器(比如旧版 jsonschema Python 库)不认 "null" 类型,只认 "type": "string" + "nullable": true(需启用 OpenAPI 3.1 兼容模式)。

实操建议:

立即学习Python免费学习笔记(深入)”;

  • model.json_schema(schema_generator=GenerateJsonSchema) 并传入自定义 GenerateJsonSchema 子类,覆盖 _generate_nullable_schema 方法来统一输出 "nullable": true
  • 若只需快速兼容老验证器,加参数 mode="validation"(默认值),避免意外触发 OpenAPI 专用字段
  • 字段级文档必须靠 Field(description=...),光写 docstring 不生效

jsonschema.validate() 校验 pydantic 生成的 schema 时抛 ValidationError: Additional properties are not allowed

这是典型 schema 和数据结构不匹配——不是校验逻辑错了,而是你拿 pydantic 模型生成的 schema 去校验一个“多字段”的原始 dict,而该模型本身没声明这些字段(即没设 extra="allow")。pydantic 默认拒绝未知字段,生成的 schema 也带 "additionalProperties": false,但外部数据可能带调试字段、时间戳、trace_id 等。

实操建议:

立即学习Python免费学习笔记(深入)”;

  • 校验前先确认数据是否真的该被模型完全覆盖;如果不是,要么改模型(加 Config.extra = "allow"),要么在校验前用 dict.keys() & set(model.__fields__.keys()) 过滤字段
  • 别依赖 jsonschema.validate() 的报错信息反推 pydantic 行为——它不会告诉你哪个字段触发了 additionalProperties,只会笼统报错
  • 若必须保留严格校验,用 model.model_validate(data) 替代纯 jsonschema 校验,错误位置和原因更准

嵌套模型 + 循环引用导致 RecursionError 或 schema 无限展开

pydantic v2 对循环引用支持有限:比如 A 包含 B 字段,B 又包含 A 字段,调用 A.json_schema() 会直接爆栈。即使加了 from __future__ import annotations 和字符串前向引用("A"),生成器仍可能在解析时展开过深。

宣小二
宣小二

宣小二:媒体发稿平台,自媒体发稿平台,短视频矩阵发布平台,基于AI驱动的企业自助式投放平台。

下载

实操建议:

立即学习Python免费学习笔记(深入)”;

  • 优先用 pydantic.BaseModel.model_rebuild() 显式重建模型,尤其在模块间交叉引用后
  • 对已知循环结构,手动用 JsonSchemaValue 注入占位 schema,例如:field: "A" = Field(default=None, json_schema_extra={"$ref": "#/definitions/A"}),再单独在顶层 json_schema()["definitions"] 里补定义
  • 避免在 Field(default_factory=...) 里动态构造嵌套模型实例,这会让 schema 生成器误判为需递归展开

校验结果和 pydantic 报错不一致,比如 jsonschema 说 ok,但 model.model_validate()value_error.missing

根本原因是两者校验层级不同:jsonschema 只做结构+类型检查,不执行 pydantic 的运行时逻辑,比如 BeforeValidatordefault_factoryalias 映射、strict=True 强制类型等。一个字段在 schema 里是 "type": "string",但 pydantic 实际要求它必须是 str(不能是 int 转来的),jsonschema 不管这个。

实操建议:

立即学习Python免费学习笔记(深入)”;

  • 不要把 jsonschema 校验当作 pydantic 校验的替代品,它只是前置过滤;关键路径必须走 model_validate()
  • 如果要用 jsonschema 做快速预筛,确保模型里没用 before_validatorafter_validatordefault_factory 这类无法映射到 schema 的特性
  • 检查 Config.strict 是否开启——开启后 pydantic 会拒绝隐式类型转换,而 jsonschema 默认允许数字字符串过 string 类型校验

最麻烦的其实是混合使用场景:前端用 jsonschema 做表单生成,后端用 pydantic 做解析。这时候 schema 必须手工对齐 strict 模式、nullable 处理、日期格式(date vs string with format: date),差一点就丢数据或报错。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

448

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

323

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

850

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

246

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

866

2024.03.01

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

246

2023.09.22

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

1

2026.02.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号