如何在 Pydantic V2 中递归地自定义模型序列化行为

风杰同学_8493

风杰同学_8493

2026-08-10

144人浏览

原创

如何在 Pydantic V2 中递归地自定义模型序列化行为

Pydantic V2 不再支持重写 dict() 方法实现递归序列化增强,但可通过 @computed_field 结合 model_dump() 实现等效效果,使嵌套模型自动携带类名等元信息。

pydantic v2 不再支持重写 `dict()` 方法实现递归序列化增强,但可通过 `@computed_field` 结合 `model_dump()` 实现等效效果,使嵌套模型自动携带类名等元信息。

在 Pydantic V1 中,开发者常通过重写 BaseModel.dict() 方法,在序列化时动态注入元数据(如 __name__),且因 dict() 会递归调用子模型的同名方法,该行为天然支持嵌套结构。然而,V2 彻底移除了 dict()/json() 等旧接口,统一使用 model_dump() 和 model_dump_json(),且其内部不再触发用户自定义的 dict() 方法——这意味着直接继承并覆写已失效。

所幸,Pydantic V2 提供了更声明式、更安全的替代方案:@computed_field。它允许你将任意属性声明为运行时计算的字段,并可指定 alias 控制序列化键名。关键在于:该字段会被 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))

输出结果为:

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

✅ 优势说明:

  • @computed_field 是声明式设计,语义清晰,与 Pydantic 的验证和序列化机制深度集成;
  • by_alias=True 确保 alias(如 "__name__")被实际使用;
  • 所有嵌套模型(如 foo: Foo)只要继承 BaseModel2,就会自动包含 __name__ 字段,实现真正递归生效。

⚠️ 注意事项:

  • 不要尝试在 V2 中复用 V1 的 dict() 覆写方式——它不会被 model_dump() 调用,属于无效代码;
  • 若需更复杂逻辑(如动态添加字段、条件序列化),可结合 model_serializer 装饰器定制整个模型的序列化流程;
  • @computed_field 默认不参与验证,仅用于序列化输出;若需校验其值,应配合 field_validator 或在 @property 内部手动抛出异常。

总之,@computed_field + model_dump(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

4224

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24597

23

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

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

2023.08.04

3007

5

python eval
python eval

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

2023.08.04

3027

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

2343

5

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习