讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

Laper
Laper

剧本策划到成片协作

剧云
剧云

中文短剧剧本制作平台

如何在 Pydantic 中精准校验 JSON 兼容的数据结构

千敏君_7540

千敏君_7540

发布时间:2026-02-19 12:24:01

|

431人浏览过

|

来源于php中文网

原创

如何在 Pydantic 中精准校验 JSON 兼容的数据结构

本文介绍如何使用 Pydantic 内置的 JsonValue 类型(v2.0+)安全、高效地校验任意层级嵌套的 JSON 兼容数据(如字典、列表、字符串、数字、布尔值或 None),避免递归类型定义错误,并确保值可无损序列化为标准 JSON。

本文介绍如何使用 pydantic 内置的 `jsonvalue` 类型(v2.0+)安全、高效地校验任意层级嵌套的 json 兼容数据(如字典、列表、字符串、数字、布尔值或 none),避免递归类型定义错误,并确保值可无损序列化为标准 json。

在构建 API 或处理外部输入时,我们常需确保某个字段是「真正可 JSON 序列化的数据」——即它必须能被 json.dumps() 无异常地转换为 JSON 字符串。虽然 Dict[str, Any] 看似可用,但它允许 datetime、UUID、自定义对象等非 JSON 原生类型,导致后续序列化失败;而 pydantic.Json 仅用于解析 JSON 字符串(如 '"hello"' → "hello"),不适用于已解析的 Python 数据结构。

Pydantic v2 起提供了开箱即用的 JsonValue 类型,专为此场景设计。它是一个严格受限的联合类型,精确对应 JSON 规范支持的 7 种原子与复合值:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
from pydantic import BaseModel, JsonValue
from typing import Dict, List

# ✅ 正确:直接校验任意 JSON 兼容值
class PayloadModel(BaseModel):
    data: JsonValue

# ✅ 正确:若明确要求顶层为对象(即 JSON object),可限定为字典
class ObjectModel(BaseModel):
    config: Dict[str, JsonValue]

# ✅ 示例:合法输入(全部可通过校验)
valid_inputs = [
    {"name": "Alice", "scores": [95, 87], "active": True, "meta": None},
    ["a", 42, False],
    "string",
    3.14,
    None,
]

for inp in valid_inputs:
    try:
        model = PayloadModel(data=inp)
        print(f"✓ Valid: {inp}")
    except Exception as e:
        print(f"✗ Invalid: {inp} → {e}")

# ❌ 以下会校验失败(因不可 JSON 序列化)
invalid_inputs = [
    {"created_at": datetime.now()},  # datetime 不在 JsonValue 中
    {"id": uuid4()},                 # UUID 不被允许
    {"func": lambda x: x},          # 可调用对象非法
]

⚠️ 注意事项:

  • JsonValue 不包含 bytes、decimal.Decimal、Enum、datetime 等常见非 JSON 类型,这是其核心设计目标:保证 .model_dump_json() 或 json.dumps(model.model_dump()) 永远不会抛出 TypeError。
  • 若需支持扩展类型(如 datetime 转 ISO 字符串),应配合 @field_serializer 自定义序列化逻辑,而非放宽 JsonValue 类型。
  • 在 Pydantic v1 中无原生等价物,需手动定义递归类型(易出错且不推荐);升级至 v2+ 是最佳实践。
  • JsonValue 是 type alias,非运行时校验器,但其类型提示会与 Pydantic 的验证逻辑深度协同,提供静态检查 + 动态校验双重保障。

总结而言,JsonValue 是校验「已解析 JSON 数据结构」的黄金标准。当你的模型字段预期接收来自 json.loads() 的结果、前端传来的原始对象/数组,或需确保下游 json.dumps() 安全时,请直接使用 JsonValue —— 简洁、准确、零配置,且完全符合 JSON 规范语义。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

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

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

2315

2023.08.07

json是什么
json是什么

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

3802

2023.08.23

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

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

1256

2023.10.13

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

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

4399

2025.09.10

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

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

1918

2023.08.03

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

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

3144

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6364

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

6469

2023.11.24

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

80

2026.11.06

热门下载

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

精品课程

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

共101课时 | 21.3万人学习

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

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn