web-dev-qa-db-ja.com

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つ指定）

関数が自動的に渡されないのはなぜですか？関数をデコレータ関数に明示的に渡すにはどうすればよいですか？

pythonpython-2.7python-decorators
78
balki

関数のようにデコレータを呼び出しているため、実際のデコレータである別の関数を返す必要があります。

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
139
interjay

別の視点を提供するために：構文

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

と同等です

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

特に、exprは、呼び出し可能と評価される限り、好きなものにできます。 特定特に、exprはデコレーターファクトリーになることができます：パラメーターをいくつか与え、デコレーターを与えます。だからあなたの状況を理解するより良い方法は

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

その後に短縮することができます

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

もちろん、それはlooks like decorator_factoryはデコレータであり、人々はそれを反映して名前を付ける傾向があります。インダイレクションのレベルを追おうとすると混乱する可能性があります。

41
Katriel

デコレータの引数をオプションにすることができる便利なトリックを追加したいだけです。また、デコレータを再利用してネストを減らすこともできます

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)
17
Alexey Smirnov

デコレータを実行する別の方法。この方法が私の頭を包み込むのが最も簡単だと思います。

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()
7
Robert Fey