Python:类型检查装饰器

时间:2016-04-27 03:50:25

标签: python python-2.7 decorator python-decorators typechecking

我已经构建了一个类型检查装饰器(带有包装):

def accepts_func(*types):
    """ 
    top-level decoration, consumes parameters
    """

    def decorator(func):
        """ 
        actual decorator function, consumes the input function
        """

        @wraps(func)
        def check_accepts(*args):
            """ 
            actual wrapper which does some magic type-checking
            """

            # check if length of args matches length of specified types
            assert len(args) == len(types), "{} arguments were passed to func '{}', but only {} " \
                                            "types were passed to decorator '@accepts_func'" \
                .format(len(args), func.__name__, len(types))

            # check types of arguments
            for i, arg, typecheck in izip(range(1, len(args)+1), args, types):
                assert isinstance(arg, typecheck), "type checking: argument #{} was expected to be '{}' but is '{}'" \
                    .format(i, typecheck, type(arg))

            return func(*args)

        return check_accepts

    return decorator

您可以根据需要传递任意数量的类型,并检查传递给func的参数类型是否与@accepts_func(param_type1, param_type2, ...)中“硬编码”的参数类型匹配:

@accepts_func(int, str)
sample_func(arg1, arg2):
    ...does something...

到目前为止它没有任何问题。

但是,由于我不是Python“大师”,我想知道我的解决方案是否适合“更大”的项目?

我的解决方案有任何缺点吗? 例如。喜欢性能问题,边缘情况下未被捕获的错误和东西?

有没有办法改善我的解决方案?做得更好,存在更多“pythonic”解决方案吗?

注意:我不是在检查项目中的每个函数,只是我认为我确实需要类型安全的那些函数。该项目在服务器上运行,因此,抛出的错误会出现在日志中,并且对用户不可见。

2 个答案:

答案 0 :(得分:1)

我实际上不鼓励对输入变量进行类型检查。除了性能之外,Python是一种动态类型语言,在某些情况下(例如测试),您需要传递一个对象来实现您最初计划提供的对象的某些属性,并且这将适用于您的代码。

一个简单的例子:

class fake_str:
    def __init__(self, string):
        self.string = string

    def __str__(self):
        return self.string

string = fake_str('test')

isinstance(string, str) # False
string # 'test'

为什么你不接受正在运作的东西

只允许兼容的对象使用您的代码。

indexOfObject:

答案 1 :(得分:-1)

如果要进行类型检查,请使用python 3.5及其支持内置类型提示的输入模块。

http://blog.jetbrains.com/pycharm/2015/11/python-3-5-type-hinting-in-pycharm-5/

编辑:

作为对读者的警告。使用像python这样的语言类型提示可能很有用但也很痛苦。许多python API都是高度多态的,接受许多不同类型的不同参数和可选参数。这些函数上的类型签名是 gnarly ,注释它们根本没用。但对于采用和返回简单类型的简单函数,类型提示只能帮助提高清晰度。