Come posso creare due decoratori in Python per fare quanto segue?

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

... che dovrebbe restituire:

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

Non sto cercando di farlo HTMLin una vera applicazione, sto solo cercando di capire come funzionano i decoratori e il concatenamento dei decoratori.

Consulta la documentazione per vedere come funzionano i decoratori. Ecco cosa hai chiesto:

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>"

Se non ti piacciono le spiegazioni lunghe, vedi la risposta di Paolo Bergantino .

Nozioni di base sul decoratore

Le funzioni di Python sono oggetti

Per comprendere i decoratori, devi prima capire che le funzioni sono oggetti in Python. Ciò ha conseguenze importanti. Vediamo perché con un semplice esempio:

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!'

Tienilo a mente. Ci torneremo presto.

Un'altra proprietà interessante delle funzioni di Python è che possono essere definite all'interno di un'altra funzione!

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

Riferimenti di funzioni

Ok, sei ancora qui? Ora la parte divertente ...

Hai visto che le funzioni sono oggetti. Pertanto, funzioni:

• può essere assegnato a una variabile
• può essere definito in un'altra funzione

Ciò significa che una funzione può returnun'altra funzione .

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...

C'è più!

Se puoi returnuna funzione, puoi passarne una come parametro:

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!

Bene, hai solo tutto il necessario per capire i decoratori. Vedete, i decoratori sono "wrapper", il che significa che consentono di eseguire il codice prima e dopo la funzione che decorano senza modificare la funzione stessa.

Decoratori artigianali

Come lo faresti 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

Ora, probabilmente lo desideri ogni volta che chiami a_stand_alone_function, a_stand_alone_function_decoratedviene invece chiamato. È facile, basta sovrascrivere a_stand_alone_functioncon la funzione restituita da 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!

Decoratori demistificati

L'esempio precedente, usando la sintassi del decoratore:

@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

Sì, tutto qui, è così semplice. @decoratorè solo una scorciatoia per:

another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)

I decoratori sono solo una variante pitonica del modello di design del decoratore . Esistono diversi modelli di design classici incorporati in Python per facilitare lo sviluppo (come gli iteratori).

Certo, puoi accumulare decoratori:

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~
#<\______/>

Utilizzando la sintassi del decoratore Python:

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

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

L'ordine in cui imposti i decoratori QUESTIONI:

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

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

Ora: per rispondere alla domanda ...

In conclusione, puoi facilmente vedere come rispondere alla domanda:

# 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>

Ora puoi semplicemente andartene felice o bruciarti un po 'di più e vedere gli usi avanzati dei decoratori.

Portare i decoratori al livello successivo

Passando argomenti alla funzione decorata

# 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

Metodi di decorazione

Una cosa elegante di Python è che i metodi e le funzioni sono davvero gli stessi. L'unica differenza è che i metodi prevedono che il loro primo argomento sia un riferimento all'oggetto corrente ( self).

Ciò significa che puoi costruire un decoratore per i metodi allo stesso modo! Ricorda solo di prendere selfin considerazione:

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 stai realizzando un decoratore per tutti gli usi - uno che applicherai a qualsiasi funzione o metodo, indipendentemente dai suoi argomenti - quindi usa solo *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 argomenti al decoratore

Bene, ora cosa diresti sul passaggio degli argomenti al decoratore stesso?

Questo può essere in qualche modo distorto, dal momento che un decoratore deve accettare una funzione come argomento. Pertanto, non è possibile passare gli argomenti della funzione decorata direttamente al decoratore.

Prima di correre alla soluzione, scriviamo un piccolo promemoria:

# 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

È esattamente lo stesso. " my_decorator" si chiama. Quindi, quando stai @my_decoratordicendo a Python di chiamare la funzione 'etichettata dalla variabile " my_decorator"'.

Questo è importante! L'etichetta che dai può puntare direttamente al decoratore o no .

Diventiamo malvagi. ☺

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.

Nessuna sorpresa qui.

Facciamo ESATTAMENTE la stessa cosa, ma saltiamo tutte le fastidiose variabili intermedie:

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.

Rendiamolo ancora più breve :

@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.

Ehi, l'hai visto? Abbiamo usato una chiamata di funzione con la @sintassi " "! :-)

Quindi, torniamo ai decoratori con argomenti. Se possiamo usare le funzioni per generare il decoratore al volo, possiamo passare argomenti a quella funzione, giusto?

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: /programming/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

Eccolo: un decoratore con argomenti. Gli argomenti possono essere impostati come variabili:

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

Come puoi vedere, puoi passare argomenti al decoratore come qualsiasi funzione usando questo trucco. Puoi anche usarlo *args, **kwargsse lo desideri. Ma ricorda che i decoratori vengono chiamati solo una volta . Proprio quando Python importa lo script. Successivamente non è possibile impostare dinamicamente gli argomenti. Quando fai "import x", la funzione è già decorata , quindi non puoi cambiare nulla.

Esercitiamoci: decorare un decoratore

Bene, come bonus, ti darò uno snippet per fare in modo che ogni decoratore accetti genericamente qualsiasi argomento. Dopotutto, per accettare argomenti, abbiamo creato il nostro decoratore usando un'altra funzione.

Abbiamo avvolto il decoratore.

Qualcos'altro che abbiamo visto di recente che ha avvolto la funzione?

Oh sì, decoratori!

Divertiamoci e scriviamo un decoratore per i decoratori:

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

Può essere usato come segue:

# 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!

Lo so, l'ultima volta che hai avuto questa sensazione, è stato dopo aver ascoltato un ragazzo che diceva: "prima di capire la ricorsione, devi prima capire la ricorsione". Ma ora, non ti senti bene a padroneggiare questo?

Best practice: decoratori

• I decoratori sono stati introdotti in Python 2.4, quindi assicurati che il tuo codice verrà eseguito su> = 2.4.
• I decoratori rallentano la chiamata di funzione. Tienilo a mente.
• Non è possibile annullare la decorazione di una funzione. (Ci sono hack per creare decoratori che possono essere rimossi, ma nessuno li usa.) Quindi una volta che una funzione è decorata, è decorata per tutto il codice .
• Le funzioni di avvolgimento dei decoratori, che possono rendere difficile il debug. (Questo migliora da Python> = 2.5; vedi sotto.)

Il functoolsmodulo è stato introdotto in Python 2.5. Include la funzione functools.wraps(), che copia il nome, il modulo e il docstring della funzione decorata nel suo wrapper.

(Curiosità: functools.wraps()è un decoratore! ☺)

# 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

Come possono essere utili i decoratori?

Ora la grande domanda: per cosa posso usare i decoratori?

Sembra bello e potente, ma un esempio pratico sarebbe fantastico. Bene, ci sono 1000 possibilità. Gli usi classici estendono il comportamento di una funzione da una libreria esterna (non è possibile modificarla) o per il debug (non si desidera modificarla perché è temporanea).

Puoi usarli per estendere diverse funzioni in modo DRY, in questo modo:

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

Naturalmente il bello dei decoratori è che puoi usarli subito su quasi tutto senza riscrivere. SECCO, ho detto:

@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!

Python per sé fornisce diversi decoratori: property, staticmethod, etc.

• Django utilizza decoratori per gestire la memorizzazione nella cache e visualizzare le autorizzazioni.
• Contorto per fingere chiamate di funzioni asincrone inline.

Questo è davvero un grande parco giochi.

In alternativa, è possibile scrivere una funzione di fabbrica che restituisce un decoratore che avvolge il valore di ritorno della funzione decorata in un tag passato alla funzione di fabbrica. Per esempio:

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

Ciò ti consente di scrivere:

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

o

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

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

Personalmente avrei scritto il decoratore in modo leggermente diverso:

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

che produrrebbe:

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

Non dimenticare la costruzione per la quale la sintassi del decoratore è una scorciatoia:

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

Sembra che le altre persone ti abbiano già detto come risolvere il problema. Spero che questo ti aiuti a capire cosa sono i decoratori.

I decoratori sono solo zucchero sintattico.

Questo

@decorator
def func():
    ...

si espande a

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

E ovviamente puoi anche restituire lambda da una funzione di decorazione:

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

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

print say()

I decoratori Python aggiungono funzionalità extra ad un'altra funzione

Un decoratore in corsivo potrebbe essere come

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

Si noti che una funzione è definita all'interno di una funzione. Ciò che sostanzialmente fa è sostituire una funzione con quella appena definita. Ad esempio, ho questa classe

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

Ora dite, voglio che entrambe le funzioni stampino "---" dopo e prima che siano terminate. Potrei aggiungere una stampa "---" prima e dopo ogni dichiarazione di stampa. Ma poiché non mi piace ripetermi, farò un decoratore

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

Quindi ora posso cambiare la mia classe in

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

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

Per ulteriori informazioni sui decoratori, consultare http://www.ibm.com/developerworks/linux/library/l-cpdecor.html

Si potrebbe fare due decoratori separati che fare quello che vuoi, come illustrato direttamente sotto. Nota l'uso di *args, **kwargsnella dichiarazione della wrapped()funzione che supporta la funzione decorata con più argomenti (che non è realmente necessario per la say()funzione di esempio , ma è inclusa per la generalità).

Per motivi simili, il functools.wrapsdecoratore viene utilizzato per modificare i meta attributi della funzione incartata in quelli di quello decorato. Questo fa in modo che i messaggi di errore e la documentazione della funzione incorporata ( func.__doc__) siano quelli della funzione decorata anziché di wrapped()'s.

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>

perfezionamenti

Come puoi vedere c'è un sacco di codice duplicato in questi due decoratori. Data questa somiglianza, sarebbe meglio per te crearne uno generico che fosse in realtà una fabbrica di decoratori, in altre parole, una funzione di decoratore che rende altri decoratori. In questo modo ci sarebbe una minore ripetizione del codice e permetterebbe di seguire il principio DRY .

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>

Per rendere il codice più leggibile, puoi assegnare un nome più descrittivo ai decoratori generati dalla fabbrica:

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>

o anche combinarli in questo modo:

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>

Efficienza

Mentre gli esempi sopra funzionano tutti, il codice generato comporta una discreta quantità di costi generali sotto forma di chiamate di funzioni estranee quando vengono applicati più decoratori contemporaneamente. Questo potrebbe non avere importanza, a seconda dell'uso esatto (che potrebbe essere associato a I / O, ad esempio).

Se la velocità della funzione decorata è importante, l'overhead può essere mantenuto per una singola chiamata di funzione aggiuntiva scrivendo una funzione di fabbrica decoratore leggermente diversa che implementa l'aggiunta di tutti i tag in una volta, quindi può generare codice che evita le chiamate di funzione aggiuntiva sostenute usando decoratori separati per ogni etichetta.

Ciò richiede più codice nel decoratore stesso, ma questo viene eseguito solo quando viene applicato alle definizioni delle funzioni, non più tardi quando vengono chiamati loro stessi. Questo vale anche quando si creano nomi più leggibili usando le lambdafunzioni come precedentemente illustrato. Campione:

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>

Un altro modo di fare la stessa cosa:

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'

O, più flessibile:

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'

Come posso creare due decoratori in Python per fare quanto segue?

Si desidera la seguente funzione, quando chiamata:

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

Ritornare:

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

Soluzione semplice

Per fare semplicemente questo, crea decoratori che restituiscono lambda (funzioni anonime) che si chiudono sulla funzione (chiusure) e chiamala:

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

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

Ora usali come desiderato:

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

e adesso:

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

Problemi con la soluzione semplice

Ma sembra che abbiamo quasi perso la funzione originale.

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

Per trovarlo, avremmo bisogno di scavare nella chiusura di ogni lambda, uno dei quali è sepolto nell'altro:

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

Quindi, se mettiamo la documentazione su questa funzione, o vogliamo essere in grado di decorare funzioni che accettano più di un argomento, o volevamo solo sapere quale funzione stavamo guardando in una sessione di debug, dobbiamo fare un po 'di più con il nostro wrapper.

Soluzione completa: superare la maggior parte di questi problemi

Abbiamo il decoratore wrapsdal functoolsmodulo nella libreria standard!

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

È un peccato che ci sia ancora un po 'di scaldabagno, ma questo è semplice quanto possiamo farlo.

In Python 3, ottieni anche __qualname__e __annotations__assegnato per impostazione predefinita.

Così ora:

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

E adesso:

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

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

Conclusione

Quindi lo vediamo wraps fa sì la funzione wrapping faccia quasi tutto tranne che ci dica esattamente cosa accetta la funzione come argomenti.

Esistono altri moduli che potrebbero tentare di affrontare il problema, ma la soluzione non è ancora nella libreria standard.

Per spiegare il decoratore in modo semplice:

Con:

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

Quando fai:

func(*args, **kwargs)

Fai davvero:

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

Un decoratore accetta la definizione della funzione e crea una nuova funzione che esegue questa funzione e trasforma il risultato.

@deco
def do():
    ...

è equivalente a:

do = deco(do)

Esempio:

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

Questo

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

è equivalente a questo

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

Per capire il decoratore, è importante notare che il decoratore ha creato una nuova funzione interna che esegue la funzione e trasforma il risultato.

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

Puoi anche scrivere decoratore in 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")

Questa risposta è stata a lungo risposta, ma ho pensato di condividere la mia classe Decorator che rende la scrittura di nuovi decoratori facile e compatta.

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)

Per uno, penso che questo renda molto chiaro il comportamento dei decoratori, ma rende anche più semplice definire i nuovi decoratori in modo molto conciso. Per l'esempio sopra elencato, è possibile risolverlo come:

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"

Potresti anche usarlo per svolgere attività più complesse, come ad esempio un decoratore che rende automaticamente la funzione applicata in modo ricorsivo a tutti gli argomenti di un iteratore:

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

Che stampa:

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

Si noti che questo esempio non includeva il listtipo nell'istanza del decoratore, quindi nell'istruzione di stampa finale il metodo viene applicato all'elenco stesso, non agli elementi dell'elenco.

Ecco un semplice esempio di concatenatore di decoratori. Nota l'ultima riga: mostra cosa sta succedendo sotto le copertine.

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

L'output è simile a:

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

Parlando dell'esempio del contatore - come indicato sopra, il contatore sarà condiviso tra tutte le funzioni che usano il decoratore:

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

In questo modo, il decoratore può essere riutilizzato per funzioni diverse (o utilizzato per decorare la stessa funzione più volte:) func_counter1 = counter(func); func_counter2 = counter(func)e la variabile contatore rimarrà privata per ciascuna.

Decorare funzioni con diverso numero di argomenti:

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!')

Risultato:

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  

La risposta di Paolo Bergantino ha il grande vantaggio di usare solo lo stdlib e funziona per questo semplice esempio in cui non ci sono argomenti decoratori né funzioni decorate argomenti di .

Tuttavia ha 3 principali limitazioni se si desidera affrontare casi più generali:

• come già notato in diverse risposte, non è possibile modificare facilmente il codice per aggiungere argomenti di decorazione opzionali . Ad esempio creando unmakestyle(style='bold') decoratore non è banale.
• inoltre, i wrapper creati con @functools.wraps non conservano la firma , quindi se vengono forniti argomenti sbagliati, inizieranno l'esecuzione e potrebbero generare un diverso tipo di errore rispetto al solito TypeError.
• infine, è abbastanza difficile in involucri creati con @functools.wrapsper accedere a un argomento in base al suo nome . In effetti l'argomento può apparire in *args, in **kwargso potrebbe non apparire affatto (se è facoltativo).

Ho scritto decopatchper risolvere il primo numero e ho scritto per makefun.wrapsrisolvere gli altri due. Nota che makefunsfrutta lo stesso trucco del famosodecorator lib.

È così che creeresti un decoratore con argomenti, restituendo involucri che mantengono davvero la firma:

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

decopatchti offre altri due stili di sviluppo che nascondono o mostrano i vari concetti di Python, a seconda delle tue preferenze. Lo stile più compatto è il seguente:

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

In entrambi i casi puoi verificare che il decoratore funzioni come previsto:

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

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

Si prega di fare riferimento alla documentazione per i dettagli.