Проверка подробных типов в классах данных Python

Question

Python 3.7 не за горами, и я хотел протестировать некоторые из новых dataclass + печатать особенности. Получить подсказки для правильной работы достаточно легко, как с родными типами, так и с typing модуль:

>>> import dataclasses
>>> import typing as ty
>>> 
... @dataclasses.dataclass
... class Structure:
...     a_str: str
...     a_str_list: ty.List[str]
...
>>> my_struct = Structure(a_str='test', a_str_list=['t', 'e', 's', 't'])
>>> my_struct.a_str_list[0].  # IDE suggests all the string methods :)

Но еще одна вещь, которую я хотел попробовать, заключалась в том, чтобы форсировать подсказки типов в качестве условий во время выполнения, то есть это не должно быть возможным для dataclass с неправильными типами, чтобы существовать. Это может быть реализовано красиво с __post_init__:

>>> @dataclasses.dataclass
... class Structure:
...     a_str: str
...     a_str_list: ty.List[str]
...     
...     def validate(self):
...         ret = True
...         for field_name, field_def in self.__dataclass_fields__.items():
...             actual_type = type(getattr(self, field_name))
...             if actual_type != field_def.type:
...                 print(f"\t{field_name}: '{actual_type}' instead of '{field_def.type}'")
...                 ret = False
...         return ret
...     
...     def __post_init__(self):
...         if not self.validate():
...             raise ValueError('Wrong types')

Этот вид validate Функция работает для собственных типов и пользовательских классов, но не тех, которые определены typing модуль:

>>> my_struct = Structure(a_str='test', a_str_list=['t', 'e', 's', 't'])
Traceback (most recent call last):
  a_str_list: '<class 'list'>' instead of 'typing.List[str]'
  ValueError: Wrong types

Есть ли лучший подход для проверки нетипизированного списка с typing типизированный? Предпочтительно тот, который не включает проверку типов всех элементов в любом list, dict, tuple, или же set это dataclass атрибут.

Answer 1

Вместо проверки на равенство типов, вы должны использовать isinstance, Но вы не можете использовать параметризованный универсальный тип (typing.List[int]) для этого необходимо использовать "универсальную" версию (typing.List). Таким образом, вы сможете проверить тип контейнера, но не содержащиеся в нем типы. Параметризованные универсальные типы определяют __origin__ атрибут, который вы можете использовать для этого.

В отличие от Python 3.6, в Python 3.7 большинство подсказок типов имеют полезные __origin__ приписывать. Для сравнения:

# Python 3.6
>>> import typing
>>> typing.List.__origin__
>>> typing.List[int].__origin__
typing.List

а также

# Python 3.7
>>> import typing
>>> typing.List.__origin__
<class 'list'>
>>> typing.List[int].__origin__
<class 'list'>

Известные исключения, являющиеся typing.Any, typing.Union а также typing.ClassVar... Ну, все, что typing._SpecialForm не определяет __origin__, К счастью:

>>> isinstance(typing.Union, typing._SpecialForm)
True
>>> isinstance(typing.Union[int, str], typing._SpecialForm)
False
>>> typing.Union[int, str].__origin__
typing.Union

Но параметризованные типы определяют __args__ атрибут, который хранит свои параметры в виде кортежа:

>>> typing.Union[int, str].__args__
(<class 'int'>, <class 'str'>)

Таким образом, мы можем немного улучшить проверку типов:

for field_name, field_def in self.__dataclass_fields__.items():
    if isinstance(field_def.type, typing._SpecialForm):
        # No check for typing.Any, typing.Union, typing.ClassVar (without parameters)
        continue
    try:
        actual_type = field_def.type.__origin__
    except AttributeError:
        actual_type = field_def.type
    if isinstance(actual_type, typing._SpecialForm):
        # case of typing.Union[…] or typing.ClassVar[…]
        actual_type = field_def.type.__args__

    actual_value = getattr(self, field_name)
    if not isinstance(actual_value, actual_type):
        print(f"\t{field_name}: '{type(actual_value)}' instead of '{field_def.type}'")
        ret = False

Это не идеально, так как не будет typing.ClassVar[typing.Union[int, str]] или же typing.Optional[typing.List[int]] например, но все должно начаться.

---

Следующий способ применить эту проверку.

Вместо того, чтобы использовать __post_init__ Я бы пошел по пути декоратора: это можно было бы использовать с любыми подсказками типа, не только dataclasses:

import inspect
import typing
from contextlib import suppress
from functools import wraps


def enforce_types(callable):
    spec = inspect.getfullargspec(callable)

    def check_types(*args, **kwargs):
        parameters = dict(zip(spec.args, args))
        parameters.update(kwargs)
        for name, value in parameters.items():
            with suppress(KeyError):  # Assume un-annotated parameters can be any type
                type_hint = spec.annotations[name]
                if isinstance(type_hint, typing._SpecialForm):
                    # No check for typing.Any, typing.Union, typing.ClassVar (without parameters)
                    continue
                try:
                    actual_type = type_hint.__origin__
                except AttributeError:
                    actual_type = type_hint
                if isinstance(actual_type, typing._SpecialForm):
                    # case of typing.Union[…] or typing.ClassVar[…]
                    actual_type = type_hint.__args__

                if not isinstance(value, actual_type):
                    raise TypeError('Unexpected type for \'{}\' (expected {} but found {})'.format(name, type_hint, type(value)))

    def decorate(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            check_types(*args, **kwargs)
            return func(*args, **kwargs)
        return wrapper

    if inspect.isclass(callable):
        callable.__init__ = decorate(callable.__init__)
        return callable

    return decorate(callable)

Использование быть:

@enforce_types
@dataclasses.dataclass
class Point:
    x: float
    y: float

@enforce_types
def foo(bar: typing.Union[int, str]):
    pass

Помимо проверки некоторых подсказок типов, как это было предложено в предыдущем разделе, этот подход все еще имеет некоторые недостатки:

• подсказки типа с использованием строк (class Foo: def __init__(self: 'Foo'): pass) не принимаются во внимание inspect.getfullargspec: вы можете использовать typing.get_type_hints а также inspect.signature вместо;

• значение по умолчанию, не соответствующее типу, не проверяется:

  @enforce_type
  def foo(bar: int = None):
      pass
  
  foo()
  

  не поднимает никакой TypeError, Вы можете использовать inspect.Signature.bind В связке с inspect.BoundArguments.apply_defaults если вы хотите учесть это (и, следовательно, вынуждают вас определить def foo(bar: typing.Optional[int] = None));

• переменное количество аргументов не может быть проверено, так как вы должны определить что-то вроде def foo(*args: typing.Sequence, **kwargs: typing.Mapping) и, как было сказано в начале, мы можем проверять только контейнеры и не содержащие объекты.

---

_{Спасибо Aran-Fey, который помог мне улучшить этот ответ.}

Answer 2

Просто нашел этот вопрос.

Pydantic может выполнить полную проверку типа для классов данных из коробки. (вход: я построил пидантик)

Просто используйте версию декоратора pydantic, получившийся класс данных полностью ванильный.

from datetime import datetime
from pydantic.dataclasses import dataclass

@dataclass
class User:
    id: int
    name: str = 'John Doe'
    signup_ts: datetime = None

print(User(id=42, signup_ts='2032-06-21T12:00'))
"""
User(id=42, name='John Doe', signup_ts=datetime.datetime(2032, 6, 21, 12, 0))
"""

User(id='not int', signup_ts='2032-06-21T12:00')

Последняя строка даст:

    ...
pydantic.error_wrappers.ValidationError: 1 validation error
id
  value is not a valid integer (type=type_error.integer)

Answer 3

Для этой цели я создал крошечную библиотеку Python: https://github.com/tamuhey/dataclass_utils

Эта библиотека может применяться для такого класса данных, который содержит другой класс данных (вложенный класс данных) и вложенный тип контейнера (например, Tuple[List[Dict...)

Answer 4

Для набора псевдонимов необходимо отдельно проверить аннотацию. Мне понравилось это: https://github.com/EvgeniyBurdin/validated_dc