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

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

老宇大大_6664

老宇大大_6664

发布时间:2026-09-09 21:20:21

|

745人浏览过

|

来源于php中文网

原创

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

通过继承 RootModel[str] 构建轻量验证模型,可在保留字段校验能力的同时避免序列化时的多余嵌套层级,实现如 {"bar": "xxx"} 的扁平 JSON 输出。

通过继承 `rootmodel[str]` 构建轻量验证模型,可在保留字段校验能力的同时避免序列化时的多余嵌套层级,实现如 {"bar": "xxx"} 的扁平 json 输出。

在 Pydantic v2 中,若希望某个字段(如 bar)既接受定制化验证逻辑(例如非空字符串、长度限制、正则匹配等),又不引入额外的 JSON 层级(即不序列化为 {"bar": {"root": "xxx"}}),标准的 BaseModel 子类无法满足需求——因为它总会将字段值包装为对象结构。

此时,RootModel 是专为此类场景设计的核心工具。它表示“整个模型即一个值”,其根字段(root)直接对应序列化后的顶层数据,而非嵌套对象。

✅ 正确做法:使用 RootModel 作为验证载体
以下是一个完整示例:

from pydantic import RootModel, BaseModel, ValidationError

class Foo(RootModel[str]):
    # 可添加自定义验证逻辑(如约束长度或格式)
    def __init__(self, value: str):
        if not isinstance(value, str) or len(value.strip()) == 0:
            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 不支持 Field(...)model_config 中的大多数 BaseModel 特性(如 alias, validation_alias 等),其核心语义是「单值容器」;
  • 若需更复杂的校验(如正则、最小长度),推荐搭配 AnnotatedAfterValidator 使用,语义更清晰且可复用:
from typing import Annotated
from pydantic import AfterValidator, BaseModel

def non_empty_str(v: str) -> str:
    if not v or not v.strip():
        raise ValueError("Must be a non-empty string")
    return v.strip()

class Bar(BaseModel):
    bar: Annotated[str, AfterValidator(non_empty_str)]

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

? 总结:
当目标是「强校验 + 零嵌套序列化」时,优先考虑 RootModel[T];若仅需简单类型约束,Annotated[T, ...] 更简洁、灵活,也更符合 Pydantic v2 的推荐实践。二者均能规避 BaseModel 带来的冗余嵌套,确保 API 输出干净、符合前端或下游服务预期。

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

热门AI工具

更多
Atoms
Atoms Hot

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

DeepSeek

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

讯飞智作

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

音述AI
音述AI Hot

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

讯飞绘文

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

豆包大模型

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

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

相关专题

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

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

1551

2023.07.20

python能做什么
python能做什么

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

3664

2023.07.25

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

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

1569

2023.07.31

python教程
python教程

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

20917

2023.08.03

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

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

2587

2023.08.04

python eval
python eval

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

2647

2023.08.04

scratch和python区别
scratch和python区别

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

1063

2023.08.11

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

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

576

2023.08.10

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

0

2026.09.21

热门下载

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

精品课程

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

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