0

0

Pydantic 中正确建模 JSON 兼容字典类型的方法

花韻仙語

花韻仙語

发布时间:2026-02-19 11:06:05

|

705人浏览过

|

来源于php中文网

原创

Pydantic 中正确建模 JSON 兼容字典类型的方法

本文详解如何在 Pydantic 中精准定义和验证符合 JSON 序列化规范的嵌套字典结构(即 Dict[str, JsonValue]),避免递归类型错误,确保字段值仅包含 JSON 原生可序列化类型(str/int/float/bool/None/List/Dict)。

本文详解如何在 pydantic 中精准定义和验证符合 json 序列化规范的嵌套字典结构(即 `dict[str, jsonvalue]`),避免递归类型错误,确保字段值仅包含 json 原生可序列化类型(str/int/float/bool/none/list/dict)。

在构建 API 请求体、配置解析或数据清洗场景中,我们常需严格约束某个字段为「合法的 JSON 值」——它必须能被 json.dumps() 无异常地序列化,即仅允许 JSON 原生支持的类型:字符串、数字(int/float)、布尔值、null(对应 Python 的 None)、列表(元素也需 JSON 兼容)和字典(键必须为 str,值也需 JSON 兼容)。此时,简单使用 Dict[str, Any] 过于宽泛(如允许 datetime、set、自定义类等非 JSON 类型),而 pydantic.Json 又仅用于校验 JSON 字符串 的解析结果,均不满足需求。

Pydantic v2+ 提供了开箱即用的类型别名 JsonValue,专为此类场景设计。它是一个前向引用的递归联合类型,定义如下:

from pydantic.types import JsonValue  # ✅ 推荐导入方式(Pydantic >= 2.6)
# 或从旧路径(兼容早期 v2.x):
# from pydantic import JsonValue

# 等价于(无需手动定义,避免 RecursionError):
# JsonValue = Union[
#     List["JsonValue"],
#     Dict[str, "JsonValue"],
#     str,
#     bool,
#     int,
#     float,
#     None,
# ]

若目标是校验一个JSON 对象(即字典),应直接使用 Dict[str, JsonValue] —— 它确保键为字符串,且所有值(包括嵌套的任意层级)均为 JSON 可序列化类型:

AI抖音
AI抖音

AI抖音,会思考的抖音

下载
from typing import Dict, List
from pydantic import BaseModel, ValidationError
from pydantic.types import JsonValue

class ConfigModel(BaseModel):
    metadata: Dict[str, JsonValue]  # ✅ 正确:JSON 兼容的字典
    tags: List[JsonValue]            # ✅ 同样适用于列表

# ✅ 合法输入(全部可被 json.dumps() 处理)
valid_data = {
    "metadata": {
        "name": "app",
        "version": 1.2,
        "active": True,
        "features": ["auth", "logging"],
        "settings": {"timeout": 30, "retry": None}
    },
    "tags": ["prod", 42, False, None]
}

model = ConfigModel(**valid_data)

# ❌ 触发 ValidationError:datetime 不在 JsonValue 范围内
invalid_data = {"metadata": {"created_at": datetime.now()}}
try:
    ConfigModel(**invalid_data)
except ValidationError as e:
    print(e)
# > 1 validation error for ConfigModel
# > metadata -> created_at
# >   Input should be a valid string, number, boolean, None, list or dict [type=union_tag_invalid, input_value=datetime.datetime(...), input_type=datetime]

⚠️ 关键注意事项

  • JsonValue 是 运行时类型提示,Pydantic 在实例化时执行深度验证(包括嵌套结构),而非仅做静态类型检查;
  • 不要尝试手动重新定义 JsonValue(如 Union[Dict[str, 'JsonValue'], ...]),会导致 RecursionError —— Pydantic 已通过内部机制安全处理前向引用;
  • 若需接收 JSON 字符串并自动解析为 JsonValue 结构,应使用 Json[JsonValue](注意:Json[T] 表示“传入字符串,解析后验证为 T”);
  • JsonValue 不校验键名是否为合法 JSON 字符串(如含控制字符),但实际 JSON 序列化器(如 json.dumps)会拒绝此类键;Pydantic 默认接受,如需额外约束,可配合 Field(pattern=r'^[^\x00-\x08\x0b\x0c\x0e-\x1f]*$') 等定制校验。

综上,Dict[str, JsonValue] 是表达「JSON 对象字典」语义最准确、最简洁且经官方验证的方案,兼顾类型安全性与运行时鲁棒性,是 Pydantic v2+ 中处理 JSON 数据结构的标准实践。

热门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

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

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

244

2023.09.22

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

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

786

2024.03.01

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

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

660

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号