Как передать дополнительные аргументы декоратору 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 дано)
Почему функция не передается автоматически? Как явно передать функцию функции декоратора?
Ответы
Ответ 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
копирует такие вещи, как имя и docstring, в функцию-обертку, чтобы сделать ее более похожей на исходную функцию.
Пример использования:
>>> @log_decorator(True)
... def f(x):
... return x+1
...
>>> f(4)
Calling Function: f
5
Ответ 2
Просто для предоставления другой точки зрения: синтаксис
@expr
def func(...): #stuff
эквивалентно
def func(...): #stuff
func = expr(func)
В частности, expr
может быть любым, что вам нравится, если оно оценивается вызываемым. В частности, expr
может быть декоратором factory: вы даете ему некоторые параметры, и это дает вам декоратор. Поэтому, возможно, лучший способ понять вашу ситуацию - это
dec = decorator_factory(*args)
@dec
def func(...):
который затем можно сократить до
@decorator_factory(*args)
def func(...):
Конечно, так как выглядит decorator_factory
- декоратор, люди склонны называть его, чтобы отразить это. Это может сбивать с толку, когда вы пытаетесь следовать уровням косвенности.
Ответ 3
Просто хочу добавить полезный трюк, который позволит сделать аргументы декоратора опционными. Он также будет использовать повторное использование декоратора и уменьшение вложенности
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)
Ответ 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()