Jak przekazać dodatkowe argumenty dekoratorowi Pythona?

Mam dekoratora jak poniżej.

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

Chcę wzmocnić ten dekorator, aby zaakceptować inny argument jak poniżej 

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

Ale ten kod daje błąd,

TypeError: myDecorator () pobiera dokładnie 2 argumenty (1 podany)

Dlaczego funkcja nie jest automatycznie przekazywana? Jak jawnie przekazać funkcję do funkcji dekoratora?

Author: Vadim Kotov, 2012-04-16
Source

5 answers

Ponieważ dekorator jest wywoływany jak funkcja, musi zwrócić inną funkcję, która jest aktualnym dekoratorem: 

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

Funkcja zewnętrzna otrzyma wszelkie argumenty, które przekażesz jawnie, i powinna zwrócić funkcję wewnętrzną. Wewnętrzna funkcja zostanie przekazana funkcji do dekoracji i zwróci zmodyfikowaną funkcję.

Zazwyczaj chcesz, aby dekorator zmienił zachowanie funkcji, owijając ją w funkcję owijania. Oto przykład, który opcjonalnie dodaje logowanie po wywołaniu funkcji: 

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

Wywołanie functools.wraps kopiuje rzeczy takie jak nazwa i docstring do funkcji wrapper, aby była bardziej podobna do oryginalnej funkcji.

Przykładowe użycie: 

>>> @log_decorator(True)
... def f(x):
...     return x+1
...
>>> f(4)
Calling Function: f
5
 175
Author: interjay,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-02-17 22:43:57

Aby przedstawić inny punkt widzenia: składnia 

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

Jest równoważne 

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

W szczególności, expr może być cokolwiek chcesz, tak długo, jak to ewaluuje do wywołania. W particular particular, expr może być fabryką dekoratorów: podajesz mu jakieś parametry i daje Ci dekoratora. Więc może lepszym sposobem na zrozumienie twojej sytuacji jest 

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

, które następnie można skrócić do 

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

Oczywiście, ponieważ wygląda Jak decorator_factory jest dekoratorem, ludzie nazywają go, aby to odzwierciedlić. Co może być mylące, gdy próbujesz podążać za poziomami indrection.

 47
Author: Katriel,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2012-04-16 15:09:02

Chcę tylko dodać jakąś użyteczną sztuczkę, która pozwoli uczynić argumenty dekoratora opcjonalnymi. Będzie również alows, aby ponownie użyć dekoratora i zmniejszyć zagnieżdżanie 

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)
 27
Author: Alexey Smirnov,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2016-04-20 09:44:01

Kolejny sposób na dekoratorów. W ten sposób najłatwiej ogarnąć moją głowę.

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()
 19
Author: Robert Fey,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2019-04-17 12:39:46

Teraz, jeśli chcesz wywołać funkcję {[1] } z dekoratorem decorator_with_arg i w tym przypadku zarówno funkcja, jak i dekorator pobierają argumenty, 

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

decorator_with_arg(10)(function1)(1, 2)
 0
Author: SuperNova,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2020-05-29 04:48:46