如何将额外的参数传递给Python装饰器?


问题内容

我有一个如下的装饰器。

def myDecorator(test_func):
    return callSomeWrapper(test_func)
def callSomeWrapper(test_func):
    return test_func
@myDecorator
def someFunc():
    print 'hello'

我想增强此装饰器以接受如下另一个参数

def myDecorator(test_func,logIt):
    if logIt:
        print "Calling Function: " + test_func.__name__
    return callSomeWrapper(test_func)
@myDecorator(False)
def someFunc():
    print 'Hello'

但是这段代码给出了错误,

TypeError:myDecorator()恰好接受2个参数(给定1个)

为什么不能自动传递函数?如何将函数显式传递给装饰器函数?


问题答案:

由于您像函数一样调用装饰器,因此它需要返回另一个函数,即实际的装饰器:

def my_decorator(param):
    def actual_decorator(func):
        print("Decorating function {}, with parameter {}".format(func.__name__, param))
        return function_wrapper(func)  # assume we defined a wrapper somewhere
    return actual_decorator

外部函数将获得您显式传递的所有参数,并且应返回内部函数。内部函数将被传递给函数进行装饰,并返回修改后的函数。

通常,您希望装饰器通过将其包装在包装函数中来更改功能行为。这是一个示例,可以在调用函数时添加日志记录:

def log_decorator(log_enabled):
    def actual_decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kwargs):
            if log_enabled:
                print("Calling Function: " + func.__name__)
            return func(*args, **kwargs)
        return wrapper
    return actual_decorator

functools.wraps调用将名称和文档字符串之类的内容复制到包装函数,以使其与原始函数更相似。

用法示例:

>>> @log_decorator(True)
... def f(x):
...     return x+1
...
>>> f(4)
Calling Function: f
5