python - pydantic 模型验证器内部字段分配的验证

Question

我遵循定义的 pydantic 模型。当我运行 p = IntOrStr(value=True) 时，我预计会失败，因为 True 是 bool 值，它应该会导致对 __int 和 __str

class IntOrStr(BaseModel):
    __int: Optional[conint(strict=True, le=100, ge=10)] = None
    __str: Optional[constr(strict=True, max_length=64, min_length=10)] = None
    value: Any

    @validator("value")
    def value_must_be_int_or_str(cls, v):
        try:
            __int = v # no validation. not sure why?
            return v
        except ValidationError as e:
            print(str(e))

        try:
            __str = v # no validation. not sure why?
            return v
        except ValidationError as e:
            print(str(e))

        raise ValueError("error. value must be int or str")

    class Config:
        validate_assignment = True

有谁知道为什么 __int = v 和 __str = v 不触发任何验证？

谢谢。

Answer 1

这里有不少问题。

命名空间

这与 Pydantic 无关；这只是对 Python namespace 工作原理的误解:

在方法的命名空间中，__int和__str只是局部变量。您所做的只是简单地创建这些变量并为它们赋值，然后在不对它们做任何事情的情况下丢弃它们。

它们与您的模型的字段/属性完全无关。

如果要为类属性赋值，则必须执行以下操作:

class Foo:
    x: int = 0
    @classmethod
    def method(cls) -> None:
        cls.x = 42

但这不是您想要的，因为...

类与实例

验证器是一个类方法。尽管 @classmethod 装饰器可以用 @validator 省略，但第一个参数被命名为 cls 就暗示了这一点。

因此，无论validate_assignment如何，您都永远无法分配一个值给验证器内的模型instance的任何字段配置。验证器只是处理提供给实例的值。它返回的内容可能然后最终被分配给实例，如果没有其他验证器妨碍的话。

如果您希望传递给一个字段的值影响最终分配给其他 字段的值，您应该改用 @root_validator .

验证器优先级

您需要考虑调用验证器的顺序。该顺序由定义字段的顺序决定。 (参见 docs)

默认情况下，根验证器在字段验证器之后被调用。因此，如果您希望根验证器所做的更改影响字段验证，则需要对其使用 pre=True。

下划线

Pydantic 不会将名称以下划线开头的属性视为字段，这意味着它们不受验证。如果您需要以下划线开头的字段名称，则必须使用 alias。 .

工作示例

总而言之，我想您可能需要更多类似以下内容的内容:

from typing import Any, Optional
from pydantic import BaseModel, Field, ValidationError, conint, constr, root_validator


class IntOrStr(BaseModel):
    a: Optional[
        conint(strict=True, le=100, ge=10)
    ] = Field(default=None, alias="__a")
    b: Optional[
        constr(strict=True, max_length=64, min_length=10)
    ] = Field(default=None, alias="__b")
    value: Any

    @root_validator(pre=True)
    def value_to_a_and_b(cls, values: dict[str, Any]) -> dict[str, Any]:
        value = values.get("value")
        values["__a"] = value
        values["__b"] = value
        return values


if __name__ == "__main__":
    try:
        IntOrStr(value=True)
    except ValidationError as e:
        print(e)

输出:

2 validation errors for IntOrStr
__a
  value is not a valid integer (type=type_error.integer)
__b
  str type expected (type=type_error.str)

请注意，在此设置中，错误实际上由conint 和constr 类型的个人 默认字段验证器拾取。

此外，在这个简单的示例中，您将无法手动设置 __a 或 __b，因为这些值将始终在根验证器中被覆盖。但由于我不知道你的实际意图，我只是像这样设置它来触发你想要的验证错误。

希望这对您有所帮助。