讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Pydantic 中构建序列化时不嵌套的模型

千敏吖_8353

千敏吖_8353

发布时间:2026-09-09 11:22:57

|

973人浏览过

|

来源于php中文网

原创

如何在 Pydantic 中构建序列化时不嵌套的模型

通过继承 RootModel[str] 构建轻量验证模型,可使字段在序列化时直接展开为原始值(如 "xxx"),而非嵌套对象 { "bar": { "__root__": "xxx" } },兼顾类型安全与 JSON 简洁性。

通过继承 `rootmodel[str]` 构建轻量验证模型,可使字段在序列化时直接展开为原始值(如 `"xxx"`),而非嵌套对象 `{ "bar": { "__root__": "xxx" } }`,兼顾类型安全与 json 简洁性。

在 Pydantic v2 中,若希望自定义类型(如 Foo)既保留数据校验能力,又在序列化时“透明”地展平为原始值(避免生成冗余嵌套结构),标准的 BaseModel 子类无法满足需求——因为 BaseModel 总会将其字段序列化为对象字典(例如 {"__root__": "xxx"} 或完整字段结构)。此时,RootModel 是专为此类场景设计的核心工具。

RootModel[T] 表示一个“根级模型”,其语义等价于一个被封装的单一值 T;序列化时默认输出该值本身,而非包装对象。例如:

from pydantic import RootModel, BaseModel

class Foo(RootModel[str]):
    # 自动对字符串进行基础校验(如非 None、类型匹配)
    # 可进一步添加 validator 或 field constraints
    pass

class Bar(BaseModel):
    bar: Foo

y = Bar(bar=Foo('xxx'))
print(y.model_dump_json())  # 输出: {"bar": "xxx"}

✅ 关键优势:

  • Foo('xxx') 仍执行完整验证(如传入 None 或 123 会抛出 ValidationError);
  • Bar 的 bar 字段类型清晰、IDE 友好、文档可生成;
  • 序列化结果完全扁平,符合 API 设计中对简洁 payload 的要求。

⚠️ 注意事项:

  • RootModel 不支持 Field(...) 或额外字段——它仅封装一个根值;如需复杂校验(如正则、长度限制),应使用 Annotated + AfterValidator 组合,或在 RootModel 内定义 model_validator;
  • 若仅需简单约束,推荐更轻量的 Annotated[str, AfterValidator(lambda s: s.strip())] 方式,但 RootModel 在需复用、命名和类型别名场景下更具可维护性;
  • model_dump_json() 是推荐的序列化方法(替代已弃用的 .json()),确保行为一致且支持现代选项(如 exclude_none)。

总结:当需要「带校验的标量类型」且拒绝嵌套时,RootModel[T] 是 Pydantic v2 的标准解法。它让模型既是类型契约,又是序列化契约,真正实现验证与表现的解耦。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

WorkBuddy

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

DeepSeek

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

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

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1891

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5164

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1829

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

31217

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3687

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3707

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

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