Decoradores Python nas aulas


140

Pode-se escrever algo como:

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

    @self._decorator
    def bar(self):
        pass

Isso falha: self in @self é desconhecido

Eu também tentei:

@Test._decorator(self)

que também falha: Teste desconhecido

Gostaria de alterar temporariamente algumas variáveis ​​de instância no decorador e, em seguida, executar o método decorado, antes de alterá-las novamente.

Respostas:


268

Algo assim faria o que você precisa?

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

Isso evita que a chamada pessoal acesse o decorador e o deixa oculto no namespace da classe como um método regular.

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

editado para responder a pergunta nos comentários:

Como usar o decorador oculto em outra 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

Resultado:

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
O decorador ou a função decorada? Observe que a função "mágica" retornada que envolve a barra está recebendo uma variável variável acima quando "bar" é chamada em uma instância e pode fazer qualquer coisa com as variáveis ​​de instância que ela deseja antes e depois (ou mesmo se) ou não chamada "barra" . Não existem variáveis ​​de instância ao declarar a classe. Você queria fazer algo para a classe de dentro do decorador? Eu não acho que seja um uso idiomático.
22909 Michael Speer

1
Obrigado Michael, só agora vi que era isso que eu queria.
Hcvst

2
Acho essa solução muito melhor do que a resposta aceita, pois permite o uso da sintaxe @ decorator no ponto de definição. Se eu tiver que fazer chamadas de decorador no final da aula, não está claro se as funções estão sendo decoradas. É um pouco estranho que você não possa usar o @staticmethod no decorador, mas pelo menos funciona.
mgiuca

1
Eu não acho que funcione se eu criar uma classe herdada de Test.Por exemplo: class TestB (Test): @_decorator def foobar (self): print "adsf" Existe uma solução alternativa?
Extraeee

1
@extraeee: verifique a edição que fiz. você precisa qualificar o decorador dado como um staticmethod, mas só depois que você terminar de usá-lo (ou atribuir a versão staticmethod para um nome diferente)
Michael Speer

58

O que você está querendo fazer não é possível. Veja, por exemplo, se o código abaixo parece válido ou não:

class Test(object):

    def _decorator(self, foo):
        foo()

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

É claro que não é válido, pois selfnão está definido nesse momento. O mesmo vale Test, pois não será definido até que a própria classe seja definida (a qual está no processo de). Estou mostrando esse snippet de código, porque é nele que o snippet do decorador se transforma.

Portanto, como você pode ver, acessar a instância em um decorador como esse não é realmente possível, pois os decoradores são aplicados durante a definição de qualquer função / método ao qual estão anexados e não durante a instanciação.

Se você precisar de acesso em nível de classe , tente o seguinte:

class Test(object):

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

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

5
provavelmente deve ser atualizado para fazer referência a resposta mais precisa abaixo
Nathan Buesgens

1
Agradável. Sua prosa é impossível, mas seu código mostra como fazê-lo.
Mad Physicist

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: o objeto 'staticmethod' não pode ser
chamado

@wyx não ligue para o decorador. Por exemplo, deveria ser @foo, não@foo()
docyoda

Não deve o primeiro argumento para wrapperser self?
CpILL

7

Eu uso esse tipo de decorador em algumas situações de depuração, ele permite substituir as propriedades da classe decorando, sem precisar encontrar a função de chamada.

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

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

Aqui está o código do decorador

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: como usei um decorador de classe, você precisará usar @adecorator () com os colchetes para decorar funções, mesmo se você não passar nenhum argumento para o construtor de classes do decorador.


7

Esta é uma maneira de acessar (e ter usado) selfde dentro de um decoratordefinido dentro da mesma 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

Saída (testada em 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'

O exemplo acima é bobo, mas funciona.


4

Encontrei essa pergunta ao pesquisar um problema muito semelhante. Minha solução é dividir o problema em duas partes. Primeiro, você precisa capturar os dados que deseja associar aos métodos de classe. Nesse caso, handler_for associará um comando Unix ao manipulador para a saída desse 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

Agora que associamos alguns dados a cada método de classe, precisamos coletar esses dados e armazená-los em um atributo de classe.

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

4

Aqui está uma expansão da resposta de Michael Speer para dar alguns passos adiante:

Um decorador de método de instância que recebe argumentos e age em uma função com argumentos e um valor de retorno.

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 depois

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

Os decoradores parecem mais adequados para modificar a funcionalidade de um objeto inteiro (incluindo objetos de função) versus a funcionalidade de um método de objeto que, em geral, dependerá dos atributos da instância. Por exemplo:

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"

A saída é:

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

1

Você pode decorar o decorador:

import decorator

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

    @_decorator
    def bar(self):
        pass

1

Eu tenho uma implementação de decoradores que podem ajudar

    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

Declarar na classe interna. Esta solução é bastante sólida e recomendada.

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

O resultado:

>>> test = Test()
>>> test.bar()
start magic
normal call
end magic
>>> 
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.