web-dev-qa-db-ja.com

Pythonクラスのデコレータ

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

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

    @self._decorator
    def bar(self):
        pass

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

私も試しました：

@Test._decorator(self)

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

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

pythonclassdecoratorself
121
hcvst

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

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
233
Michael Speer

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

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)
54
Evan Fosmark
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()
17
madjardi

これは、同じクラス内で定義されたデコレーターの内部からselfにアクセスするために知っている（そして使用した）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'

上記の例は馬鹿げていますが、動作することを示しています。

7
Gunnar Hermansson

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

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（）with the brackets onを使用する必要があります。

6
digitalacorn

よく似た問題を調査しているときに、この質問を見つけました。私の解決策は、問題を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
samwyse

Michael Speerの答えをさらにいくつかのステップに拡張したものを次に示します。

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

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
Oliver Evans

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

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
3
nicodjimenez

デコレータをデコレートできます：

import decorator

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

    @_decorator
    def bar(self):
        pass
1
doep