如何向Python装饰器传递额外的参数？

Question

我有一个像下面这样的装饰工。

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() takes exactly 2 arguments (1 given)

为什么函数不能自动传递？如何显式地将函数传递给decorator函数？

Answer 1

因为您像调用函数一样调用decorator，所以它需要返回另一个实际的decorator函数：

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

外部函数将得到显式传递的任何参数，并应返回内部函数。内部函数将传递要修饰的函数，并返回已修改的函数。

通常您希望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调用将名称和docstring之类的内容复制到包装器函数，使其更类似于原始函数。

示例用法：

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

Answer 2

只想添加一些有用的技巧，使decorator参数成为可选的。它还可以重用decorator并减少嵌套

import functools

def myDecorator(test_func=None,logIt=None):
    if not test_func:
        return functools.partial(myDecorator, logIt=logIt)
    @functools.wraps(test_func)
    def f(*args, **kwargs):
        if logIt==1:
            print 'Logging level 1 for {}'.format(test_func.__name__)
        if logIt==2:
            print 'Logging level 2 for {}'.format(test_func.__name__)
        return test_func(*args, **kwargs)
    return f

#new decorator 
myDecorator_2 = myDecorator(logIt=2)

@myDecorator(logIt=2)
def pow2(i):
    return i**2

@myDecorator
def pow3(i):
    return i**3

@myDecorator_2
def pow4(i):
    return i**4

print pow2(2)
print pow3(2)
print pow4(2)

Answer 3

只是提供一个不同的观点：语法

@expr
def func(...): #stuff

相当于

def func(...): #stuff
func = expr(func)

尤其是，expr可以是您喜欢的任何东西，只要它的计算结果是可调用的。在specialspecial中，expr可以是一个decorator工厂：你给它一些参数，它给你一个decorator。所以也许更好的方法是

dec = decorator_factory(*args)
@dec
def func(...):

然后可以缩短为

@decorator_factory(*args)
def func(...):

当然，因为它看起来像是一个装饰器，所以人们倾向于将它命名来反映这一点。当你试图遵循间接的层次时，这可能会让人困惑。