Pydantic 验证模式中未定义的额外字段

Question

我正在使用 pydantic 进行架构验证，当任何未定义的额外字段添加到架构中时，我想抛出错误。

from typing import Literal, Union

from pydantic import BaseModel, Field, ValidationError


class Cat(BaseModel):
    pet_type: Literal['cat']
    meows: int


class Dog(BaseModel):
    pet_type: Literal['dog']
    barks: float


class Lizard(BaseModel):
    pet_type: Literal['reptile', 'lizard']
    scales: bool


class Model(BaseModel):
    pet: Union[Cat, Dog, Lizard] = Field(..., discriminator='pet_type')
    n: int


print(Model(pet={'pet_type': 'dog', 'barks': 3.14, 'eats': 'biscuit'}, n=1))
""" try:
    Model(pet={'pet_type': 'dog'}, n=1)
except ValidationError as e:
    print(e) """

在上面的代码中，我添加了未定义的 eats 字段。应用 pydantic 验证并删除我定义的额外值作为响应。我想抛出一个错误，指出 eats is not allowed for Dog 或类似的内容。有什么办法可以实现这一点吗？

我们是否有机会直接提供输入而不是 pet 对象？
print(Model({'pet_type': 'dog', 'barks': 3.14, 'eats': 'biscuit', n=1})).我尝试不使用鉴别器，但缺少与pet_type相关的特定验证。有人可以指导我如何实现其中之一吗？

Answer 1

Pydantic v2

您可以使用额外 字段rel="noreferrer">model_config 类属性用于在模型初始化期间禁止额外属性（默认情况下，额外属性将被忽略 ）。

例如：

from pydantic import BaseModel, ConfigDict

class Pet(BaseModel):
    model_config = ConfigDict(extra="forbid")

    name: str

data = {
    "name": "some name",
    "some_extra_field": "some value",
}

my_pet = Pet.model_validate(data)   # <- effectively the same as Pet(**pet_data)

将引发 ValidationError：

ValidationError: 1 validation error for Pet
some_extra_field
  Extra inputs are not permitted [type=extra_forbidden, input_value='some value', input_type=str]
    For further information visit https://errors.pydantic.dev/2.7/v/extra_forbidden

当模型“嵌套”时也有效，例如：

class PetModel(BaseModel):
    my_pet: Pet
    n: int

pet_data = {
    "my_pet": {"name": "Some Name", "invalid_field": "some value"},
    "n": 5,
}

pet_model = PetModel.model_validate(pet_data)
# Effectively the same as
# pet_model = PetModel(my_pet={"name": "Some Name", "invalid_field": "some value"}, n=5)

将引发：

ValidationError: 1 validation error for PetModel
my_pet.invalid_field
  Extra inputs are not permitted [type=extra_forbidden, input_value='some value', input_type=str]
    For further information visit https://errors.pydantic.dev/2.7/v/extra_forbidden

NB： 如您所见，extra 的类型为 ExtraValues现在，并且它的值将由 ConfigDict 进行验证。这意味着不可能意外地为 extra 提供不受支持的值（例如输入错误），即 ConfigDict(extra="fordib") 之类的内容将失败并显示 < a href="https://docs.pydantic.dev/latest/api/pydantic_core/#pydantic_core.SchemaError" rel="noreferrer">SchemaError。

Pydantic v1

您可以使用 extra 字段Config 类在模型初始化期间禁止额外的属性（默认情况下，额外的属性将被忽略）。

例如：

from pydantic import BaseModel, Extra

class Pet(BaseModel):
    name: str

    class Config:
        extra = Extra.forbid

data = {
    "name": "some name",
    "some_extra_field": "some value",
}

my_pet = Pet.parse_obj(data)   # <- effectively the same as Pet(**pet_data)

将引发 VaidationError：

ValidationError: 1 validation error for Pet
some_extra_field
  extra fields not permitted (type=value_error.extra)

当模型“嵌套”时也有效，例如：

class PetModel(BaseModel):
    my_pet: Pet
    n: int

pet_data = {
    "my_pet": {"name": "Some Name", "invalid_field": "some value"},
    "n": 5,
}

pet_model = PetModel.parse_obj(pet_data)
# Effectively the same as
# pet_model = PetModel(my_pet={"name": "Some Name", "invalid_field": "some value"}, n=5)

将引发：

ValidationError: 1 validation error for PetModel
my_pet -> invalid_field
  extra fields not permitted (type=value_error.extra)

Answer 2

首选解决方案是使用 ConfigDict（参考文档):

from pydantic import BaseModel, ConfigDict

class Pet(BaseModel):
    model_config = ConfigDict(extra='forbid')

    name: str

Paul P 的回答 仍然有效（目前），但 Config 类已经在 pydantic v2.0 中已弃用。
另一个已弃用的解决方案是 pydantic.Extra.forbid。

上述方法的优点之一是可以进行类型检查。

Answer 3

Pydantic是为了通过模式来验证您的输入。在您的情况下，您要删除其验证功能之一。

我认为您应该创建一个从 basemodel 继承的新类

class ModifiedBaseModel(BaseModel):
    def __init__(__pydantic_self__, **data: Any) -> None:
        registered, not_registered = __pydantic_self__.filter_data(data)
        super().__init__(**registered)
        for k, v in not_registered.items():
            __pydantic_self__.__dict__[k] = v
    
    @classmethod
    def filter_data(cls, data):
        registered_attr = {}
        not_registered_attr = {}
        annots = cls.__annotations__
        for k, v in data.items():
            if k in annots:
                registered_attr[k] = v
            else:
                not_registered_attr[k] = v
        return registered_attr, not_registered_attr

，然后创建您的验证类

class Cat(ModifiedBaseModel):
    pet_type: Literal['cat']
    meows: int

，现在可以创建一个新的 cat ，而不必担心未定义的属性。像这个

my_cat = Cat(pet_type='cat', meows=3, name='blacky', age=3)

---

第二个问题一样，要直接从 dict 进行输入，您可以使用双星号 **

Dog(**my_dog_data_in_dict)

或

Dog(**{'pet_type': 'dog', 'barks': 3.14, 'eats': 'biscuit', n=1})