Pydantic：如果传递了 None，如何将默认值传递给变量？

Question

如果在字段中传递 None，我可以在 Pydantic 中设置默认值吗？

我有以下代码，但在我看来，这里的验证器仅适用于模型的初始化，而不适用于其他地方。

我的代码：

class User(BaseModel):
     name: Optional[str] = ''
     password: Optional[str] = ''
     email: EmailStr
    

    @validator('name')
    def set_name(cls, name):
        return name or 'foo'

遇到的问题：

user = User(name=None, password='some_password', email='user@example.com')
print("Name is ", user.name)
# > 'Name is foo'

user.name = None
print("Name is ", user.name)
# > 'Name is None'

期望输出：

user = User(name='some_name', password='some_password', email='user@example.com')
user.name = None
print("Name is ", user.name)
# > 'Name is foo'

关于如何获得所需输出的任何想法？我认为拥有 getter 和 setter 将有助于解决这个问题。但是，我无法让他们在 Pydantic 模型中工作：

正在尝试实现 getter 和 setter：

class User(BaseModel):
    name: Optional[str] = ''
    password: Optional[str] = ''
    email: EmailStr

    def get_password(self):
        return self.password

    def set_password(self, password):
        self.password = hash_password(password)

    password = property(get_password, set_password)

user = User(name='some_name', password='some_password', email='user@example.com')
# > RecursionError: maximum recursion depth exceeded

我也尝试了属性装饰器：

class User(BaseModel):
     name: Optional[str] = ''
     password: Optional[str] = ''
     email: EmailStr

    @property
    def password(self):
        return self._password

    @password.setter
    def password(self, password):
        pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
        self._password = pwd_context.hash(password)

user = User(name='some_name', email='user@example.com')
user.password = 'some_password'
# > ValueError: "User" object has no field "password"

我也试过覆盖 init:

class User(BaseModel):
name: Optional[str] = ""
password: Optional[str] = ""
email: EmailStr

def __init__(self, name, password, email):
    pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
    password = pwd_context.hash(password)
    super().__init__(name=name, password=password, email=email)


user = User(name="some_name", password="some_password", email='user@example.com')
print(user.password)
# > AYylwSnbQgCHrl4uue6kO7yiuT20lazSzK7x # Works as expected

user.password = "some_other_password"
print(user.password)
# > "some_other_password" # Does not work

user.password = None
print(user.password)
# > None # Does not work either

Answer 1

考虑将 __init__ 方法添加到您的 class。像

def __init__(self, name, pass, email):
    if pass is None:
        self.password = "foo"
    else:
        self.password = pass
    self.name = name
    self.email = email

Answer 2

您需要在模型配置中启用 validate_assignment 选项：

from typing import Optional

from pydantic import BaseModel, validator


class User(BaseModel):
    name: Optional[str] = ''
    password: Optional[str] = ''

    class Config:
        validate_assignment = True

    @validator('name')
    def set_name(cls, name):
        return name or 'foo'


user = User(name=None, password='some_password', )
print("Name is ", user.name)


user.name = None
print("Name is ", user.name)

Name is  foo
Name is  foo

Answer 3

这个问题问得很好所以我想提供一个更广泛的例子，因为有很多方法可以动态赋值。

Alex 的回答是正确的，但它仅在 Field 直接继承数据类时有效，更具体地说，像这样的方法是行不通的。

class User(BaseModel):
    name: Optional[str] = ""
    password: Optional[str] = ""

    class Config:
        validate_assignment = True

    @validator("name")
    def set_name(cls, name):
        return name or "bar"


user_dict = {"password": "so_secret"}
user_one = User(**user_dict)
Out: name='' password='so_secret'

始终验证

出于性能原因，默认情况下，当未提供值时，不会为字段调用验证器。但是当您需要设置 动态默认值 时，我们可以将其设置为 True

class User(BaseModel):
    name: Optional[str] = ""

    @validator("name", pre=True, always=True)
    def set_name(cls, name):
        return name or "bar"

In: user_one = User(name=None)
In: user_two = User()
Out: name='bar'
Out: name='bar'

但是 always 有一个重要的问题，因为我们使用的是 always=True pydantic 会尝试验证默认值 None，这会导致错误。

将 Pre 设置为 True 它将在验证错误发生之前调用该字段，验证器 pre 的默认设置为 False ，在这种情况下，它们在字段验证后被调用。

使用配置

但这有一些缺点。

class User(BaseModel):
    name: Optional[str] = ""

    class Config:
        validate_assignment = True

    @validator("name")
    def set_name(cls, name):
        return name or "foo"

In:  user = User(name=None)
Out: name='foo'

当您将它设置为 None 时，它 returns 动态值是正确的，但在某些情况下它完全是 None，它会失败.

In:  user = User()
Out: name=''

您需要再次设置，才能正常工作。

pre=True
always=True

使用`default_factory`

这在您想设置默认值（如 UUID 或日期时间等）的情况下非常有用。在这种情况下，您可能想使用 default_factory，但是有一个很大的问题，你不能将 Callable 参数分配给 default_factory.

class User(BaseModel):
    created_at: datetime = Field(default_factory=datetime.now)

In: user = User()
Out: created_at=datetime.datetime(2020, 8, 29, 2, 40, 12, 780986)

Answer 4

多种分配默认值的方法

方法 #1：具有默认值的必填 id 字段

class User(BaseModel):
    id: str = uuid.uuid4()

方法 #2 一个可选的 id 字段，默认值

class User(BaseModel):
    id: Optional[str] = uuid.uuid4()

方法 #3：具有默认值的必填 id 字段

class User(BaseModel):
    id: str = Field(default=uuid.uuid4())

方法 #4：必填 id 字段，默认值为 callable。这对于生成 unique UUIDs 或 Timestamps. 等按需值很有用请参阅@yagiz-degirmenci 回答。

class User(BaseModel):
    id: str = Field(default_factory=uuid.uuid4)  # uuid.uuid4 is not executed immediately

Pydantic：如果传递了 None，如何将默认值传递给变量？

Pydantic: How to pass the default value to a variable if None was passed?

python

fastapi

pydantic

始终验证

使用配置

使用`default_factory`

Pydantic：如果传递了 None，如何将默认值传递给变量？

Pydantic: How to pass the default value to a variable if None was passed?

python

fastapi

pydantic

始终验证

使用配置

使用default_factory

使用`default_factory`