0

0

Pydantic 中正确建模 JSON 兼容字典类型的完整指南

花韻仙語

花韻仙語

发布时间:2026-02-19 10:46:12

|

391人浏览过

|

来源于php中文网

原创

Pydantic 中正确建模 JSON 兼容字典类型的完整指南

本文详解如何在 Pydantic(v2+)中精准定义并验证符合 JSON 序列化规范的嵌套字典结构,推荐使用内置 JsonValue 类型替代手动递归注解,避免循环引用错误,并确保类型安全与序列化兼容性。

本文详解如何在 pydantic(v2+)中精准定义并 validate 符合 json 序列化规范的嵌套字典结构,推荐使用内置 jsonvalue 类型替代手动递归注解,避免循环引用错误,并确保类型安全与序列化兼容性。

在构建 API 请求体、配置解析或第三方数据校验场景中,我们常需确保某个字段是「真正可无损转为 JSON 的 Python 值」——即仅包含 str、int、float、bool、None、list(元素也为 JSON 兼容值)、dict(键为 str,值为 JSON 兼容值)。此时,简单使用 Dict[str, Any] 过于宽泛(允许 datetime、UUID、自定义类等非 JSON 类型),而 Json[str] 又仅接受 JSON 字符串(需额外 json.loads 解析),均不符合需求。

Pydantic v2 起原生提供了 JsonValue 类型(位于 pydantic.types),它正是为此设计的递归 JSON 兼容值类型别名,定义如下:

from pydantic.types import JsonValue

# 等价于:
# JsonValue = Union[
#     str, int, float, bool, None,
#     List['JsonValue'],
#     Dict[str, 'JsonValue']
# ]

该类型严格限定所有嵌套层级的值均为 JSON 标准可序列化内容,且完全支持 Pydantic 的自动验证、类型转换与错误提示。

AI抖音
AI抖音

AI抖音,会思考的抖音

下载

✅ 正确用法:直接使用 JsonValue 或组合 Dict[str, JsonValue]

若字段应为任意 JSON 兼容值(如 { "data": [1, "hello", {"nested": true}] }),直接注解为 JsonValue 即可:

from pydantic import BaseModel, ValidationError
from pydantic.types import JsonValue

class Payload(BaseModel):
    content: JsonValue

# ✅ 合法输入(全部可被 json.dumps() 序列化)
valid = Payload(content={"users": [{"id": 1, "active": True}], "count": 3.14})

# ❌ 非法输入:包含不可序列化类型
try:
    Payload(content={"timestamp": datetime.now()})
except ValidationError as e:
    print(e)
    # > 1 validation error for Payload
    # > content.timestamp
    # >   Input should be a valid string, integer, float, boolean or None [type=invalid_type, ...]

若你明确要求字段必须是字典类型(即 JSON object),而非任意 JSON 值(如不能是字符串或列表),则应使用 Dict[str, JsonValue]:

from typing import Dict
from pydantic.types import JsonValue

class Config(BaseModel):
    metadata: Dict[str, JsonValue]  # 强制为 dict,且所有 value 必须 JSON 兼容

# ✅ 合法
Config(metadata={"version": "1.0", "features": ["auth", "logging"]})

# ❌ 错误:不是 dict
Config(metadata="not-a-dict")  # → validation error
# ❌ 错误:dict 中含非法值
Config(metadata={"error": set([1, 2])})  # → validation error (set 不可 JSON 序列化)

⚠️ 注意事项与最佳实践

  • 不要手动定义递归类型:如问题中尝试的 Union[Dict[str, 'Json'], ...] 会因前向引用未解析导致 RecursionError 或 NameError;JsonValue 已由 Pydantic 内部妥善处理。
  • JsonValue ≠ Json[str]:前者表示 已解析的 Python 值(类型为 dict/list 等),后者表示 原始 JSON 字符串(类型为 str,需 json.loads 才能使用)。
  • 性能与序列化:JsonValue 字段在模型实例化时即完成深度验证,确保 .model_dump() 或 .model_dump_json() 总能成功输出标准 JSON。
  • 兼容性:JsonValue 自 Pydantic v2.5+ 稳定可用;旧版本可临时使用 Any + 自定义 validator,但不推荐。

✅ 总结

当需要表达“一个结构合法、可直接 json.dumps() 的嵌套字典(或更广义的 JSON 值)”时,请始终优先选用 pydantic.types.JsonValue。它语义清晰、开箱即用、零配置验证,并与 Pydantic 的整个类型系统无缝集成——这是 Pydantic 对 JSON Schema 兼容性承诺的专业实现,也是现代 Python 数据验证的最佳实践。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

442

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的详细内容,可以访问本专题下面的文章。

322

2023.10.13

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

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

81

2025.09.10

css中float用法
css中float用法

css中float属性允许元素脱离文档流并沿其父元素边缘排列,用于创建并排列、对齐文本图像、浮动菜单边栏和重叠元素。想了解更多float的相关内容,可以阅读本专题下面的文章。

591

2024.04.28

C++中int、float和double的区别
C++中int、float和double的区别

本专题整合了c++中int和double的区别,阅读专题下面的文章了解更多详细内容。

105

2025.10.23

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

573

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.09.04

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

561

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

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

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