Como fazer uma corrente de decoradores de função?

StackOverflow https://stackoverflow.com/questions/739654

Pergunta

Como posso fazer dois decoradores em Python que iria fazer o seguinte? 

@makebold
@makeitalic
def say():
   return "Hello"

... que deve retornar: 

"<b><i>Hello</i></b>"

Eu não estou tentando fazer HTML desta forma em uma aplicação real -. Apenas tentando entender como decoradores e decorador encadeamento obras

Foi útil?

Solução

Confira a documentação para ver como decoradores trabalho. Aqui está o que você pediu: 

from functools import wraps

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<b>" + fn(*args, **kwargs) + "</b>"
    return wrapped

def makeitalic(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<i>" + fn(*args, **kwargs) + "</i>"
    return wrapped

@makebold
@makeitalic
def hello():
    return "hello world"

@makebold
@makeitalic
def log(s):
    return s

print hello()        # returns "<b><i>hello world</i></b>"
print hello.__name__ # with functools.wraps() this returns "hello"
print log('hello')   # returns "<b><i>hello</i></b>"

Outras dicas

Se você não estiver em longas explicações, consulte o Paolo Bergantino resposta .

Decorator Basics

funções do Python são objetos

Para entender decoradores, primeiro você precisa entender que as funções são objetos em Python. Isto tem consequências importantes. Vamos ver por que com um exemplo simples: 

def shout(word="yes"):
    return word.capitalize()+"!"

print(shout())
# outputs : 'Yes!'

# As an object, you can assign the function to a variable like any other object 
scream = shout

# Notice we don't use parentheses: we are not calling the function,
# we are putting the function "shout" into the variable "scream".
# It means you can then call "shout" from "scream":

print(scream())
# outputs : 'Yes!'

# More than that, it means you can remove the old name 'shout',
# and the function will still be accessible from 'scream'

del shout
try:
    print(shout())
except NameError as e:
    print(e)
    #outputs: "name 'shout' is not defined"

print(scream())
# outputs: 'Yes!'

Tenha isso em mente. Vamos circular de volta a ele em breve.

Outra propriedade interessante de funções Python é que pode ser definida dentro de outra função! 

def talk():

    # You can define a function on the fly in "talk" ...
    def whisper(word="yes"):
        return word.lower()+"..."

    # ... and use it right away!
    print(whisper())

# You call "talk", that defines "whisper" EVERY TIME you call it, then
# "whisper" is called in "talk". 
talk()
# outputs: 
# "yes..."

# But "whisper" DOES NOT EXIST outside "talk":

try:
    print(whisper())
except NameError as e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Funções referências

Ok, ainda está aqui? Agora a parte divertida ...

Você viu que as funções são objetos. Portanto, as funções de:

  • pode ser atribuído a uma variável
  • pode ser definido em outra função

Isso significa que a função pode return outra função . 

def getTalk(kind="shout"):

    # We define functions on the fly
    def shout(word="yes"):
        return word.capitalize()+"!"

    def whisper(word="yes") :
        return word.lower()+"...";

    # Then we return one of them
    if kind == "shout":
        # We don't use "()", we are not calling the function,
        # we are returning the function object
        return shout  
    else:
        return whisper

# How do you use this strange beast?

# Get the function and assign it to a variable
talk = getTalk()      

# You can see that "talk" is here a function object:
print(talk)
#outputs : <function shout at 0xb7ea817c>

# The object is the one returned by the function:
print(talk())
#outputs : Yes!

# And you can even use it directly if you feel wild:
print(getTalk("whisper")())
#outputs : yes...

Há mais!

Se você pode return uma função, você pode passar um como um parâmetro: 

def doSomethingBefore(func): 
    print("I do something before then I call the function you gave me")
    print(func())

doSomethingBefore(scream)
#outputs: 
#I do something before then I call the function you gave me
#Yes!

Bem, você só tem tudo o necessário para entender decoradores. Você vê, decoradores são “wrappers”, o que significa que que lhe permitem executar código antes e depois da função que decoram sem modificar a própria função.

Artesanais decoradores

Como você fazê-lo manualmente: 

# A decorator is a function that expects ANOTHER function as parameter
def my_shiny_new_decorator(a_function_to_decorate):

    # Inside, the decorator defines a function on the fly: the wrapper.
    # This function is going to be wrapped around the original function
    # so it can execute code before and after it.
    def the_wrapper_around_the_original_function():

        # Put here the code you want to be executed BEFORE the original function is called
        print("Before the function runs")

        # Call the function here (using parentheses)
        a_function_to_decorate()

        # Put here the code you want to be executed AFTER the original function is called
        print("After the function runs")

    # At this point, "a_function_to_decorate" HAS NEVER BEEN EXECUTED.
    # We return the wrapper function we have just created.
    # The wrapper contains the function and the code to execute before and after. It’s ready to use!
    return the_wrapper_around_the_original_function

# Now imagine you create a function you don't want to ever touch again.
def a_stand_alone_function():
    print("I am a stand alone function, don't you dare modify me")

a_stand_alone_function() 
#outputs: I am a stand alone function, don't you dare modify me

# Well, you can decorate it to extend its behavior.
# Just pass it to the decorator, it will wrap it dynamically in 
# any code you want and return you a new function ready to be used:

a_stand_alone_function_decorated = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function_decorated()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

Agora, você provavelmente quer que cada vez que você chamar a_stand_alone_function, a_stand_alone_function_decorated é chamado em seu lugar. Isso é fácil, basta a_stand_alone_function de substituição com a função retornada por my_shiny_new_decorator: 

a_stand_alone_function = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function()
#outputs:
#Before the function runs
#I am a stand alone function, don't you dare modify me
#After the function runs

# That’s EXACTLY what decorators do!

Decoradores desmistificada

O exemplo anterior, usando a sintaxe decorador: 

@my_shiny_new_decorator
def another_stand_alone_function():
    print("Leave me alone")

another_stand_alone_function()  
#outputs:  
#Before the function runs
#Leave me alone
#After the function runs

Sim, isso é tudo, é tão simples. @decorator é apenas um atalho para: 

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

Decoradores são apenas uma variante pythônico do decorador design padrão . Existem vários padrões de design clássico embutidos em Python para facilitar o desenvolvimento (como iteradores).

É claro, você pode acumular decoradores: 

def bread(func):
    def wrapper():
        print("</''''''\>")
        func()
        print("<\______/>")
    return wrapper

def ingredients(func):
    def wrapper():
        print("#tomatoes#")
        func()
        print("~salad~")
    return wrapper

def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs: --ham--
sandwich = bread(ingredients(sandwich))
sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

Usando a sintaxe decorador Python: 

@bread
@ingredients
def sandwich(food="--ham--"):
    print(food)

sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>

A fim de definir os decoradores matérias: 

@ingredients
@bread
def strange_sandwich(food="--ham--"):
    print(food)

strange_sandwich()
#outputs:
##tomatoes#
#</''''''\>
# --ham--
#<\______/>
# ~salad~

Agora: para responder à pergunta ...

Como conclusão, você pode facilmente ver como responder a pergunta: 

# The decorator to make it bold
def makebold(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<b>" + fn() + "</b>"
    return wrapper

# The decorator to make it italic
def makeitalic(fn):
    # The new function the decorator returns
    def wrapper():
        # Insertion of some code before and after
        return "<i>" + fn() + "</i>"
    return wrapper

@makebold
@makeitalic
def say():
    return "hello"

print(say())
#outputs: <b><i>hello</i></b>

# This is the exact equivalent to 
def say():
    return "hello"
say = makebold(makeitalic(say))

print(say())
#outputs: <b><i>hello</i></b>

Agora você pode simplesmente deixar feliz, ou queimar seu cérebro um pouco mais e ver os usos avançados de decoradores.

Tomando decoradores para o próximo nível

Passando argumentos para a função decorado 

# It’s not black magic, you just have to let the wrapper 
# pass the argument:

def a_decorator_passing_arguments(function_to_decorate):
    def a_wrapper_accepting_arguments(arg1, arg2):
        print("I got args! Look: {0}, {1}".format(arg1, arg2))
        function_to_decorate(arg1, arg2)
    return a_wrapper_accepting_arguments

# Since when you are calling the function returned by the decorator, you are
# calling the wrapper, passing arguments to the wrapper will let it pass them to 
# the decorated function

@a_decorator_passing_arguments
def print_full_name(first_name, last_name):
    print("My name is {0} {1}".format(first_name, last_name))

print_full_name("Peter", "Venkman")
# outputs:
#I got args! Look: Peter Venkman
#My name is Peter Venkman

métodos de decoração

Uma coisa bacana sobre Python é que os métodos e funções são a mesma coisa. A única diferença é que os métodos de esperar que o seu primeiro argumento é uma referência para o objeto atual (self).

Isso significa que você pode construir um decorador para os métodos da mesma maneira! Basta lembrar de tomar self em consideração: 

def method_friendly_decorator(method_to_decorate):
    def wrapper(self, lie):
        lie = lie - 3 # very friendly, decrease age even more :-)
        return method_to_decorate(self, lie)
    return wrapper


class Lucy(object):

    def __init__(self):
        self.age = 32

    @method_friendly_decorator
    def sayYourAge(self, lie):
        print("I am {0}, what did you think?".format(self.age + lie))

l = Lucy()
l.sayYourAge(-3)
#outputs: I am 26, what did you think?

Se você está fazendo de propósito geral decorador - um que você vai se aplicar a qualquer função ou método, não importa seus argumentos - então é só usar *args, **kwargs: 

def a_decorator_passing_arbitrary_arguments(function_to_decorate):
    # The wrapper accepts any arguments
    def a_wrapper_accepting_arbitrary_arguments(*args, **kwargs):
        print("Do I have args?:")
        print(args)
        print(kwargs)
        # Then you unpack the arguments, here *args, **kwargs
        # If you are not familiar with unpacking, check:
        # http://www.saltycrane.com/blog/2008/01/how-to-use-args-and-kwargs-in-python/
        function_to_decorate(*args, **kwargs)
    return a_wrapper_accepting_arbitrary_arguments

@a_decorator_passing_arbitrary_arguments
def function_with_no_argument():
    print("Python is cool, no argument here.")

function_with_no_argument()
#outputs
#Do I have args?:
#()
#{}
#Python is cool, no argument here.

@a_decorator_passing_arbitrary_arguments
def function_with_arguments(a, b, c):
    print(a, b, c)

function_with_arguments(1,2,3)
#outputs
#Do I have args?:
#(1, 2, 3)
#{}
#1 2 3 

@a_decorator_passing_arbitrary_arguments
def function_with_named_arguments(a, b, c, platypus="Why not ?"):
    print("Do {0}, {1} and {2} like platypus? {3}".format(a, b, c, platypus))

function_with_named_arguments("Bill", "Linus", "Steve", platypus="Indeed!")
#outputs
#Do I have args ? :
#('Bill', 'Linus', 'Steve')
#{'platypus': 'Indeed!'}
#Do Bill, Linus and Steve like platypus? Indeed!

class Mary(object):

    def __init__(self):
        self.age = 31

    @a_decorator_passing_arbitrary_arguments
    def sayYourAge(self, lie=-3): # You can now add a default value
        print("I am {0}, what did you think?".format(self.age + lie))

m = Mary()
m.sayYourAge()
#outputs
# Do I have args?:
#(<__main__.Mary object at 0xb7d303ac>,)
#{}
#I am 28, what did you think?

Passando argumentos para o decorador

Ótimo, agora o que você diria sobre passar argumentos para o próprio decorador?

Isso pode ficar um pouco torcido, uma vez que um decorador deve aceitar uma função como um argumento. Portanto, você não pode passar argumentos da função decorado diretamente para o decorador.

Antes de correr para a solução, vamos escrever um pequeno lembrete: 

# Decorators are ORDINARY functions
def my_decorator(func):
    print("I am an ordinary function")
    def wrapper():
        print("I am function returned by the decorator")
        func()
    return wrapper

# Therefore, you can call it without any "@"

def lazy_function():
    print("zzzzzzzz")

decorated_function = my_decorator(lazy_function)
#outputs: I am an ordinary function

# It outputs "I am an ordinary function", because that’s just what you do:
# calling a function. Nothing magic.

@my_decorator
def lazy_function():
    print("zzzzzzzz")

#outputs: I am an ordinary function

É exatamente o mesmo. "my_decorator" é chamado. Então, quando você @my_decorator, você está dizendo Python para chamar a função 'rotulado pela variável "my_decorator "'.

Isto é importante! A etiqueta que você dá pode apontar diretamente para o decorator- ou não .

Vamos get mal. ? 

def decorator_maker():

    print("I make decorators! I am executed only once: "
          "when you make me create a decorator.")

    def my_decorator(func):

        print("I am a decorator! I am executed only when you decorate a function.")

        def wrapped():
            print("I am the wrapper around the decorated function. "
                  "I am called when you call the decorated function. "
                  "As the wrapper, I return the RESULT of the decorated function.")
            return func()

        print("As the decorator, I return the wrapped function.")

        return wrapped

    print("As a decorator maker, I return a decorator")
    return my_decorator

# Let’s create a decorator. It’s just a new function after all.
new_decorator = decorator_maker()       
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator

# Then we decorate the function

def decorated_function():
    print("I am the decorated function.")

decorated_function = new_decorator(decorated_function)
#outputs:
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function

# Let’s call the function:
decorated_function()
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Nenhuma surpresa aqui.

Vamos fazer exatamente a mesma coisa, mas ignorar todas as variáveis ??intermediárias traquinas: 

def decorated_function():
    print("I am the decorated function.")
decorated_function = decorator_maker()(decorated_function)
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

# Finally:
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Vamos make it ainda mais curto : 

@decorator_maker()
def decorated_function():
    print("I am the decorated function.")
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function.

#Eventually: 
decorated_function()    
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.

Ei, você viu isso? Nós usamos uma chamada de função com a sintaxe "@"! : -)

Então, de volta para decoradores com argumentos. Se podemos usar funções para gerar o decorador na mosca, podemos passar argumentos para essa função, certo? 

def decorator_maker_with_arguments(decorator_arg1, decorator_arg2):

    print("I make decorators! And I accept arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

    def my_decorator(func):
        # The ability to pass arguments here is a gift from closures.
        # If you are not comfortable with closures, you can assume it’s ok,
        # or read: https://stackoverflow.com/questions/13857/can-you-explain-closures-as-they-relate-to-python
        print("I am the decorator. Somehow you passed me arguments: {0}, {1}".format(decorator_arg1, decorator_arg2))

        # Don't confuse decorator arguments and function arguments!
        def wrapped(function_arg1, function_arg2) :
            print("I am the wrapper around the decorated function.\n"
                  "I can access all the variables\n"
                  "\t- from the decorator: {0} {1}\n"
                  "\t- from the function call: {2} {3}\n"
                  "Then I can pass them to the decorated function"
                  .format(decorator_arg1, decorator_arg2,
                          function_arg1, function_arg2))
            return func(function_arg1, function_arg2)

        return wrapped

    return my_decorator

@decorator_maker_with_arguments("Leonard", "Sheldon")
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments: {0}"
           " {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments("Rajesh", "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Sheldon
#I am the decorator. Somehow you passed me arguments: Leonard Sheldon
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Sheldon 
#   - from the function call: Rajesh Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only knows about my arguments: Rajesh Howard

Aqui está: um decorador com argumentos. Os argumentos podem ser definidos como variável: 

c1 = "Penny"
c2 = "Leslie"

@decorator_maker_with_arguments("Leonard", c1)
def decorated_function_with_arguments(function_arg1, function_arg2):
    print("I am the decorated function and only knows about my arguments:"
           " {0} {1}".format(function_arg1, function_arg2))

decorated_function_with_arguments(c2, "Howard")
#outputs:
#I make decorators! And I accept arguments: Leonard Penny
#I am the decorator. Somehow you passed me arguments: Leonard Penny
#I am the wrapper around the decorated function. 
#I can access all the variables 
#   - from the decorator: Leonard Penny 
#   - from the function call: Leslie Howard 
#Then I can pass them to the decorated function
#I am the decorated function and only know about my arguments: Leslie Howard

Como você pode ver, você pode passar argumentos para o decorador como qualquer função usando este truque. Você ainda pode usar *args, **kwargs se desejar. Mas lembre-se decoradores são chamados apenas uma vez . Apenas quando Python importa o script. Você não pode definir dinamicamente os argumentos depois. Quando você faz "import x", a função já está decorado , então você não pode mudar nada.

Vamos prática: decorar um decorador

Ok, como um bônus, eu vou dar-lhe um trecho de fazer qualquer decorador aceitar genericamente qualquer argumento. Afinal de contas, a fim de aceitar argumentos, criamos nosso decorador usando uma outra função.

Nós envolvemos o decorador.

Qualquer outra coisa que vimos recentemente que a função embrulhada?

Oh sim, decoradores!

Vamos nos divertir um pouco e escrever um decorador para os decoradores: 

def decorator_with_args(decorator_to_enhance):
    """ 
    This function is supposed to be used as a decorator.
    It must decorate an other function, that is intended to be used as a decorator.
    Take a cup of coffee.
    It will allow any decorator to accept an arbitrary number of arguments,
    saving you the headache to remember how to do that every time.
    """

    # We use the same trick we did to pass arguments
    def decorator_maker(*args, **kwargs):

        # We create on the fly a decorator that accepts only a function
        # but keeps the passed arguments from the maker.
        def decorator_wrapper(func):

            # We return the result of the original decorator, which, after all, 
            # IS JUST AN ORDINARY FUNCTION (which returns a function).
            # Only pitfall: the decorator must have this specific signature or it won't work:
            return decorator_to_enhance(func, *args, **kwargs)

        return decorator_wrapper

    return decorator_maker

Ele pode ser usado da seguinte maneira: 

# You create the function you will use as a decorator. And stick a decorator on it :-)
# Don't forget, the signature is "decorator(func, *args, **kwargs)"
@decorator_with_args 
def decorated_decorator(func, *args, **kwargs): 
    def wrapper(function_arg1, function_arg2):
        print("Decorated with {0} {1}".format(args, kwargs))
        return func(function_arg1, function_arg2)
    return wrapper

# Then you decorate the functions you wish with your brand new decorated decorator.

@decorated_decorator(42, 404, 1024)
def decorated_function(function_arg1, function_arg2):
    print("Hello {0} {1}".format(function_arg1, function_arg2))

decorated_function("Universe and", "everything")
#outputs:
#Decorated with (42, 404, 1024) {}
#Hello Universe and everything

# Whoooot!

Eu sei, a última vez que tive essa sensação, foi depois de ouvir um cara dizendo: "antes de recursão compreensão, você deve primeiro entender a recursão". Mas agora, você não se sentir bem sobre a dominar isso?

Melhores práticas: decoradores

  • decoradores foram introduzidos no Python 2.4, por isso não deixe o seu código será executado em> = 2,4.
  • Decoradores abrandar a chamada de função. Tenha isso em mente.
  • Você não pode un-decorar uma função. (Não são hacks para criar decoradores que podem ser removidos, mas ninguém usa-los.) Então, quando uma função é decorado, é decorado para todo o código .
  • funções envoltório decoradores, que podem torná-los difíceis de depurar. (Isso fica melhor a partir de Python> = 2,5; ver abaixo).

O módulo functools foi introduzido no pitão 2,5. Ele inclui o functools.wraps() função, que copia o nome, módulo, e DocString da função decorado ao seu invólucro.

(Curiosidade:! functools.wraps() é um decorador ?) 

# For debugging, the stacktrace prints you the function __name__
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

# With a decorator, it gets messy    
def bar(func):
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: wrapper

# "functools" can help for that

import functools

def bar(func):
    # We say that "wrapper", is wrapping "func"
    # and the magic begins
    @functools.wraps(func)
    def wrapper():
        print("bar")
        return func()
    return wrapper

@bar
def foo():
    print("foo")

print(foo.__name__)
#outputs: foo

Como podem os decoradores ser útil?

Agora, a grande pergunta: O que eu posso usar decoradores para?

Parece legal e poderoso, mas um exemplo prático seria ótimo. Bem, há 1000 possibilidades. usos clássicos estão estendendo um comportamento função de uma lib externo (você não pode modificá-lo), ou para a depuração (você não quer modificá-lo porque é temporário).

Você pode usá-los para estender várias funções na forma de um DRY, assim: 

def benchmark(func):
    """
    A decorator that prints the time a function takes
    to execute.
    """
    import time
    def wrapper(*args, **kwargs):
        t = time.clock()
        res = func(*args, **kwargs)
        print("{0} {1}".format(func.__name__, time.clock()-t))
        return res
    return wrapper


def logging(func):
    """
    A decorator that logs the activity of the script.
    (it actually just prints it, but it could be logging!)
    """
    def wrapper(*args, **kwargs):
        res = func(*args, **kwargs)
        print("{0} {1} {2}".format(func.__name__, args, kwargs))
        return res
    return wrapper


def counter(func):
    """
    A decorator that counts and prints the number of times a function has been executed
    """
    def wrapper(*args, **kwargs):
        wrapper.count = wrapper.count + 1
        res = func(*args, **kwargs)
        print("{0} has been used: {1}x".format(func.__name__, wrapper.count))
        return res
    wrapper.count = 0
    return wrapper

@counter
@benchmark
@logging
def reverse_string(string):
    return str(reversed(string))

print(reverse_string("Able was I ere I saw Elba"))
print(reverse_string("A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!"))

#outputs:
#reverse_string ('Able was I ere I saw Elba',) {}
#wrapper 0.0
#wrapper has been used: 1x 
#ablE was I ere I saw elbA
#reverse_string ('A man, a plan, a canoe, pasta, heros, rajahs, a coloratura, maps, snipe, percale, macaroni, a gag, a banana bag, a tan, a tag, a banana bag again (or a camel), a crepe, pins, Spam, a rut, a Rolo, cash, a jar, sore hats, a peon, a canal: Panama!',) {}
#wrapper 0.0
#wrapper has been used: 2x
#!amanaP :lanac a ,noep a ,stah eros ,raj a ,hsac ,oloR a ,tur a ,mapS ,snip ,eperc a ,)lemac a ro( niaga gab ananab a ,gat a ,nat a ,gab ananab a ,gag a ,inoracam ,elacrep ,epins ,spam ,arutaroloc a ,shajar ,soreh ,atsap ,eonac a ,nalp a ,nam A

Claro que a coisa boa com decoradores é que você pode usá-los imediatamente em quase qualquer coisa sem reescrever. DRY, eu disse: 

@counter
@benchmark
@logging
def get_random_futurama_quote():
    from urllib import urlopen
    result = urlopen("http://subfusion.net/cgi-bin/quote.pl?quote=futurama").read()
    try:
        value = result.split("<br><b><hr><br>")[1].split("<br><br><hr>")[0]
        return value.strip()
    except:
        return "No, I'm ... doesn't!"


print(get_random_futurama_quote())
print(get_random_futurama_quote())

#outputs:
#get_random_futurama_quote () {}
#wrapper 0.02
#wrapper has been used: 1x
#The laws of science be a harsh mistress.
#get_random_futurama_quote () {}
#wrapper 0.01
#wrapper has been used: 2x
#Curse you, merciful Poseidon!

próprio Python fornece vários decoradores: property, staticmethod, etc.

  • Django usa decoradores para gerenciar cache e visualizar permissões.
  • trançado de falsificar inlining funções assíncronas chamadas.

Este é realmente um grande parque infantil.

Como alternativa, você poderia escrever uma função de fábrica que retornar um decorador que envolve o valor de retorno da função decorado com um tag passado para a função de fábrica. Por exemplo: 

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator():
            return '<%(tag)s>%(rv)s</%(tag)s>' % (
                {'tag': tag, 'rv': func()})
        return decorator
    return factory

Isso permite que você escreve: 

@wrap_in_tag('b')
@wrap_in_tag('i')
def say():
    return 'hello'

ou 

makebold = wrap_in_tag('b')
makeitalic = wrap_in_tag('i')

@makebold
@makeitalic
def say():
    return 'hello'

Pessoalmente, eu teria escrito o decorador um pouco diferente: 

from functools import wraps

def wrap_in_tag(tag):
    def factory(func):
        @wraps(func)
        def decorator(val):
            return func('<%(tag)s>%(val)s</%(tag)s>' %
                        {'tag': tag, 'val': val})
        return decorator
    return factory

que renderia: 

@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
    return val
say('hello')

Não se esqueça da construção para o qual a sintaxe de decorador é um atalho: 

say = wrap_in_tag('b')(wrap_in_tag('i')(say)))

Parece que as outras pessoas já lhe disse como resolver o problema. Espero que isso irá ajudá-lo a entender o que decoradores são.

Decoradores são açúcar apenas sintática.

Este 

@decorator
def func():
    ...

expande para 

def func():
    ...
func = decorator(func)

E, claro, você pode retornar lambdas bem de uma função decorador: 

def makebold(f): 
    return lambda: "<b>" + f() + "</b>"
def makeitalic(f): 
    return lambda: "<i>" + f() + "</i>"

@makebold
@makeitalic
def say():
    return "Hello"

print say()

decoradores Python adicionar funcionalidades extras para outra função

Um itálico decorador poderia ser como 

def makeitalic(fn):
    def newFunc():
        return "<i>" + fn() + "</i>"
    return newFunc

Note que uma função é definida dentro de uma função. O que basicamente faz é substituir uma função com o recém-definido. Por exemplo, eu tenho essa classe 

class foo:
    def bar(self):
        print "hi"
    def foobar(self):
        print "hi again"

Agora, digamos, eu quero as duas funções para imprimir "---" antes e depois que eles são feitos. Eu poderia adicionar uma impressão "---" antes e após cada declaração de impressão. Mas porque eu não gosto de me repetir, vou fazer um decorador 

def addDashes(fn): # notice it takes a function as an argument
    def newFunction(self): # define a new function
        print "---"
        fn(self) # call the original function
        print "---"
    return newFunction
    # Return the newly defined function - it will "replace" the original

Então agora eu posso mudar minha classe para 

class foo:
    @addDashes
    def bar(self):
        print "hi"

    @addDashes
    def foobar(self):
        print "hi again"

Para saber mais sobre decoradores, cheque http://www.ibm.com/developerworks/linux/library/l -cpdecor.html

Você pode fazer dois decoradores separadas que fazer o que quiser, como ilustrado logo abaixo. Observe o uso de *args, **kwargs na declaração da função wrapped() que suporta a função decorado com vários argumentos (que não é realmente necessário para a função exemplo say(), mas está incluído para generalidade).

Por razões semelhantes, o decorador functools.wraps é usado para alterar os atributos meta da função envolto a ser aqueles de quem está sendo decorado. Isso faz com que mensagens de erro e documentação função incorporada (func.__doc__) ser aqueles da função decorado em vez de wrapped() do. 

from functools import wraps

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<b>" + fn(*args, **kwargs) + "</b>"
    return wrapped

def makeitalic(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return "<i>" + fn(*args, **kwargs) + "</i>"
    return wrapped

@makebold
@makeitalic
def say():
    return 'Hello'

print(say())  # -> <b><i>Hello</i></b>

refinamentos

Como você pode ver, há um monte de código duplicado nestes dois decoradores. Dada essa semelhança seria melhor para você, em vez fazer um genérico que era na verdade um fábrica decorador em outras palavras, um decorador que faz com que outros decoradores. Dessa forma, haveria menos código de repetição e permitir que o princípio da DRY a ser seguido. 

def html_deco(tag):
    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return '<%s>' % tag + fn(*args, **kwargs) + '</%s>' % tag
        return wrapped
    return decorator

@html_deco('b')
@html_deco('i')
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

Para tornar o código mais legível, você pode atribuir um nome mais descritivo para os decoradores gerado pela fábrica: 

makebold = html_deco('b')
makeitalic = html_deco('i')

@makebold
@makeitalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

ou mesmo combiná-los como este: 

makebolditalic = lambda fn: makebold(makeitalic(fn))

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

Eficiência

Embora os exemplos acima fazem todo o trabalho, o código gerado envolve uma certa quantidade de sobrecarga na forma de chamadas de funções estranhas quando vários decoradores são aplicadas ao mesmo tempo. Isto pode não importa, dependendo do uso exato (que pode ser I /, por exemplo ligada-O).

Se a velocidade da função decorado é importante, a sobrecarga pode ser mantido a uma única chamada de função extra escrevendo uma fábrica de função decorador ligeiramente diferente que implementa a adição de todas as marcas de uma só vez, por isso pode gerar o código que evita o addtional chamadas de funções inerentes à utilização de decoradores separadas para cada tag.

Isto requer mais código no próprio decorador, mas isso só funciona quando está sendo aplicada a definições de funções, não mais tarde, quando eles mesmos são chamados. Isto também se aplica ao criar nomes mais legíveis usando funções lambda como ilustrado anteriormente. Amostra: 

def multi_html_deco(*tags):
    start_tags, end_tags = [], []
    for tag in tags:
        start_tags.append('<%s>' % tag)
        end_tags.append('</%s>' % tag)
    start_tags = ''.join(start_tags)
    end_tags = ''.join(reversed(end_tags))

    def decorator(fn):
        @wraps(fn)
        def wrapped(*args, **kwargs):
            return start_tags + fn(*args, **kwargs) + end_tags
        return wrapped
    return decorator

makebolditalic = multi_html_deco('b', 'i')

@makebolditalic
def greet(whom=''):
    return 'Hello' + (' ' + whom) if whom else ''

print(greet('world'))  # -> <b><i>Hello world</i></b>

Outra maneira de fazer a mesma coisa: 

class bol(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<b>{}</b>".format(self.f())

class ita(object):
  def __init__(self, f):
    self.f = f
  def __call__(self):
    return "<i>{}</i>".format(self.f())

@bol
@ita
def sayhi():
  return 'hi'

Ou, de forma mais flexível: 

class sty(object):
  def __init__(self, tag):
    self.tag = tag
  def __call__(self, f):
    def newf():
      return "<{tag}>{res}</{tag}>".format(res=f(), tag=self.tag)
    return newf

@sty('b')
@sty('i')
def sayhi():
  return 'hi'

Como posso fazer dois decoradores em Python que iria fazer o seguinte?

Você quer que a função seguinte, quando chamado: 

@makebold
@makeitalic
def say():
    return "Hello"

Para retornar: 

<b><i>Hello</i></b>

Uma solução simples

Para a maioria simplesmente fazer isso, faça decoradores que lambdas de retorno (funções anônimas) que apertada sobre a função (fechamentos) e chamá-lo: 

def makeitalic(fn):
    return lambda: '<i>' + fn() + '</i>'

def makebold(fn):
    return lambda: '<b>' + fn() + '</b>'

Agora, usá-los como desejado: 

@makebold
@makeitalic
def say():
    return 'Hello'

e agora: 

>>> say()
'<b><i>Hello</i></b>'

Problemas com a solução simples

Mas parece que temos quase perdeu a função original. 

>>> say
<function <lambda> at 0x4ACFA070>

Para encontrá-lo, tínhamos necessidade de escavar o encerramento de cada lambda, um dos quais é enterrado em outro: 

>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>

Então, se colocarmos documentação sobre esta função, ou queria ser capaz de decorar funções que recebem mais de um argumento, ou nós só queria saber qual a função que estávamos olhando em uma sessão de depuração, o que precisamos fazer um pouco mais com a nossa wrapper.

solução caracterizada cheia - superando a maioria destes problemas

Temos a wraps decorador do módulo functools na biblioteca padrão! 

from functools import wraps

def makeitalic(fn):
    # must assign/update attributes from wrapped function to wrapper
    # __module__, __name__, __doc__, and __dict__ by default
    @wraps(fn) # explicitly give function whose attributes it is applying
    def wrapped(*args, **kwargs):
        return '<i>' + fn(*args, **kwargs) + '</i>'
    return wrapped

def makebold(fn):
    @wraps(fn)
    def wrapped(*args, **kwargs):
        return '<b>' + fn(*args, **kwargs) + '</b>'
    return wrapped

É lamentável que ainda há algum clichê, mas isso é tão simples quanto nós podemos fazer isso.

Em Python 3, você também terá __qualname__ e __annotations__ atribuído por padrão.

Então agora: 

@makebold
@makeitalic
def say():
    """This function returns a bolded, italicized 'hello'"""
    return 'Hello'

E agora: 

>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:

say(*args, **kwargs)
    This function returns a bolded, italicized 'hello'

Conclusão

Assim, vemos que wraps faz a função de embrulho fazer quase tudo, exceto nos dizer exatamente o que a função toma como argumentos.

Existem outros módulos que podem tentar resolver o problema, mas a solução ainda não está na biblioteca padrão.

Um decorador leva a definição da função e cria uma nova função que executa esta função e transforma o resultado. 

@deco
def do():
    ...

é eqivarent a: 

do = deco(do)

Exemplo: 

def deco(func):
    def inner(letter):
        return func(letter).upper()  #upper
    return inner

Este 

@deco
def do(number):
    return chr(number)  # number to letter

é eqivalent a este def DO2 (número): retorno chr (número) 

do2 = deco(do2)

65 <=> 'a' 

print(do(65))
print(do2(65))
>>> B
>>> B

Para entender o decorador, é importante notar, que decorador criou uma nova função de fazer o que é interior que executa func e transforma o resultado.

Para explicar decorador de uma forma mais simples:

Com: 

@decor1
@decor2
def func(*args, **kwargs):
    pass

Quando fazer: 

func(*args, **kwargs)

Você realmente fazer: 

decor1(decor2(func))(*args, **kwargs)

#decorator.py
def makeHtmlTag(tag, *args, **kwds):
    def real_decorator(fn):
        css_class = " class='{0}'".format(kwds["css_class"]) \
                                 if "css_class" in kwds else ""
        def wrapped(*args, **kwds):
            return "<"+tag+css_class+">" + fn(*args, **kwds) + "</"+tag+">"
        return wrapped
    # return decorator dont call it
    return real_decorator

@makeHtmlTag(tag="b", css_class="bold_css")
@makeHtmlTag(tag="i", css_class="italic_css")
def hello():
    return "hello world"

print hello()

Você também pode escrever decorador na classe 

#class.py
class makeHtmlTagClass(object):
    def __init__(self, tag, css_class=""):
        self._tag = tag
        self._css_class = " class='{0}'".format(css_class) \
                                       if css_class != "" else ""

    def __call__(self, fn):
        def wrapped(*args, **kwargs):
            return "<" + self._tag + self._css_class+">"  \
                       + fn(*args, **kwargs) + "</" + self._tag + ">"
        return wrapped

@makeHtmlTagClass(tag="b", css_class="bold_css")
@makeHtmlTagClass(tag="i", css_class="italic_css")
def hello(name):
    return "Hello, {}".format(name)

print hello("Your name")

Aqui está um exemplo simples de encadeamento decoradores. Observe a última linha -. Ele mostra o que está acontecendo debaixo das cobertas 

############################################################
#
#    decorators
#
############################################################

def bold(fn):
    def decorate():
        # surround with bold tags before calling original function
        return "<b>" + fn() + "</b>"
    return decorate


def uk(fn):
    def decorate():
        # swap month and day
        fields = fn().split('/')
        date = fields[1] + "/" + fields[0] + "/" + fields[2]
        return date
    return decorate

import datetime
def getDate():
    now = datetime.datetime.now()
    return "%d/%d/%d" % (now.day, now.month, now.year)

@bold
def getBoldDate(): 
    return getDate()

@uk
def getUkDate():
    return getDate()

@bold
@uk
def getBoldUkDate():
    return getDate()


print getDate()
print getBoldDate()
print getUkDate()
print getBoldUkDate()
# what is happening under the covers
print bold(uk(getDate))()

Os olhares de saída como: 

17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>

Esta resposta tem sido respondida, mas eu pensei que eu iria partilhar a minha classe Decorator que faz escrever novos decoradores fácil e compacto. 

from abc import ABCMeta, abstractclassmethod

class Decorator(metaclass=ABCMeta):
    """ Acts as a base class for all decorators """

    def __init__(self):
        self.method = None

    def __call__(self, method):
        self.method = method
        return self.call

    @abstractclassmethod
    def call(self, *args, **kwargs):
        return self.method(*args, **kwargs)

Por um lado eu acho que isso faz com que o comportamento dos decoradores muito claras, mas também torna mais fácil definir novos decoradores muito concisa. Para o exemplo listado acima, você poderia, então, resolvê-lo como: 

class MakeBold(Decorator):
    def call():
        return "<b>" + self.method() + "</b>"

class MakeItalic(Decorator):
    def call():
        return "<i>" + self.method() + "</i>"

@MakeBold()
@MakeItalic()
def say():
   return "Hello"

Você também pode usá-lo para realizar tarefas mais complexas, como, por exemplo, um decorador que faz automaticamente a função get aplicado recursivamente a todos os argumentos em um iterador: 

class ApplyRecursive(Decorator):
    def __init__(self, *types):
        super().__init__()
        if not len(types):
            types = (dict, list, tuple, set)
        self._types = types

    def call(self, arg):
        if dict in self._types and isinstance(arg, dict):
            return {key: self.call(value) for key, value in arg.items()}

        if set in self._types and isinstance(arg, set):
            return set(self.call(value) for value in arg)

        if tuple in self._types and isinstance(arg, tuple):
            return tuple(self.call(value) for value in arg)

        if list in self._types and isinstance(arg, list):
            return list(self.call(value) for value in arg)

        return self.method(arg)


@ApplyRecursive(tuple, set, dict)
def double(arg):
    return 2*arg

print(double(1))
print(double({'a': 1, 'b': 2}))
print(double({1, 2, 3}))
print(double((1, 2, 3, 4)))
print(double([1, 2, 3, 4, 5]))

Que impressões: 

2
{'a': 2, 'b': 4}
{2, 4, 6}
(2, 4, 6, 8)
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]

Observe que este exemplo não inclui o tipo list na instanciação do decorador, por isso, na declaração impressão final o método é aplicado à lista em si, não os elementos da lista.

Falando do contra-exemplo - como dado acima, o contador será compartilhado entre todas as funções que usam o decorador: 

def counter(func):
    def wrapped(*args, **kws):
        print 'Called #%i' % wrapped.count
        wrapped.count += 1
        return func(*args, **kws)
    wrapped.count = 0
    return wrapped

Dessa forma, seu decorador pode ser reutilizado para diferentes funções (ou usado para decorar a mesma função várias vezes: func_counter1 = counter(func); func_counter2 = counter(func)), e a variável do contador permanecerá privada para cada um.

Decore funções com diferentes números de argumentos: 

def frame_tests(fn):
    def wrapper(*args):
        print "\nStart: %s" %(fn.__name__)
        fn(*args)
        print "End: %s\n" %(fn.__name__)
    return wrapper

@frame_tests
def test_fn1():
    print "This is only a test!"

@frame_tests
def test_fn2(s1):
    print "This is only a test! %s" %(s1)

@frame_tests
def test_fn3(s1, s2):
    print "This is only a test! %s %s" %(s1, s2)

if __name__ == "__main__":
    test_fn1()
    test_fn2('OK!')
    test_fn3('OK!', 'Just a test!')

Resultado: 

Start: test_fn1  
This is only a test!  
End: test_fn1  


Start: test_fn2  
This is only a test! OK!  
End: test_fn2  


Start: test_fn3  
This is only a test! OK! Just a test!  
End: test_fn3
A resposta de

Paolo Bergantino tem a grande vantagem de usar apenas o stdlib, e trabalha para este exemplo simples, onde não existam decorador argumentos nem função decorado argumentos.

No entanto, tem 3 grandes limitações se você quiser resolver os casos mais gerais:

  • como já observado em diversas respostas, você não pode facilmente modificar o código para adicionar argumentos decorador opcionais . Por exemplo criando um decorador makestyle(style='bold') não é trivial.
  • Além disso, embalagens criadas com @functools.wraps não preservam a assinatura , por isso, se são fornecidos maus argumentos eles vão começar a executar, e pode levantar um tipo diferente de erro que o TypeError habitual.
  • Finalmente, é bastante difícil em embalagens criadas com @functools.wraps para Acesso um argumento baseado em seu nome . Na verdade, o argumento pode aparecer em *args, em **kwargs, ou pode não aparecer em tudo (se é opcional).

Eu escrevi decopatch para resolver o primeiro problema, e escreveu makefun.wraps para resolver os outros dois. Note-se que makefun utiliza o mesmo truque que o famoso decorator lib.

Isto é como você criaria um decorador com argumentos, retornando wrappers verdadeiramente preservação de assinatura: 

from decopatch import function_decorator, DECORATED
from makefun import wraps

@function_decorator
def makestyle(st='b', fn=DECORATED):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st

    @wraps(fn)
    def wrapped(*args, **kwargs):
        return open_tag + fn(*args, **kwargs) + close_tag

    return wrapped

decopatch fornece-lhe com outros dois estilos de desenvolvimento que ocultar ou mostrar os diversos conceitos python, dependendo das suas preferências. O estilo mais compacto é o seguinte: 

from decopatch import function_decorator, WRAPPED, F_ARGS, F_KWARGS

@function_decorator
def makestyle(st='b', fn=WRAPPED, f_args=F_ARGS, f_kwargs=F_KWARGS):
    open_tag = "<%s>" % st
    close_tag = "</%s>" % st
    return open_tag + fn(*f_args, **f_kwargs) + close_tag

Em ambos os casos, você pode verificar que o decorador funciona como esperado: 

@makestyle
@makestyle('i')
def hello(who):
    return "hello %s" % who

assert hello('world') == '<b><i>hello world</i></b>'

Por favor, consulte o documentação para mais detalhes.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top