我有一个像下面这样的装饰。
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个)
为什么功能不会自动通过?如何将函数显式传递给装饰器函数?
答案 0 :(得分:130)
由于你像函数一样调用装饰器,它需要返回另一个函数,它是实际的装饰器:
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
答案 1 :(得分:38)
只是提供不同的观点:语法
@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
一样是装饰者,人们倾向于将其命名为反映这一点。当您尝试遵循间接级别时,这可能会造成混淆。
答案 2 :(得分:15)
只想添加一些有用的技巧,允许装饰器参数可选。它也将重用装饰器并减少嵌套
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)
答案 3 :(得分:4)
做装饰器的另一种方式。 我发现这种方式最容易缠头。
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()
答案 4 :(得分:0)
现在,如果要使用装饰器function1
调用函数decorator_with_arg
,并且在这种情况下,函数和装饰器都接受参数,
def function1(a, b):
print (a, b)
decorator_with_arg(10)(function1)(1, 2)