クラスのPythonデコレータ


140

次のようなものを書くことができます:

class Test(object):
    def _decorator(self, foo):
        foo()

    @self._decorator
    def bar(self):
        pass

これは失敗します:@self内のselfは不明です

私も試しました:

@Test._decorator(self)

これも失敗します:不明なテスト

デコレータでいくつかのインスタンス変数を一時的に変更してから、それらを元に戻す前に装飾されたメソッドを実行したいと思います。

回答:


268

このようなものはあなたが必要とすることをしますか?

class Test(object):
    def _decorator(foo):
        def magic( self ) :
            print "start magic"
            foo( self )
            print "end magic"
        return magic

    @_decorator
    def bar( self ) :
        print "normal call"

test = Test()

test.bar()

これにより、デコレータにアクセスするためのselfの呼び出しが回避され、通常のメソッドとしてクラスの名前空間に非表示のままになります。

>>> import stackoverflow
>>> test = stackoverflow.Test()
>>> test.bar()
start magic
normal call
end magic
>>> 

コメントで質問に答えるように編集:

別のクラスで非表示のデコレータを使用する方法

class Test(object):
    def _decorator(foo):
        def magic( self ) :
            print "start magic"
            foo( self )
            print "end magic"
        return magic

    @_decorator
    def bar( self ) :
        print "normal call"

    _decorator = staticmethod( _decorator )

class TestB( Test ):
    @Test._decorator
    def bar( self ):
        print "override bar in"
        super( TestB, self ).bar()
        print "override bar out"

print "Normal:"
test = Test()
test.bar()
print

print "Inherited:"
b = TestB()
b.bar()
print

出力:

Normal:
start magic
normal call
end magic

Inherited:
start magic
override bar in
start magic
normal call
end magic
override bar out
end magic

7
デコレータまたは装飾された関数?インスタンスで「bar」が呼び出されると、barをラップする返された「magic」関数が上記の自己変数を受け取り、「bar」を呼び出す前後に(またはそうでない場合も)必要なインスタンス変数に対して何でも実行できることに注意してください。 。クラスを宣言するとき、インスタンス変数のようなものはありません。デコレータ内からクラスに何かしたいですか?それは慣用的な使い方ではないと思います。
マイケル・スピア

1
マイケルに感謝します。これが私が欲しかったものであることがわかりました。
hcvst '18年

2
定義の時点で@デコレーター構文を使用できるため、この解決策は受け入れられた回答よりもはるかに優れています。クラスの最後にデコレータコールを配置する必要がある場合、関数が装飾されているかどうかはわかりません。@staticmethodをデコレーター自体で使用できないのは少し奇妙ですが、少なくとも機能します。
mgiuca

1
Testの継承クラスを作成しても機能しないと思います。例:class TestB(Test):@_decorator def foobar(self):print "adsf"回避策はありますか?
2013

1
@extraeee:私が行った編集を確認してください。指定されたデコレータを静的メソッドとして修飾する必要がありますが、それを使用した後(または静的メソッドのバージョンを別の名前に割り当てた後)にのみ
Michael Speer

58

あなたがしたいことは不可能です。たとえば、以下のコードが有効に見えるかどうかを考えてみましょう:

class Test(object):

    def _decorator(self, foo):
        foo()

    def bar(self):
        pass
    bar = self._decorator(bar)

もちろん、selfその時点ではが定義されていないため、無効です。Testクラス自体が定義されるまで(定義中)は定義されないため、同じことが言えます。これはデコレータスニペットの変換先であるためこのコードスニペットを表示します

ご覧のとおり、デコレータはインスタンス化中ではなく、接続されている関数/メソッドの定義中に適用されるため、このようなデコレータでインスタンスにアクセスすることは実際には不可能です。

クラスレベルのアクセスが必要な場合は、これを試してください:

class Test(object):

    @classmethod
    def _decorator(cls, foo):
        foo()

    def bar(self):
        pass
Test.bar = Test._decorator(Test.bar)

5
おそらく、以下のより正確な答えを参照するように更新する必要があります
Nathan Buesgens 2017

1
いいね。あなたの散文は不可能だと言いますが、あなたのコードはほとんどそれを行う方法を示しています。
マッド

22
import functools


class Example:

    def wrapper(func):
        @functools.wraps(func)
        def wrap(self, *args, **kwargs):
            print("inside wrap")
            return func(self, *args, **kwargs)
        return wrap

    @wrapper
    def method(self):
        print("METHOD")

    wrapper = staticmethod(wrapper)


e = Example()
e.method()

1
TypeError: 'staticmethod'オブジェクトは呼び出し不可能です
wyx

@wyxはデコレータを呼び出しません。例えば、それがあるべき@fooではない@foo()
docyoda

最初の引数はするべきではないwrapperことself
CpILL

7

このタイプのデコレーターをいくつかのデバッグ状況で使用します。これにより、呼び出し側の関数を見つけることなく、デコレートによってクラスのプロパティーをオーバーライドできます。

class myclass(object):
    def __init__(self):
        self.property = "HELLO"

    @adecorator(property="GOODBYE")
    def method(self):
        print self.property

ここにデコレータコードがあります

class adecorator (object):
    def __init__ (self, *args, **kwargs):
        # store arguments passed to the decorator
        self.args = args
        self.kwargs = kwargs

    def __call__(self, func):
        def newf(*args, **kwargs):

            #the 'self' for a method function is passed as args[0]
            slf = args[0]

            # replace and store the attributes
            saved = {}
            for k,v in self.kwargs.items():
                if hasattr(slf, k):
                    saved[k] = getattr(slf,k)
                    setattr(slf, k, v)

            # call the method
            ret = func(*args, **kwargs)

            #put things back
            for k,v in saved.items():
                setattr(slf, k, v)

            return ret
        newf.__doc__ = func.__doc__
        return newf 

注:ここではクラスデコレータを使用しているため、デコレータクラスコンストラクタに引数を渡さなくても @ adecorator()を角かっこで囲んで関数を装飾する必要があります。


7

これは、同じクラスself内でdecorator定義された内部からアクセスする(そして使用した)1つの方法です。

class Thing(object):
    def __init__(self, name):
        self.name = name

    def debug_name(function):
        def debug_wrapper(*args):
            self = args[0]
            print 'self.name = ' + self.name
            print 'running function {}()'.format(function.__name__)
            function(*args)
            print 'self.name = ' + self.name
        return debug_wrapper

    @debug_name
    def set_name(self, new_name):
        self.name = new_name

出力(でテストPython 2.7.10):

>>> a = Thing('A')
>>> a.name
'A'
>>> a.set_name('B')
self.name = A
running function set_name()
self.name = B
>>> a.name
'B'

上記の例はばかげていますが、うまくいきます。


4

非常によく似た問題を調査しているときにこの質問を見つけました。私の解決策は、問題を2つの部分に分割することです。まず、クラスメソッドに関連付けるデータをキャプチャする必要があります。この場合、handler_forはUnixコマンドをそのコマンドの出力のハンドラーに関連付けます。

class OutputAnalysis(object):
    "analyze the output of diagnostic commands"
    def handler_for(name):
        "decorator to associate a function with a command"
        def wrapper(func):
            func.handler_for = name
            return func
        return wrapper
    # associate mount_p with 'mount_-p.txt'
    @handler_for('mount -p')
    def mount_p(self, slurped):
        pass

各クラスメソッドにいくつかのデータを関連付けたので、そのデータを収集してクラス属性に格納する必要があります。

OutputAnalysis.cmd_handler = {}
for value in OutputAnalysis.__dict__.itervalues():
    try:
        OutputAnalysis.cmd_handler[value.handler_for] = value
    except AttributeError:
        pass

4

マイケルスピアの回答をさらに拡張して、さらにいくつかの手順を実行します。

引数を取り、引数と戻り値を持つ関数に作用するインスタンスメソッドデコレータ。

class Test(object):
    "Prints if x == y. Throws an error otherwise."
    def __init__(self, x):
        self.x = x

    def _outer_decorator(y):
        def _decorator(foo):
            def magic(self, *args, **kwargs) :
                print("start magic")
                if self.x == y:
                    return foo(self, *args, **kwargs)
                else:
                    raise ValueError("x ({}) != y ({})".format(self.x, y))
                print("end magic")
            return magic

        return _decorator

    @_outer_decorator(y=3)
    def bar(self, *args, **kwargs) :
        print("normal call")
        print("args: {}".format(args))
        print("kwargs: {}".format(kwargs))

        return 27

その後

In [2]:

    test = Test(3)
    test.bar(
        13,
        'Test',
        q=9,
        lollipop=[1,2,3]
    )
    
    start magic
    normal call
    args: (13, 'Test')
    kwargs: {'q': 9, 'lollipop': [1, 2, 3]}
Out[2]:
    27
In [3]:

    test = Test(4)
    test.bar(
        13,
        'Test',
        q=9,
        lollipop=[1,2,3]
    )
    
    start magic
    ---------------------------------------------------------------------------
    ValueError                                Traceback (most recent call last)
    <ipython-input-3-576146b3d37e> in <module>()
          4     'Test',
          5     q=9,
    ----> 6     lollipop=[1,2,3]
          7 )

    <ipython-input-1-428f22ac6c9b> in magic(self, *args, **kwargs)
         11                     return foo(self, *args, **kwargs)
         12                 else:
    ---> 13                     raise ValueError("x ({}) != y ({})".format(self.x, y))
         14                 print("end magic")
         15             return magic

    ValueError: x (4) != y (3)

3

デコレータは、オブジェクト全体(機能オブジェクトを含む)の機能を変更するが、一般的にインスタンス属性に依存するオブジェクトメソッドの機能よりも適しているようです。例えば:

def mod_bar(cls):
    # returns modified class

    def decorate(fcn):
        # returns decorated function

        def new_fcn(self):
            print self.start_str
            print fcn(self)
            print self.end_str

        return new_fcn

    cls.bar = decorate(cls.bar)
    return cls

@mod_bar
class Test(object):
    def __init__(self):
        self.start_str = "starting dec"
        self.end_str = "ending dec" 

    def bar(self):
        return "bar"

出力は次のとおりです。

>>> import Test
>>> a = Test()
>>> a.bar()
starting dec
bar
ending dec

1

あなたはデコレータを飾ることができます:

import decorator

class Test(object):
    @decorator.decorator
    def _decorator(foo, self):
        foo(self)

    @_decorator
    def bar(self):
        pass

1

私は助けるかもしれないデコレータの実装を持っています

    import functools
    import datetime


    class Decorator(object):

        def __init__(self):
            pass


        def execution_time(func):

            @functools.wraps(func)
            def wrap(self, *args, **kwargs):

                """ Wrapper Function """

                start = datetime.datetime.now()
                Tem = func(self, *args, **kwargs)
                end = datetime.datetime.now()
                print("Exection Time:{}".format(end-start))
                return Tem

            return wrap


    class Test(Decorator):

        def __init__(self):
            self._MethodName = Test.funca.__name__

        @Decorator.execution_time
        def funca(self):
            print("Running Function : {}".format(self._MethodName))
            return True


    if __name__ == "__main__":
        obj = Test()
        data = obj.funca()
        print(data)

1

内部クラスで宣言します。このソリューションはかなりしっかりしており、推奨されます。

class Test(object):
    class Decorators(object):
    @staticmethod
    def decorator(foo):
        def magic(self, *args, **kwargs) :
            print("start magic")
            foo(self, *args, **kwargs)
            print("end magic")
        return magic

    @Decorators.decorator
    def bar( self ) :
        print("normal call")

test = Test()

test.bar()

結果:

>>> test = Test()
>>> test.bar()
start magic
normal call
end magic
>>> 
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.