如何在 Pydantic v2 中为所有嵌套模型统一注入并序列化类名字段

风芳同学_9885

风芳同学_9885

2026-08-16

514人浏览

原创

如何在 Pydantic v2 中为所有嵌套模型统一注入并序列化类名字段

本文介绍使用 @model_serializer(mode='wrap') 在 Pydantic v2 中实现对任意深度嵌套模型自动注入 __name__ 字段的可靠方案,避免手动 exclude 或递归重写 model_dump,确保序列化时类名信息完整、一致且可扩展。

本文介绍使用 `@model_serializer(mode='wrap')` 在 pydantic v2 中实现对任意深度嵌套模型自动注入 `__name__` 字段的可靠方案,避免手动 exclude 或递归重写 `model_dump`,确保序列化时类名信息完整、一致且可扩展。

在 Pydantic v2 中,若希望所有嵌套子模型(无论嵌套多深)在调用 model_dump() 时自动包含其自身类名(如 __name__ 或 class_name),直接依赖 exclude 参数无法递归生效——因为 exclude 仅作用于顶层字段,不会穿透到嵌套模型内部。原问题中尝试通过 exclude={"class_name": True} 期望全局剔除该字段,实际无效;而硬编码修改 model_dump 或滥用 @model_serializer(非 wrap 模式)又易导致无限递归或丢失默认序列化逻辑。

正确解法是采用 @model_serializer(mode='wrap'):它提供一个 handler 函数,用于委托执行 Pydantic 默认的序列化流程,并允许你在其返回结果上安全地添加、修改或过滤字段——且该逻辑会自动递归应用于所有继承该基类的嵌套模型。

以下是推荐实现:

from typing import Any, Dict
from pydantic import BaseModel, SerializerFunctionWrapHandler, SerializationInfo, model_serializer

class NamedBaseModel(BaseModel):
    @model_serializer(mode='wrap')
    def serialize(
        self,
        handler: SerializerFunctionWrapHandler,
        info: SerializationInfo,
    ) -> Dict[str, Any]:
        # 调用默认序列化(自动递归处理所有嵌套模型)
        result = handler(self, info)
        # 注入当前模型类名(可替换为 'class_name' 等任意键名)
        result['__name__'] = self.__class__.__name__
        return result

class FooModel(NamedBaseModel):
    val: int

class BarModel(NamedBaseModel):
    val: str
    foo: FooModel

# 使用示例
obj = BarModel(val='str', foo=FooModel(val=123))
print(obj.model_dump())
# 输出:
# {
#   '__name__': 'BarModel',
#   'val': 'str',
#   'foo': {
#     '__name__': 'FooModel',
#     'val': 123
#   }
# }

✅ 关键优势:

  • 天然递归支持:handler(self, info) 自动触发子模型的 serialize 方法,无需手动遍历或递归调用。
  • 零侵入默认行为:保留所有字段验证、类型转换、别名映射等 Pydantic 原生能力。
  • 灵活定制:可在 result 上执行任意操作(如删除敏感字段、添加上下文元数据、动态改名等)。

⚠️ 注意事项:

  • 不要在此方法内调用 self.model_dump(),否则将引发无限递归(因 model_dump() 内部会再次触发该 serializer)。
  • 若需条件性注入(如仅在特定 mode 或 by_alias=True 时生效),可通过 info.mode 或 info.include/exclude 判断。
  • 如需兼容旧版字段名(如 class_name),只需将 result['__name__'] 替换为 result['class_name'] 即可,语义完全可控。

此方案完美契合“上下文感知序列化”需求:无需每次调用时传参,也不依赖外部状态,所有逻辑封装于基类,一次定义,处处生效。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3744

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21457

23

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

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

2023.08.04

2647

5

python eval
python eval

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

2023.08.04

2707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2083

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习