ValidatedDC - датаклассы с валидацией данных | Forum

4 May 2020, 13:42

Posts: 336
Location: Samara

4 May 2020, 13:42

Posts: 336
Location: Samara

Понадобилось валидировать данные получаемые и отправляемые по api.
Сделал небольшую “надстройку” над датаклассом - датакласс ValidatedDC.

Валидируются аннотации:
1. Стандартные типы python и пользовательские классы
2. Некоторый алиасы из typing: Any, List, Literal, Optional, Union (можно добавить и другие, но для json-api пока без надобности). Эти алиасы могут быть вложены друг в друга, то есть можно описывать сложные структуры данных.
3. При инициализации экземпляра, если его поле имеет в аннотации потомка ValidatedDC, то в такое поле можно подставить словарь (или список словарей, если поле List), и если он будет валидный, то значение поля станет экземпляром потомка ValidatedDC из аннотации.

Подробнее тут:
https://github.com/EvgeniyBurdin/validated_dc

Answer | 0

6 May 2020, 14:04 RaD Posts: 2839 Location: Снегири, МО	6 May 2020, 14:04 RaD Posts: 2839 Location: Снегири, МО Чем не подошёл Marshmallow? Если ничего не помогает, прочтите документацию, наконец!
	Answer \| 0

6 May 2020, 14:29 EvgIq Posts: 336 Location: Samara	6 May 2020, 14:29 EvgIq Posts: 336 Location: Samara Коротко - dataclasses и аннотации :) Нагляднее, в том числе и для вложенных структур. Да и попроще.
	Answer \| 0

6 May 2020, 14:43

EvgIq

Posts: 336
Location: Samara

6 May 2020, 14:43

EvgIq

Posts: 336
Location: Samara

Например, как будет выглядеть в Marshmallow такое: ?

@dataclass
class Phone(ValidatedDC):
    phone: str
    kind: Literal['personal', 'work'] = 'personal'
@dataclass
class Email(ValidatedDC):
    email: str
    kind: Literal['personal', 'work'] = 'work'
@dataclass
class Address(ValidatedDC):
    city: str
    zip_code: Optional[str] = None
@dataclass
class Person(ValidatedDC):
    name: str
    age: int
    contact: Union[Phone, Email, List[Union[Phone, Email]]]
    address: Address
@dataclass
class Workers(ValidatedDC):
    person: Union[Person, List[Person]]

Answer | 0

6 May 2020, 15:18 RaD Posts: 2839 Location: Снегири, МО	6 May 2020, 15:18 RaD Posts: 2839 Location: Снегири, МО Аналогично, только с возможностью преобразования данных как на входе, так и на выходе и с валидацией. Если ничего не помогает, прочтите документацию, наконец!
	Answer \| 0

6 May 2020, 15:21

EvgIq

Posts: 336
Location: Samara

6 May 2020, 15:21

EvgIq

Posts: 336
Location: Samara

Данные и тут преобразуются из словаря во все вложенные классы ( https://github.com/EvgeniyBurdin/validated_dc/blob/master/examples/detailed.py ). И, да, тоже с валидацией.
А с помощью asdict(Workers) - можно все обратно в словарь.

Updated 6 May 2020, 15:23 by EvgIq.

Answer | 0

9 April 2021, 18:05 RaD Posts: 2839 Location: Снегири, МО	9 April 2021, 18:05 RaD Posts: 2839 Location: Снегири, МО Полезная статья: https://kimsereylam.com/python/2019/10/25/serialization-with-marshmallow.html Если ничего не помогает, прочтите документацию, наконец!
	Answer \| 0

12 April 2021, 9:01 oleg_n Posts: 304 Location: Kyiv	12 April 2021, 9:01 oleg_n Posts: 304 Location: Kyiv Полезная статья Из той же серии pydantic Updated 12 April 2021, 9:02 by oleg_n.
	Answer \| 0

12 April 2021, 11:34

EvgIq

Posts: 336
Location: Samara

12 April 2021, 11:34

EvgIq

Posts: 336
Location: Samara

pydantic очень крутая либа.

Вот некоторые плюсы pydantic по сравнению с моим ValidatedDC:

Поддержка большинства (может даже всех) алиасов из typing
Можно сделать json-schema, и использовать ее в документации
Можно задавать для поля описание и значение для примера (example), и это попадет в схему, и, соответственно, в документацию
...
Наверняка, есть еще.

И, наверное, для кого-то будет важно - валидация в pydantic работает в 2,5 раза быстрее чем в ValidatedDC.

Updated 12 April 2021, 11:41 by EvgIq.

Answer | 1