如何在 Pydantic 中实现支持任意子类的嵌套模型序列化

星萱小哥_6732

星萱小哥_6732

2026-07-11

523人浏览

原创

如何在 Pydantic 中实现支持任意子类的嵌套模型序列化

本文介绍如何通过泛型(Generic)与类型变量(TypeVar)约束,使 Pydantic 模型能正确接收并完整序列化 BaseModel 子类实例(如 LogAction),突破 Union 手动枚举的局限,实现灵活、类型安全的继承式嵌套建模。

本文介绍如何通过泛型(generic)与类型变量(typevar)约束,使 pydantic 模型能正确接收并完整序列化 `basemodel` 子类实例(如 `logaction`),突破 `union` 手动枚举的局限,实现灵活、类型安全的继承式嵌套建模。

在 Pydantic 中,若希望父类字段(如 action: Action)能接受任意继承自 Action 的子类(如 LogAction、AlertAction 等),并在 .model_dump() 或 JSON 序列化时保留子类全部字段,直接使用基类注解(action: Action)会导致子类特有字段被忽略——这是因 Pydantic 默认按声明类型(即 Action)进行序列化,仅导出基类定义的字段。

解决方案是引入 泛型 + 有界类型变量(TypeVar with bound=Action),将嵌套字段声明为类型参数 T,从而让模型在实例化时“记住”实际传入的子类类型,并据此执行完整序列化。

✅ 正确实现方式(Pydantic v2+)

from typing import Generic, TypeVar
from pydantic import BaseModel

class Action(BaseModel):
    name: str

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

class Alert(BaseModel, Generic[T]):
    id: int
    message: str
    action: T

# 使用时指定具体子类类型(类型推断自动生效)
alert1 = Alert(
    id=1,
    message="Alert Message",
    action=LogAction(name="Error Log", log_level="ERROR", timestamp="2024-04-20T10:45:00"),
)

print(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'}}

✅ 优势:

NeoAgent
NeoAgent

一款AI办公效率工具,主要用于销售易推出的AI‑CRM智能体平台,适合需要提升相关任务效率的用户。

下载
  • 类型安全:T = TypeVar("T", bound=Action) 确保 action 只能是 Action 或其子类;传入非继承类(如独立 BaseModel)会触发 ValidationError;
  • 完整序列化:.model_dump() 自动包含子类所有字段(log_level, timestamp),无需手动 Union 枚举;
  • 多态友好:同一 Alert 模型可复用于不同子类实例(LogAction、AnotherAction 等)。

⚠️ 注意事项:

  • JSON Schema 局限性:生成的 OpenAPI schema 中,action 字段仍显示为 Action(而非具体子类),因 schema 是静态结构,无法反映运行时泛型实参。若需精确 schema,需配合 Field(..., discriminator='type') 实现联合类型(discriminator-based union),但会牺牲泛型的简洁性;
  • 必须显式继承 BaseModel:子类(如 LogAction)须直接或间接继承 Action(即 BaseModel),否则类型检查失败;
  • 避免裸 BaseModel 子类:AnotherAction2 若未继承 Action,实例化 Alert[AnotherAction2] 会因类型约束失败,在开发阶段即可捕获错误。

总结

泛型方案是 Pydantic 中处理“基类字段需接纳任意子类并完整序列化”的推荐实践。它兼顾类型安全性、序列化完整性与代码可维护性,尤其适用于插件化、策略模式或事件驱动架构中需要扩展动作类型(Action)的场景。对于强 schema 需求,可结合 Union + discriminator 作为补充方案,但日常开发中,泛型已足够优雅高效。

相关文章

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

4144

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

23957

23

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

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

2023.08.04

2927

5

python eval
python eval

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

2023.08.04

2967

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2303

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
极客学院Python视频教程
极客学院Python视频教程

共67课时 | 25.8万人学习