Валидация

Настройка

Валидацией полей можно управлять как на уровне всего класса, так и отдельно для каждого поля.

from cwtch import dataclass

@dataclass(validate=False)
class M:
    i: int

>>> print(M(i="a")
M(i="a")

from cwtch import dataclass, field

@dataclass
class M:
    i: int = field(validate=False)
    s: str

>>> M(i="a", s=1)
M(i="a", s="1")

Валидация булевых типов

Значения трактуются согласно карте:

BOOL_MAP = {
    True: True,
    1: True,
    "1": True,
    "t": True,
    "true": True,
    "True": True,
    "TRUE": True,
    "y": True,
    "Y": True,
    "yes": True,
    "Yes": True,
    "YES": True,
    False: False,
    0: False,
    "0": False,
    "f": False,
    "false": False,
    "False": False,
    "FALSE": False,
    "n": False,
    "N": False,
    "no": False,
    "No": False,
    "NO": False
}

Пост валидация

Для валидации модели после создания можно использовать __post_validate__ метод.

Note

cwtch перхватывает ValueError и TypeError исключения и оборачивает их в ValidationError.

from cwtch import dataclass

@dataclass
class M:
    i: int
    j: int

    def __post_validate__(self):
        if self.i + self.j < 10:
            raise ValueError("sum of i and j should be >= 10")

Валидация на основе метадаты

Для валидации поля перед или после cwtch можно использовать валидаторы на основе cwtch.metadata.ValidatorBefore и cwtch.metadta.ValidatorAfter.

from typing import Annotated

from cwtch import dataclass
from cwtch.metadata import ValidatorAfter, ValidatorBefore

class CustomValidatorBefore(ValidatorBefore):
    def before(self, value, /):
        """
        Валидация значения перед валидацией на основании аннотации типа
        """
        print("Before")
        return value

class CustomValidatorAfter(ValidatorAfter):
    def after(self, value, /):
        """
        Валидация значения после валидации на основании аннотации типа
        """
        print("After")
        return value

@dataclass
class M:
    i: Annotated[int, CustomValidatorBefore()]
    j: Annotated[int, CustomValidatorAfter()]

Встроенные валидаторы

from cwtch import dataclass
from cwtch.metadata import Validator
from typing import Annotated

@dataclass
class M:
    i: Annotated[int, Validator(after=lambda v: v / 2)]

>>> M(i='2')
M(i=1.0)

from typing import Annotated
from cwtch import dataclass
from cwtch.metadata import Ge, Gt, Le, Lt, MaxItems, MaxLen, MinItems, MinLen
from cwtch.types import Positive, Strict

@dataclass
class M:
    i: Annotated[Strict[Positive[int]], Ge(1)]
    items: Annotated[list[int], MinItems(1)]

>>> M(i=0, items=[0])
...
ValidationError: 
  Type: --> <class '__main__.M'>
  Path: ['i']
  ValidationError:
    Type: <class 'int'> --> Annotated[int, Ge(value=1), Strict(type=[<class 'int'>]), Ge(value=1)]
    Input: 0
    ValueError: value should be >= 1

>>> M(i=1, items=[])
...
ValidationError: 
  Type: --> <class '__main__.M'>
  Path: ['items']
  ValidationError:
    Type: <class 'list'> --> Annotated[list[int], MinItems(value=1)]
    Input: []
    ValueError: items count should be >= 1