如何在 Pydantic V2 中实现模型的递归序列化增强

风杰同学_8493

风杰同学_8493

2026-08-10

913人浏览

原创

如何在 Pydantic V2 中实现模型的递归序列化增强

Pydantic V2 不再支持直接重写 dict() 方法,但可通过 @computed_field 结合 model_dump() 实现等效的递归序列化增强,自动为所有嵌套模型实例注入元信息(如类名)。

pydantic v2 不再支持直接重写 `dict()` 方法,但可通过 `@computed_field` 结合 `model_dump()` 实现等效的递归序列化增强,自动为所有嵌套模型实例注入元信息(如类名)。

在 Pydantic V1 中,开发者常通过重载 BaseModel.dict() 方法实现序列化逻辑的全局增强(例如自动添加 __name__ 字段),且该逻辑会自然递归作用于嵌套子模型。但在 V2 中,dict() 已被弃用,统一由 model_dump() 取代,且其底层不再调用模型实例的方法——这意味着单纯重写 model_dump() 或自定义方法无法自动递归生效。

不过,V2 提供了更规范、更安全的替代方案:使用 @computed_field 定义只读计算字段,并配合 by_alias=True 参数,即可在序列化结果中稳定注入元数据,且该字段会随 model_dump() 递归遍历自动包含在所有层级的嵌套模型中。

以下是一个完整示例:

from typing import Optional
from pydantic import BaseModel, computed_field


class BaseModel2(BaseModel):
    @computed_field(alias="__name__")
    @property
    def name(self) -> str:
        return self.__class__.__name__


class Foo(BaseModel2):
    whatever: int


class Bar(BaseModel2):
    whenever: Optional[float] = 1.1
    foo: Foo


m = Bar(whenever=3.14, foo=Foo(whatever=123))
print(m.model_dump(by_alias=True))

输出结果为:

{
  "whenever": 3.14,
  "foo": {
    "whatever": 123,
    "__name__": "Foo"
  },
  "__name__": "Bar"
}

✅ 关键要点说明:

  • @computed_field(alias="__name__") 确保字段在序列化时以 __name__ 键名出现;
  • @property 保证字段惰性计算、无副作用,符合 Pydantic 的序列化语义;
  • model_dump(by_alias=True) 是必需的,否则 alias 不生效;
  • 因 model_dump() 默认递归处理嵌套 BaseModel 实例,父类中定义的 computed_field 会自动应用于所有子模型(如 Foo 和 Bar),实现真正意义上的“递归增强”。

⚠️ 注意事项:

  • 不要尝试重写 model_dump() —— 它是高度优化的 C 层封装,手动覆盖易破坏验证、排除逻辑(如 exclude/include)及性能;
  • 若需条件性注入(如仅开发环境),可在 @property 中加入 os.getenv() 或配置判断,但应避免 I/O 或复杂计算;
  • computed_field 在 model_validate() 或 model_construct() 时不会被反向解析,因此该字段纯属序列化增强,不影响反序列化行为。

综上,computed_field + by_alias=True 是 Pydantic V2 中实现可递归、可继承、可维护的序列化增强的最佳实践。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4204

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24457

23

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

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

2023.08.04

2987

5

python eval
python eval

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

2023.08.04

3007

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2323

5

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习