62

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存在类型不正确的 a 。它可以很好地实现__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


几年后重新审视这个问题,我现在开始使用pydantic在我想要验证通常只为其定义数据类的类的情况下。不过,我会用当前接受的答案留下我的印记,因为它正确回答了原始问题并具有出色的教育价值。

4

4 回答 4

76

而不是检查类型相等性,您应该使用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'>

Python 3.8 引入了更好的typing.get_origin()自省功能支持:

# Python 3.8
>>> import typing
>>> typing.get_origin(typing.List)
<class 'list'>
>>> typing.get_origin(typing.List[int])
<class 'list'>

值得注意的例外是typing.Any,typing.Uniontyping.ClassVar……嗯,任何是 a 的东西typing._SpecialForm都没有定义__origin__。幸运的是:

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

但是参数化类型定义了一个__args__将其参数存储为元组的属性;Python 3.8 引入了typing.get_args()检索它们的函数:

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

# Python 3.8
>>> typing.get_args(typing.Union[int, str])
(<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:
        # In case of non-typing types (such as <class 'int'>, for instance)
        actual_type = field_def.type
    # In Python 3.8 one would replace the try/except with
    # actual_type = typing.get_origin(field_def.type) or 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:
                    # In case of non-typing types (such as <class 'int'>, for instance)
                    actual_type = type_hint
                # In Python 3.8 one would replace the try/except with
                # actual_type = typing.get_origin(type_hint) or 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_hintsandinspect.signature来代替;

  • 不验证不是适当类型的默认值:

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

    不提出任何TypeError。如果你想解释这一点,你可能想结合使用inspect.Signature.bind(从而迫使你定义);inspect.BoundArguments.apply_defaultsdef foo(bar: typing.Optional[int] = None)

  • 无法验证可变数量的参数,因为您必须定义类似的东西,def foo(*args: typing.Sequence, **kwargs: typing.Mapping)并且正如开头所说,我们只能验证容器而不是包含的对象。


更新

在这个答案得到一定的普及并且一个受它启发的发布之后,消除上述缺点的需要正在成为现实。所以我对这个typing模块进行了更多的尝试,并将在这里提出一些发现和一种新方法。

首先,typing在查找参数何时是可选的方面做得很好:

>>> def foo(a: int, b: str, c: typing.List[str] = None):
...   pass
... 
>>> typing.get_type_hints(foo)
{'a': <class 'int'>, 'b': <class 'str'>, 'c': typing.Union[typing.List[str], NoneType]}

这非常简洁,绝对是对 的改进inspect.getfullargspec,因此更好地使用它,因为它还可以正确处理字符串作为类型提示。但typing.get_type_hints会为其他类型的默认值提供救助:

>>> def foo(a: int, b: str, c: typing.List[str] = 3):
...   pass
... 
>>> typing.get_type_hints(foo)
{'a': <class 'int'>, 'b': <class 'str'>, 'c': typing.List[str]}

所以你可能仍然需要额外的严格检查,即使这样的情况感觉很可疑。

接下来是typing用作 参数的提示的情况typing._SpecialForm,例如typing.Optional[typing.List[str]]typing.Final[typing.Union[typing.Sequence, typing.Mapping]]。由于__args__这些typing._SpecialForms 始终是一个元组,因此可以递归地找到该__origin__元组中包含的提示的 。结合上述检查,我们将需要过滤任何typing._SpecialForm左侧。

建议的改进:

import inspect
import typing
from functools import wraps


def _find_type_origin(type_hint):
    if isinstance(type_hint, typing._SpecialForm):
        # case of typing.Any, typing.ClassVar, typing.Final, typing.Literal,
        # typing.NoReturn, typing.Optional, or typing.Union without parameters
        return

    actual_type = typing.get_origin(type_hint) or type_hint  # requires Python 3.8
    if isinstance(actual_type, typing._SpecialForm):
        # case of typing.Union[…] or typing.ClassVar[…] or …
        for origins in map(_find_type_origin, typing.get_args(type_hint)):
            yield from origins
    else:
        yield actual_type


def _check_types(parameters, hints):
    for name, value in parameters.items():
        type_hint = hints.get(name, typing.Any)
        actual_types = tuple(_find_type_origin(type_hint))
        if actual_types and not isinstance(value, actual_types):
            raise TypeError(
                    f"Expected type '{type_hint}' for argument '{name}'"
                    f" but received type '{type(value)}' instead"
            )


def enforce_types(callable):
    def decorate(func):
        hints = typing.get_type_hints(func)
        signature = inspect.signature(func)

        @wraps(func)
        def wrapper(*args, **kwargs):
            parameters = dict(zip(signature.parameters, args))
            parameters.update(kwargs)
            _check_types(parameters, hints)

            return func(*args, **kwargs)
        return wrapper

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

    return decorate(callable)


def enforce_strict_types(callable):
    def decorate(func):
        hints = typing.get_type_hints(func)
        signature = inspect.signature(func)

        @wraps(func)
        def wrapper(*args, **kwargs):
            bound = signature.bind(*args, **kwargs)
            bound.apply_defaults()
            parameters = dict(zip(signature.parameters, bound.args))
            parameters.update(bound.kwargs)
            _check_types(parameters, hints)

            return func(*args, **kwargs)
        return wrapper

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

    return decorate(callable)

感谢@Aran-Fey帮助我改进了这个答案。

于 2018-05-31T10:54:19.127 回答
42

刚发现这个问题。

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)
于 2019-04-29T21:21:52.890 回答
2

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

该库可应用于包含另一个数据类(嵌套数据类)和嵌套容器类型(如Tuple[List[Dict...)的数据类

于 2021-02-03T15:03:10.977 回答
1

对于键入别名,您必须单独检查注释。我确实喜欢这样: https ://github.com/EvgeniyBurdin/validated_dc

于 2020-05-03T08:04:26.083 回答