pydantic basemodel“ field”仅出于验证目的

Question

考虑说明使用pydantic basemodel的follwoing代码：

from pydantic import BaseModel, validator

class User(BaseModel, frozen=True):
    id_key: int
    user_id: int

    @validator('user_id')
    def id_check(cls, v, values):
        if v > 2 * values['id_key'] + 1:
            raise ValueError('id check failed.')
        return v

user_dict = {'user_id': 10, 'id_key': 60}
u = User(**user_dict)

现在，在我的应用程序中，我真的不希望id_key是一个u之类的模型实例中的常规，可访问的字段 - 其唯一目的是验证user_id。就我的示例而言，是否有一种方法可以访问id_key用于验证目的，但没有标准字段？

Answer 1

value您在id_check函数中具有的参数是属性的内部dict 已经验证的实例，如果您需要具有id_key仅在实例化时间进行检查，而不是在此之后，您可以简单地从value中删除它。

from pydantic import BaseModel, validator

class User(BaseModel, frozen=True):
    id_key: int
    user_id: int

    @validator('user_id')
    def id_check(cls, v, values):
        if v > 2 * values['id_key'] + 1:
            raise ValueError('id check failed.')
        values.pop('id_key')
        return v

user_dict = {'user_id': 10, 'id_key': 60}
u = User(**user_dict)
print(u)
# output:
# user_id=10

我想为您的代码提出一个其他改进：在当前状态下，pydantic在返回验证错误之前运行所有字段的验证，如果您将某些内容完全无效，则> id_key>例如，例如“ ABC”，或省略它，它不会添加到value，user_id的验证将使用keyError崩溃：'id_key'，吞咽所有验证过程的其余部分，并没有返回明智的消息。

user_dict = {'user_id': 10, 'id_key': 'abc'}
u = User(**user_dict)
# output:
# KeyError: 'id_key'

这不是很明确，如果您期望pydantic vilenationError，可能会导致应用程序问题。您可能需要检查id_key确实存在于value中，并清洁错误（如果不是）。

from pydantic import BaseModel, validator

class User(BaseModel, frozen=True):
    id_key: int
    user_id: int

    @validator('user_id')
    def id_check(cls, v, values):
        if 'id_key' not in values or v > 2 * values['id_key'] + 1:
            raise ValueError('id check failed.')
        values.pop('id_key')
        return v

user_dict = {'user_id': 10, 'id_key': 'abc'}
u = User(**user_dict)
# output:
# pydantic.error_wrappers.ValidationError: 2 validation errors for User
# id_key
#   value is not a valid integer (type=type_error.integer)
# user_id
#   id check failed.(type=value_error)