Блог

Могу ли я создать значение по умолчанию в 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:

Попытка реализовать методы получения и установки:

 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"
  

Я также попытался перезаписать инициализацию:

 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
  

Вам нужно включить 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
  

Этот вопрос задан идеально, поэтому я хотел привести более широкий пример, потому что существует много способов динамического присвоения значения.

Ответ Алекса правильный, но он работает только тогда, когда поле напрямую наследует класс данных, более конкретно, что-то подобное не сработает.

 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 или 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)
  

Много способов присвоить значение по умолчанию

Метод #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 поле со значением по умолчанию из вызываемого. Это полезно для генерации значений по требованию, таких как unique UUIDs или Timestamps .
Смотрите ответ @yagiz-degirmenci.

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