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

时间：2020-08-27 13:12:46

标签： python fastapi pydantic

如果在字段中未输入任何内容，是否可以在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'

关于如何获得所需输出的任何想法？我认为拥有吸气剂和吸气剂将有助于解决这个问题。但是，我无法让他们在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

4 个答案:

答案 0 :(得分：5)

您需要在模型配置中启用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

答案 1 :(得分：5)

分配默认值的多种方式

方法 #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

答案 2 :(得分：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 = True pydantic会尝试验证默认的None，这会导致错误。

将Pre设置为 True 会在验证错误发生之前调用该字段，validator 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 ，它将失败。

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

同样，您需要进行设置才能使它工作。

pre=True
always=True

使用default_factory

这在您要设置默认值（例如UUID或日期时间等）的情况下最有用。在这种情况下，您可能要使用 default_factory ，但是有一个很大的问题捕获到您无法为default_factory分配Callable参数。

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)

答案 3 :(得分：0)

请考虑向您的班级添加__init__方法。像

def __init__(self, name, pass, email):
    if pass is None:
        self.password = "foo"
    else:
        self.password = pass
    self.name = name
    self.email = email
相关问题
最新问题