如何在 Pydantic 中为多态成员字段指定具体实现类

浅敏君_4122

浅敏君_4122

2026-11-02

844人浏览

原创

如何在 Pydantic 中为多态成员字段指定具体实现类

Pydantic 默认无法反序列化抽象基类字段,需通过 Union 类型联合 + discriminator 字段显式声明具体子类,才能正确实现多态成员的序列化与反序列化。

pydantic 默认无法反序列化抽象基类字段,需通过 `union` 类型联合 + `discriminator` 字段显式声明具体子类,才能正确实现多态成员的序列化与反序列化。

在构建类型安全的配置模型或领域对象时,常需支持多态结构(例如一个容器类持有一个可变类型的组件)。但 Pydantic 原生不支持直接对抽象基类(ABC)字段进行反序列化——因为 JSON 解析时无法凭空实例化抽象类。解决方案是放弃直接使用抽象类作为字段类型,转而采用显式的联合类型(Union)配合鉴别器(discriminator)字段,让 Pydantic 能根据 JSON 中的标识字段自动选择对应的具体子类。

核心步骤如下:

  1. 为每个具体子类定义统一的鉴别器字段(如 type: Literal["actual"]),该字段值必须唯一且不可变;
  2. 在父类中声明该字段为 str(或 Literal 的超集),确保基类能被继承而不报错;
  3. 字段类型声明使用 Union[ConcreteA, ConcreteB, ...],而非抽象基类;
  4. Pydantic 会自动识别 discriminator 字段并路由到对应子类(无需额外配置,只要字段名一致且值唯一即可)。

以下是完整可运行示例:

from abc import ABC, abstractmethod
from pydantic import BaseModel, TypeAdapter, Field
from typing import Literal, Union


class I_Widget(ABC, BaseModel):
    type: str  # 抽象基类中声明 discriminator 字段(宽松类型)

    @abstractmethod
    def do_stuff(self) -> None:
        ...


class ActualWidget(I_Widget):
    type: Literal["actual"] = "actual"  # 具体子类固定值,作为 discriminator
    value: int

    def do_stuff(self) -> None:
        print("Doing stuff")


class MockWidget(I_Widget):
    type: Literal["mock"] = "mock"
    name: str = "default"

    def do_stuff(self) -> None:
        print("Mocking stuff")


class WidgetHolder(BaseModel):
    widget: Union[ActualWidget, MockWidget]  # ✅ 显式列出所有可能子类


# 使用示例
if __name__ == "__main__":
    # 序列化
    wh1 = WidgetHolder(widget=ActualWidget(value=42))
    json_str = wh1.model_dump_json()
    print("Serialized:", json_str)
    # 输出: {"widget": {"type": "actual", "value": 42}}

    # 反序列化(自动识别 type="actual" → 实例化 ActualWidget)
    wh2 = TypeAdapter(WidgetHolder).validate_json(json_str)
    assert isinstance(wh2.widget, ActualWidget)
    assert wh2.widget.value == 42
    wh2.widget.do_stuff()  # 正确调用子类方法

⚠️ 注意事项:

  • discriminator 字段名必须在所有子类中保持一致(如本例中的 type),且值需为 Literal 类型以保证静态可推导;
  • Union 中必须穷举所有可能的子类,遗漏会导致反序列化失败;
  • 不要继承 ABC 同时又继承 BaseModel(虽语法允许,但易引发元类冲突);推荐将抽象逻辑抽离为纯 ABC,再让 BaseModel 子类实现它(更清晰);
  • Pydantic v2 推荐使用 model_dump_json() 和 model_validate_json() 替代已弃用的 .json() 和 TypeAdapter(...).validate_json()(后者仍可用,但前者语义更明确)。

此方案兼顾类型安全性、运行时正确性与开发者体验,是 Pydantic 处理多态成员的标准实践。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1851

4

python能做什么
python能做什么

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

2023.07.25

5024

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30117

23

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

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

2023.08.04

3587

5

python eval
python eval

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

2023.08.04

3607

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2783

5

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.1万人学习