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

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 = None
print("Name is ", user.name)
# > 'Name is None'

期望的输出：

user = User(name='some_name', password='some_password', email='[e-mail]')
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='[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: 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='[e-mail]')
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

- Manas Sambare

---

@manas-sombre 你需要使用 @validator(pre=True, always=True) 然后返回一个默认值。我使用了 return v or cls.__name__.lower() 来将小写类名设置为 Optional[str] 字段的默认值。 - rjurney

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

- alex_noname

---

验证器是否应包含任何更改值的逻辑？这听起来像是责任违规。 - Kuchara

Answer 2

这个问题已经被完美地提出，我想提供一个更广泛的例子，因为有许多动态分配值的方法。

Alex的回答是正确的，但它仅在字段直接继承数据类时有效，更具体地说，像这样的内容不起作用。

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=True时有一个重要的限制，因为pydantic会尝试验证默认值None，这将导致错误。

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

使用Config

但这也有一些缺点。

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时，它可以正确地返回动态值，但在一些情况下，比如完全为空的情况下，会失败。

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

再次需要进行设置，以使其正常工作。

pre=True
always=True

使用 default_factory

这在大多数情况下非常有用，比如你想要设置一个默认值，像是 UUID 或者 datetime 等等。在这种情况下，你可能需要使用 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)

- Yagiz Degirmenci

Answer 3

有很多种方法可以分配默认值

方法1：带有默认值的必需id字段

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

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

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

第三种方法：使用默认值的必需 id 字段

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

第四种方法: 必填的id字段，其默认值由可调用函数提供。这在生成按需值时非常有用，例如唯一UUID或时间戳。 请参见@yagiz-degirmenci的答案。

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

- sareno

---

方法4在Python端有效，但在OpenAPI规范中，FastAPI生成后仍将该字段标记为可选的（即使在字段中使用了required布尔值）。 - Schalton