Pydantic 1.10.12派生类添加字段报错：ValueError无_myVar字段

问题原因 #

Pydantic 1.10.12版本会严格校验模型实例的属性赋值，所有未通过模型字段声明的属性（包括私有属性）都会被判定为非法字段，触发ValueError。而Pydantic 2.x+版本调整了校验逻辑，允许直接设置私有属性，因此不会出现这个问题。

解决方案 #

方案1：用PrivateAttr声明私有属性（推荐）

通过pydantic.PrivateAttr标记私有属性，告诉Pydantic这是模型的私有属性，不属于模型字段，无需校验。修改代码如下：

from pydantic import BaseModel, PrivateAttr


class Base():
    pass


class Derived(Base, BaseModel):
    # 用PrivateAttr声明私有属性，可设置默认值
    _myVar = PrivateAttr(default=True)

    def __init__(self, **data):
        super().__init__(**data)
        print("Derived.__init__() called")
        # 这里可根据需要修改属性值，不会触发报错
        # self._myVar = True

    @property
    def myVar(self):
        return self._myVar

    @myVar.setter
    def myVar(self, value):
        self._myVar = value


class SubDerived(Derived):
    pass


if __name__ == "__main__":
    v = SubDerived()
    print(v.myVar)  # 输出: True
    v.myVar = False
    print(v.myVar)  # 输出: False

方案2：关闭额外字段校验（不推荐）

在模型的配置类中设置extra = 'allow'，允许模型接受未声明的字段。但这种方法会放宽所有字段的校验规则，可能引入其他问题，仅作为临时 workaround：

from pydantic import BaseModel


class Base():
    pass


class Derived(Base, BaseModel):
    class Config:
        extra = 'allow'

    def __init__(self, **data):
        super().__init__(**data)
        print("Derived.__init__() called")
        self._myVar = True

    @property
    def myVar(self):
        return self._myVar

    @myVar.setter
    def myVar(self, value):
        self._myVar = value


class SubDerived(Derived):
    pass


if __name__ == "__main__":
    v = SubDerived()
    print(v.myVar)  # 输出: True

说明 #

方案1是Pydantic 1.x中处理私有属性的标准方式，既能避免校验错误，又能保持模型字段的严格性。方案2仅适合临时应急，不建议在生产环境使用。

内容的提问来源于stack exchange，提问作者Richard Anthony Hein