Python 进阶 —— 使用修饰器执行函数的参数检查

参数检查：1. 参数的个数；2. 参数的类型；3. 返回值的类型。

考虑如下的函数：

import html

def make_tagged(text, tag):
    return '<{0}>{1}</{0}>'.format(tag, html.escape(text))

显然我们希望传递进来两个参数，且参数类型/返回值类型均为str，再考虑如下的函数：

def repeat(what, count, separator) :
    return ((what + separator)*count)[:-len(separator)]

显然我们希望传递进来三个参数，分别为str，int，str类型，可对返回值不做要求。

那么我们该如何实现对上述参数要求，进行参数检查呢？

import functools

def statically_typed(*types, return_type=None):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if len(args) > len(types):
                raise ValueError('too many arguments')
            elif len(args) < len(types):
                raise ValueError('too few arguments')
            for i, (type_, arg) in enumerate(zip(types, args)):
                if not isinstance(type_, arg):
                    raise ValueError('argument {} must be of type {}'.format(i, type_.__name__))
            result = func(*args, **kwargs)
            if return_type is not None and not isinstance(result, return_type):
                raise ValueError('return value must be of type {}'.format(return_type.__name__))
            return wrapper
        return decorator

这样，我们便可以使用修饰器模板执行参数检查了：

@statically_typed(str, str, return_type=str)
def make_tagged(text, tag):
    return '<{0}>{1}</{0}>'.format(tag, html.escape(text))

@statically_typed(str, int, str)
def repeat(what, count, separator):
    return ((what + separator)*count)[:-len(separator)]

注：从静态类型语言（C/C++、Java）转入 Python 的开发者可能比较喜欢用修饰器对函数的参数及返回值执行静态类型检查，但这样做会增加 Python 程序在运行期的开销，而编译型语言则没有这种运行期开销（Python 是解释型语言）。