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

如何构建序列化时不产生嵌套结构的 Pydantic 模型

小静小哥_1469

小静小哥_1469

发布时间:2026-09-09 10:06:46

|

600人浏览过

|

来源于php中文网

原创

如何构建序列化时不产生嵌套结构的 Pydantic 模型

通过继承 RootModel[str] 构建自定义类型,可在保留完整字段验证能力的同时,使模型序列化输出扁平化(如 {"bar": "xxx"}),避免多余嵌套层级。

通过继承 `rootmodel[str]` 构建自定义类型,可在保留完整字段验证能力的同时,使模型序列化输出扁平化(如 {"bar": "xxx"}),避免多余嵌套层级。

在 Pydantic v2 中,若希望某个字段(如 bar)既接受定制化验证逻辑(例如非空字符串、长度限制、正则匹配等),又在序列化时不包装为对象(即不输出 {"bar": {"root": "xxx"}}),标准的 BaseModel 子类无法满足需求——因为它默认将整个模型序列化为一个 JSON 对象。

此时,RootModel 是专为此类场景设计的核心工具。它表示“根级值模型”,其本质是将一个单一值(如 str、int、list 等)作为模型的“根”,而非字段容器。当 Foo 继承 RootModel[str] 时:

  • 实例化 Foo('xxx') 等价于持有并验证该字符串;
  • 序列化时(如 .model_dump() 或 .model_dump_json())直接输出 "xxx",而非 {"root": "xxx"};
  • 在组合模型(如 Bar)中作为字段类型使用时,自动融入父级 JSON 结构,实现扁平化输出。

✅ 正确实现示例:

from pydantic import RootModel, BaseModel

class Foo(RootModel[str]):
    # 可添加验证逻辑,例如:
    def __init__(self, value: str):
        if not isinstance(value, str) or not value.strip():
            raise ValueError("Foo must be a non-empty string")
        super().__init__(value.strip())

class Bar(BaseModel):
    bar: Foo

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

⚠️ 注意事项:

  • RootModel 不支持 .model_fields 或传统字段声明(如 field(default=...)),所有逻辑需通过 __init__、@field_validator(作用于 root 字段)或 @model_validator 实现;

  • 若仅需轻量验证(如非空、正则),更推荐使用 Annotated + AfterValidator(语义更清晰、无运行时开销):

    from pydantic import AfterValidator, BaseModel, Field
    from typing import Annotated
    
    def non_empty_str(v: str) -> str:
        if not v.strip():
            raise ValueError("must be non-empty")
        return v.strip()
    
    class Bar(BaseModel):
        bar: Annotated[str, AfterValidator(non_empty_str)]
  • RootModel 适用于需复用验证逻辑 + 类型别名的场景;而 Annotated 更适合一次性、轻量约束。

总之,RootModel[str] 是实现「验证存在、序列化隐形」的关键机制,合理选用可显著提升 API 响应结构的简洁性与兼容性。

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

热门AI工具

更多
二狗PPT
二狗PPT Hot

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Atoms
Atoms Hot

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

豆包大模型

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

WorkBuddy

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

相关专题

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

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

1871

2023.07.20

python能做什么
python能做什么

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

5064

2023.07.25

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

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

1809

2023.07.31

python教程
python教程

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

30537

2023.08.03

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

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

3627

2023.08.04

python eval
python eval

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

3647

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

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

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

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