本文深入探讨了在 Pydantic 中使用 `ForwardRef` 实现延迟引用的问题，并提供了使用判别联合（Discriminated Unions）的推荐方案。通过详细的代码示例和解释，阐述了如何在跨模块场景下管理子类模型，以及如何动态生成联合类型，旨在帮助开发者更有效地利用 Pydantic 构建复杂的数据模型。
在使用 Pydantic 构建复杂的数据模型时，经常会遇到类之间相互引用的情况。如果这些类定义存在依赖关系，例如一个类引用了尚未完全定义的另一个类，就会导致 NameError。Pydantic 提供了 ForwardRef 来解决这个问题，允许延迟对类型的引用。然而，在更复杂的场景下，例如跨模块引用或者存在大量的子类时，直接使用 ForwardRef 可能会变得笨拙。本文将介绍使用判别联合（Discriminated Unions）来更优雅地解决这类问题，并探讨在不同场景下的最佳实践。
判别联合（Discriminated Unions）简介
判别联合是 Pydantic 中一种强大的特性，它允许你定义一个联合类型，并使用一个特定的字段（判别器）来区分联合中的不同类型。这在处理具有共同基类但具有不同属性的子类时非常有用。
示例：宠物模型
考虑一个宠物（Pet）的例子，它有两个子类：狗（Dog）和猫（Cat）。
from pydantic import BaseModel, Field
from typing import Literal, Annotated, Union
class Pet(BaseModel):
"""Animal class"""
name: str
age: int
class Dog(Pet):
"""Dog class"""
type: Literal["dog"] = "dog"
breed: str
class Cat(Pet):
"""Cat class"""
type: Literal["cat"] = "cat"
breed: str
AnyPet = Annotated[Union[Dog, Cat], Field(discriminator="type")]
class Home(BaseModel):
"""Home class"""
pet: AnyPet
data = {
"pet": {
"type": "dog",
"name": "Buddy",
"age": 4,
"breed": "Golden Retriever"
}
}
home = Home(**data)
print(home)在这个例子中，AnyPet 是一个联合类型，它可能是 Dog 或 Cat。Field(discriminator="type") 指明了 type 字段是判别器。当 Pydantic 解析 pet 字段时，它会根据 type 字段的值来确定使用哪个子类。
跨模块场景下的解决方案
当模型分布在多个模块中时，需要考虑模块的导入顺序。一种推荐的做法是将所有有效的子类（例如，所有的宠物类）保存在一个单独的文件或模块中，并将 AnyPet 类型定义放在文件的底部，作为有效子类的注册表。
例如，可以组织成如下的目录结构：
pets/ ├── __init__.py ├── cats.py └── dogs.py
用户只需要导入 AnyPet 类型，就可以访问所有的子类。
动态生成联合类型
如果无法手动维护子类列表，可以考虑动态生成 AnyPet 类型。以下代码展示了如何自动检测给定父类的所有子类，并将它们合并到一个联合中。
from pydantic import BaseModel
from typing import Union, Annotated, Field
class Pet(BaseModel):
name: str
age: int
class Dog(Pet):
type: str = "dog"
breed: str
class Cat(Pet):
type: str = "cat"
breed: str
valid_sub_classes = []
for sub_class in Pet.__subclasses__():
field = sub_class.model_fields.get("type", None)
if field is None:
raise ValueError(f"{sub_class.__name__} is missing a 'type' field")
valid_sub_classes.append(sub_class)
AnyPet = Annotated[Union[tuple(valid_sub_classes)], Field(discriminator="type")]
print(AnyPet)这段代码首先遍历 Pet 类的所有子类，检查每个子类是否定义了 type 字段（作为判别器）。然后，它将所有有效的子类添加到 valid_sub_classes 列表中，并使用该列表动态生成 AnyPet 类型。
延迟执行的方案
如果模型分布在多个子模块中，并且无法解决导入顺序问题，可以考虑定义一个函数来延迟执行上述动态生成联合类型的代码。
from pydantic import BaseModel
from typing import Union, Annotated, Field
# my_module.py
def get_any_pet():
from .dog import Dog
from .cat import Cat
return Annotated[Union[Dog, Cat], Field(discriminator="type")]
# main.py
from pydantic import BaseModel
from my_module import get_any_pet
AnyPet = get_any_pet()
class Home(BaseModel):
pet: AnyPet在这个例子中，get_any_pet 函数在被调用时才会导入 Dog 和 Cat 类，从而避免了导入循环的问题。
总结
使用判别联合是解决 Pydantic 中延迟引用问题的一种优雅而强大的方法。通过合理地组织代码结构、动态生成联合类型或使用延迟执行，可以有效地管理复杂的模型依赖关系，并构建更健壮的应用程序。在实际应用中，应根据具体的场景选择最合适的解决方案。
