Decoratori Python in classe

Si può scrivere qualcosa del tipo:

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

    @self._decorator
    def bar(self):
        pass

Questo fallisce: self in @self è sconosciuto

Ho anche provato:

@Test._decorator(self)

che fallisce anche: Test sconosciuto

Vorrei modificare temporaneamente alcune variabili di istanza nel decoratore e quindi eseguire il metodo decorato, prima di cambiarle nuovamente.

Qualcosa del genere farebbe quello che ti serve?

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

Questo evita la chiamata a sé per accedere al decoratore e lo lascia nascosto nello spazio dei nomi della classe come metodo normale.

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

modificato per rispondere alla domanda nei commenti:

Come usare il decoratore nascosto in un'altra classe

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

Produzione:

Normal:
start magic
normal call
end magic

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

Quello che vuoi fare non è possibile. Prendi, ad esempio, se il codice qui sotto sembra valido o meno:

class Test(object):

    def _decorator(self, foo):
        foo()

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

Naturalmente, non è valido poiché selfnon è definito a quel punto. Lo stesso vale perché Testnon sarà definito fino a quando non verrà definita la classe stessa (di cui è in procinto di). Ti sto mostrando questo frammento di codice perché questo è ciò in cui si trasforma il tuo frammento di decoratore.

Quindi, come puoi vedere, accedere all'istanza in un decoratore come quello non è davvero possibile poiché i decoratori vengono applicati durante la definizione di qualsiasi funzione / metodo a cui sono collegati e non durante l'istanza.

Se hai bisogno di un accesso a livello di classe , prova questo:

class Test(object):

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

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

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

Uso questo tipo di decoratore in alcune situazioni di debug, consente di ignorare le proprietà della classe decorando, senza dover trovare la funzione chiamante.

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

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

Ecco il codice del decoratore

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 

Nota: poiché ho usato un decoratore di classe, dovrai usare @adecorator () con le parentesi quadre per decorare le funzioni, anche se non passi argomenti al costruttore della classe decoratore.

Questo è un modo per accedere (e averlo usato) selfdall'interno di un decoratordefinito all'interno della stessa classe:

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

Uscita (testato su 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'

L'esempio sopra è sciocco, ma funziona.

Ho trovato questa domanda mentre cercavo un problema molto simile. La mia soluzione è dividere il problema in due parti. Innanzitutto, è necessario acquisire i dati che si desidera associare ai metodi di classe. In questo caso, handler_for assocerà un comando Unix al gestore per l'output di quel comando.

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

Ora che abbiamo associato alcuni dati a ciascun metodo di classe, dobbiamo raccogliere quei dati e archiviarli in un attributo di classe.

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

Ecco un'espansione della risposta di Michael Speer per fare qualche passo in più:

Un decoratore di metodi di istanza che accetta argomenti e agisce su una funzione con argomenti e un valore restituito.

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

E poi

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)

I decoratori sembrano più adatti a modificare la funzionalità di un intero oggetto (compresi gli oggetti funzione) rispetto alla funzionalità di un metodo oggetto che in generale dipenderà dagli attributi dell'istanza. Per esempio:

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"

L'output è:

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

Puoi decorare il decoratore:

import decorator

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

    @_decorator
    def bar(self):
        pass

Ho un'implementazione di decoratori che potrebbero aiutare

    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)

Dichiarare nella classe interna. Questa soluzione è piuttosto solida e consigliata.

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

Il risultato:

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