Pythonデコレーターに追加の引数を渡すにはどうすればよいですか?


93

以下のようなデコレータがあります。

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つが指定されています)

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


3
balki:booleanを引数として使用しないでください。これはgdアプローチではなく、コードの読みやすさを低下させます
Kit Ho

8
@KitHo-これはブールフラグなので、ブール値を使用するのが適切な方法です。
AKX 2012

2
@KitHo-「gd」とは何ですか?「いい」ですか?
Rob Bednark、2016

回答:


164

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

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

11
また、使用するfunctools.wrapsことをお勧めします-ラップされた関数の元の名前、docstringなどを保持します。
AKX

@AKX:ありがとう、これを2番目の例に追加しました。
interjay 2012

1
したがって、基本的にデコレータは常に関数である1つの引数のみを取ります。ただし、デコレータは、引数を取る可能性のある関数の戻り値にすることができます。これは正しいです?
balki

2
@balki:はい、そうです。混乱するのは、多くの人が外部関数(myDecoratorここでは)をデコレータと呼ぶこともあるということです。これはデコレータのユーザーにとっては便利ですが、デコレータを作成しようとすると混乱する可能性があります。
interjay 2012

1
私を混乱させた細部:あなたlog_decoratorがデフォルトの引数を取る場合、あなたはを使用できません@log_decorator、それはそうでなければなりません@log_decorator()
Stardidi

44

別の視点を提供するためだけに:構文

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

に相当

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

特に、exprcallableと評価される限り、好きなようにできます。では、特定の特定、exprデコレータの工場をすることができます:あなたはそれにいくつかのパラメータを与え、それはあなたのデコレータを提供します。だからあなたの状況を理解するより良い方法は

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

これは、次のように短縮できます

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

もちろん、それdecorator_factoryデコレータのように見えるので、人々はそれを反映するように名前を付ける傾向があります。間接参照のレベルを追跡しようとすると、混乱する可能性があります。


おかげで、これは私が何が起こっているのかの背後にある理論的根拠を理解するのに本当に役立ちました。
Aditya Sriram

24

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

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)

16

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

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

ありがとうございました!約30分間、いくつかの驚異的な「解決策」を見てきましたが、これは実際に意味のある最初のものです。
canhazbits

0

ここfunction1で、デコレータを使用して関数を呼び出す場合decorator_with_argを使用し場合、この場合、関数とデコレータの両方が引数を取ります。

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

decorator_with_arg(10)(function1)(1, 2)
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.