如果没有传递默认值，如何将默认值传递给变量？

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='[e-mail]')print("Name is ", user.name)# > 'Name is foo'user.name = Noneprint("Name is ", user.name)# > 'Name is None'期望的输出：user = User(name='some_name', password='some_password', email='[e-mail]')user.name = Noneprint("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='[e-mail]')# > 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='[e-mail]')user.password = 'some_password'# > ValueError: "User" object has no field "password"我还尝试覆盖init：class User(BaseModel):name: Optional[str] = ""password: Optional[str] = ""email: EmailStrdef __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)

Answer 1

您需要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 2

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

它仅在字段直接继承数据类时才有效，更具体地说，这样的东西是行不通的。

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 时，它会正确返回动态值，但在某些情况下，例如完全返回动态值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 3

分配默认值的多种方法

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

class User(BaseModel):

    id: str = uuid.uuid4()

方法#2id具有默认值的可选字段

class User(BaseModel):

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

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

class User(BaseModel):

    id: str = Field(default=uuid.uuid4())

方法#4：具有可id调用默认值的必填字段。这对于生成按需值（例如unique UUIDs或 ）非常有用Timestamps。 

class User(BaseModel):

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