如何向 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个)

为什么函数没有自动传递? 如何显式地将函数传递给装饰函数？

87526 次浏览
小开
最佳答案

因为你像调用一个函数一样调用这个函数，所以它需要返回另一个实际的函数:

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调用将诸如名称和 docstring 之类的内容复制到包装函式中，使其更加类似于原来的函数。

示例用法:

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

只是为了提供一个不同的观点: 语法

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

相当于

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

特别是，expr可以是任何您喜欢的东西，只要它的计算结果是可调用的。特别是在 特别中，expr可以是一个装饰器工厂: 您给它一些参数，它就会给您一个装饰器。所以也许更好的理解你的情况的方法是

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

然后可以简化为

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

当然，因为 看起来就像 decorator_factory一样是一个装饰品，人们往往会给它命名来反映这一点。当您试图遵循间接级别时，这可能会令人困惑。

小开

只是想添加一些有用的技巧，允许使修饰器参数可选。它还允许重用装饰器和减少嵌套

import functools


def myDecorator(test_func=None,logIt=None):
if test_func is None:
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)
小开

只是装修师的另一种方式。 我觉得这样最容易理解。

class NiceDecorator:
def __init__(self, param_foo='a', param_bar='b'):
self.param_foo = param_foo
self.param_bar = param_bar


def __call__(self, func):
def my_logic(*args, **kwargs):
# whatever logic your decorator is supposed to implement goes in here
print('pre action baz')
print(self.param_bar)
# including the call to the decorated function (if you want to do that)
result = func(*args, **kwargs)
print('post action beep')
return result


return my_logic


# usage example from here on
@NiceDecorator(param_bar='baaar')
def example():
print('example yay')




example()
小开

现在如果你想用修饰符 decorator_with_arg调用函数 function1在这个例子中函数和修饰符都接受参数,

def function1(a, b):
print (a, b)


decorator_with_arg(10)(function1)(1, 2)

提交答案