Pydantic 模型继承中列表字段类型不兼容问题的解决方案-Python教程-PHP中文网

Pydantic 模型继承中列表字段类型不兼容问题的解决方案

Pydantic 模型继承时，若父类字段为 list[Parent]，子类尝试覆写为 list[Child]（Child 继承自 Parent），mypy 会报类型不兼容错误；根本原因是 list 在类型系统中为不变（invariant），应改用协变（covariant）的 Sequence 或 tuple 等类型。

pydantic 模型继承时，若父类字段为 `list[parent]`，子类尝试覆写为 `list[child]`（child 继承自 parent），mypy 会报类型不兼容错误；根本原因是 `list` 在类型系统中为**不变（invariant）**，应改用协变（covariant）的 `sequence` 或 `tuple` 等类型。

在 Python 类型系统中，容器类型的变性（variance） 决定了子类型关系能否传递到泛型参数上。list[T] 是不变的（invariant）：即使 Child 是 Parent 的子类，list[Child] 也不被视为 list[Parent] 的子类型——因为 list 支持读写操作（如 append() 和 __getitem__），若允许协变将破坏类型安全（例如向 list[Child] 中插入 Parent 实例会导致运行时错误）。

而 typing.Sequence[T] 是协变的（covariant），仅支持只读操作（如索引、迭代、长度查询），因此 Sequence[Child] 可安全地作为 Sequence[Parent] 使用，符合 Liskov 替换原则。

✅ 正确做法：将父类字段类型从 list[Name] 改为 Sequence[Name]，子类即可安全覆写为 Sequence[EnglishName]：

from pydantic import BaseModel
from typing import Sequence

class Name(BaseModel):
    data: str

class EnglishName(Name):
    pass  # 无需重复定义 data，继承即可

class Animal(BaseModel):
    name: Sequence[Name]  # 使用协变类型 Sequence，而非 list

class AmericaAnimal(Animal):
    name: Sequence[EnglishName]  # ✅ mypy 通过，类型兼容

⚠️ 注意事项：

Sequence 是抽象基类（ABC），运行时可接受 list、tuple、deque 等任意序列类型，但不支持 .append() 等原地修改方法；若业务逻辑需修改列表，应在模型内部或外部处理，而非依赖字段的可变性。

若必须使用可变列表且需类型安全，可考虑在子类中不覆写字段类型，而是在模型验证逻辑中约束元素类型（例如通过 @field_validator）：

from pydantic import field_validator

class AmericaAnimal(Animal):
    @field_validator('name')
    def validate_english_names(cls, v):
        for item in v:
            if not isinstance(item, EnglishName):
                raise ValueError("All names must be EnglishName instances")
        return v