如何在 Pydantic 中正确序列化继承自基类的嵌套子类模型

夏瑶同学_5513

夏瑶同学_5513

2026-07-10

331人浏览

原创

如何在 Pydantic 中正确序列化继承自基类的嵌套子类模型

本文详解如何让 Pydantic 在泛型约束下支持任意 Action 子类作为嵌套字段,并完整保留子类字段进行序列化(如 model_dump()),避免仅导出基类字段的常见陷阱。

本文详解如何让 pydantic 在泛型约束下支持任意 `action` 子类作为嵌套字段,并完整保留子类字段进行序列化(如 `model_dump()`),避免仅导出基类字段的常见陷阱。

在 Pydantic 中,若将嵌套字段声明为基类类型(如 action: Action),即使传入子类实例(如 LogAction),默认序列化行为(model_dump() / model_json())也只会输出基类定义的字段——子类特有属性(如 log_level、timestamp)会被静默忽略。这是因为 Pydantic 的类型注解在运行时未携带具体子类信息,模型校验与序列化均按声明类型(Action)执行。

解决该问题的核心思路是:利用 Python 泛型 + TypeVar 限定类型边界(bound),使字段类型动态适配实际传入的子类,而非固定为基类。这样既保持类型安全,又确保序列化时完整保留子类字段。

阿里云百炼
阿里云百炼

阿里云百炼是一款AI大模型工具,一站式大模型开发与应用构建平台。

下载

✅ 正确实现方式:泛型模型 + 类型变量约束

from typing import Generic, TypeVar
from pydantic import BaseModel

class Action(BaseModel):
    name: str

class LogAction(Action):
    log_level: str
    timestamp: str

class AnotherAction(Action):
    something: str

# 定义可接受任意 Action 子类的类型变量
T = TypeVar("T", bound=Action)

class Alert(BaseModel, Generic[T]):
    id: int
    message: str
    action: T  # 类型随实例化时传入的具体子类动态确定

✅ 实例化与序列化效果验证

# 使用 LogAction 实例 → action 字段完整包含 name, log_level, timestamp
alert1 = Alert(
    id=1,
    message="Alert Message",
    action=LogAction(name="Error Log", log_level="ERROR", timestamp="2024-04-20T10:45:00")
)
print(alert1.model_dump())
# 输出:{'id': 1, 'message': 'Alert Message', 'action': {'name': 'Error Log', 'log_level': 'ERROR', 'timestamp': '2024-04-20T10:45:00'}}

# 使用 AnotherAction 实例 → 自动包含其特有字段 `something`
alert2 = Alert(
    id=2,
    message="Another Alert",
    action=AnotherAction(name="Custom Action", something="123")
)
print(alert2.model_dump())
# 输出:{'id': 2, 'message': 'Another Alert', 'action': {'name': 'Custom Action', 'something': '123'}}

⚠️ 注意事项与限制

  • JSON Schema 兼容性:泛型模型生成的 OpenAPI Schema 中,action 字段仍显示为 Action(因 Schema 不支持运行时泛型推导),但运行时序列化完全正确。若需精确 Schema,需配合 Field(..., discriminator='type') + Union(Pydantic v2.4+ 支持 TaggedUnion),但会牺牲“任意子类”的灵活性。
  • 类型检查友好:IDE 和 mypy 能正确识别 alert1.action.log_level 等子类属性,提供完整补全与静态检查。
  • 校验安全性:传入非 Action 子类的实例(如独立定义的 AnotherAction2)会在初始化时触发 ValidationError,保障类型安全。

✅ 总结

通过 Generic[T] 与 TypeVar(bound=BaseModel) 组合,Pydantic 可实现“基类声明、子类实例化、全字段序列化”的优雅解法。该方案无需硬编码 Union[Action, LogAction, ...],具备良好的扩展性与类型严谨性,是处理多态嵌套模型的推荐实践。

相关文章

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

3704

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

21277

23

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

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

2023.08.04

2627

5

python eval
python eval

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

2023.08.04

2687

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

2063

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程