Question

Python 3.7 is around the corner，我想测试一些奇特的新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＆{}的所有元素的类型。＃39;属性。

Answer 1

您应该使用isinstance而不是检查类型相等性。但是你不能使用参数化泛型类型（typing.List[int]）这样做，你必须使用＆＃34;泛型＆＃34;版本（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与@Aran-Fey结合使用（从而迫使您定义def foo(bar: typing.Optional[int] = None)）;
可以验证可变数量的参数，因为您必须定义类似def foo(*args: typing.Sequence, **kwargs: typing.Mapping)的内容，并且如开头所述，我们只能验证容器而不包含对象。

_{感谢if programming command帮助我改进了这个答案。}

Answer 2

刚刚找到了这个问题。

pydantic可以对数据类进行开箱即用的全类型验证。（入场券：我建造了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

要键入别名，必须单独检查注释。我确实是这样的： https://github.com/EvgeniyBurdin/validated_dc

Answer 4

我为此创建了一个小型 Python 库：https://github.com/tamuhey/dataclass_utils

这个库可以应用于保存另一个数据类（嵌套数据类）和嵌套容器类型（如Tuple[List[Dict...）的数据类

验证python数据类中的详细类型

4 个答案: