Come fare una catena di funzione decoratori?
-
09-09-2019 - |
Domanda
Come posso fare in due decoratori in Python che vorresti effettuare le seguenti operazioni?
@makebold
@makeitalic
def say():
return "Hello"
...che dovrebbe riportare:
"<b><i>Hello</i></b>"
Non sto cercando di fare HTML
in questo modo in un'applicazione reale - solo cercando di capire come decoratori e decoratore di concatenamento opere.
Soluzione
il documentazione per vedere come funzionano decoratori. Ecco cosa avete 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>"
Altri suggerimenti
Se non siete in lunghe spiegazioni, vedere Paolo Bergantino risposta.
Decoratore Nozioni Di Base
Python funzioni sono oggetti
Per capire decoratori, è necessario prima capire che le funzioni sono oggetti in Python.Questo ha importanti conseguenze.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!'
Tenere questo in mente.Staremo a cerchio con poco.
Un'altra interessante proprietà di funzioni Python è che può essere definita 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
Funzioni riferimenti
Ok, ancora qui?Ora la parte divertente...
Hai visto che le funzioni sono oggetti.Pertanto, le funzioni di:
- può essere assegnato a una variabile
- può essere definito in un'altra funzione
Il che significa che una funzione può return
un'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'è di più!
Se è possibile return
una funzione, è possibile passare 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!
Beh, basta avere tutto il necessario per capire decoratori.Vedete, decoratori sono “wrapper”, il che significa che essi consentono di eseguire codice prima e dopo la funzione decorare senza modificare la funzione stessa.
Artigianali decoratori
Come vuoi farlo 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 si desidera che ogni volta che si chiama a_stand_alone_function
, a_stand_alone_function_decorated
si chiama, invece.Facile, basta sovrascrivere a_stand_alone_function
con la funzione restituito 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 demistificata
L'esempio precedente, utilizzando il decoratore sintassi:
@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ì, che è di tutti, è semplice. @decorator
è solo una scorciatoia per:
another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)
Decoratori sono solo divinatori variante del design pattern decorator.Ci sono diversi classici modelli di progettazione embedded in Python per facilitare lo sviluppo (come gli iteratori).
Naturalmente, è possibile 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 Python decoratore sintassi:
@bread
@ingredients
def sandwich(food="--ham--"):
print(food)
sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>
L'ordine si imposta il decoratori QUESTIONI:
@ingredients
@bread
def strange_sandwich(food="--ham--"):
print(food)
strange_sandwich()
#outputs:
##tomatoes#
#</''''''\>
# --ham--
#<\______/>
# ~salad~
Ora:per rispondere alla domanda...
In conclusione, si può 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 è possibile lasciare felice, o bruciare il vostro cervello un po ' di più e vedere uso avanzato di decoratori.
L'assunzione di decoratori al livello successivo
Passaggio di argomenti per la funzione decorato
# 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 bella cosa Python è che i metodi e le funzioni sono in realtà la stessa.L'unica differenza è che i metodi di aspettarsi che il loro primo argomento è un riferimento all'oggetto corrente (self
).
Ciò significa che è possibile costruire un decoratore per i metodi allo stesso modo!Basta ricordarsi di prendere self
in 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 facendo general-purpose decoratore--uno si applicano a qualsiasi funzione o un metodo, non importa i suoi argomenti, quindi basta usare *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?
Passaggio di argomenti per il decoratore
Grande, ora che ne dite di passaggio di argomenti per il decoratore stesso?
Questo può ottenere un po ' contorto, dal momento che un decoratore deve accettare una funzione come argomento.Pertanto, non è possibile passare la arredate argomenti della funzione direttamente il decoratore.
Prima di correre per la soluzione, scrivere 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 la stessa cosa."my_decorator
"è chiamato.Così, quando si @my_decorator
, si dice Python per chiamare la funzione 'etichettato dalla variabile "my_decorator
"'.
Questo è importante!L'etichetta si può dare di puntare direttamente il decoratore—o non.
Andiamo male.☺
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 saltare tutti i fastidiosi 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.
Facciamolo ancora di più:
@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, hai visto?Abbiamo usato una chiamata di funzione con l' "@
"sintassi!:-)
Così, tornato a decoratori con gli argomenti.Se siamo in grado di utilizzare le funzioni per generare il decoratore al volo, siamo in grado di passare gli argomenti alla 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: 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
Qui è:decoratore con gli 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 si può vedere, è possibile passare argomenti al decoratore come qualsiasi funzione che utilizza questo trucco.È anche possibile utilizzare *args, **kwargs
se lo si desidera.Ma ricordate decoratori sono chiamati solo una volta.Solo quando Python importazioni script.Non è possibile impostare in modo dinamico i temi di seguito.Quando fai "importa x", la funzione è già arredate, così non è possibile
cambiare nulla.
Facciamo pratica:la decorazione di un decoratore
Va bene, come bonus, vi darò un frammento di fare qualsiasi decoratore accettare genericamente qualsiasi argomento.Dopo tutto, al fine di accettare argomenti, abbiamo creato il nostro decoratore utilizzando un'altra funzione.
Abbiamo avvolto il decoratore.
Qualsiasi altra cosa che abbiamo visto di recente che avvolto funzione?
Oh sì, decoratori!
Facciamo un po ' di divertimento e di scrivere 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 utilizzato 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 l'ascolto di un ragazzo dicendo:"prima di capire la ricorsione, si deve prima capire la ricorsione".Ma ora, non ti senti a tuo agio possedere questa?
Best practices:decoratori
- Decoratori sono stati introdotti in Python 2.4, in modo da essere sicuri che il codice verrà eseguito su >= 2.4.
- Decoratori rallentare la chiamata di funzione.Da tenere a mente.
- Non è possibile annullare la decorazione di una funzione. (C' sono hack per creare dei decoratori che può essere rimosso, ma nessuno le usa.) Quindi, quando una funzione è decorata, è decorato per tutto il codice.
- Decoratori avvolgere funzioni, che può rendere difficile il debug.(Questo è meglio da Python >= 2.5;vedere qui di seguito).
Il functools
il modulo è stato introdotto in Python 2.5.Include la funzione functools.wraps()
, per copiare il nome del modulo, e docstring della funzione decorato per il suo involucro.
(Fun fact: 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 può il decoratori essere utile?
Ora la domanda: Cosa posso usare decoratori per?
Sembra fresco e potente, ma un esempio pratico sarebbe grande.Beh, ci sono 1000 possibilità.Usi classici sono l'estensione di una funzione di comportamento da una libreria esterna (non è possibile modificarlo), o per il debug (non si desidera modificare perché è temporaneo).
Si possono usare per estendere diverse funzioni in un LAVAGGIO della strada, 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 la cosa buona con decoratori è che è possibile utilizzare subito su quasi nulla senza la riscrittura.SECCA, 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 fornisce diversi decoratori: property
, staticmethod
, etc.
- Django utilizza decoratori a gestire la memorizzazione nella cache e le autorizzazioni di visualizzazione.
- Ritorto per falso inline asincrona chiamate di funzioni.
Questo è davvero un grande parco giochi.
In alternativa, si potrebbe scrivere una funzione di fabbrica che restituiscono un decoratore che avvolge il valore di ritorno della funzione decorata in un tag passato alla funzione di fabbrica. Ad 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
Questo 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 un po '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 avrebbe prodotto:
@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
return val
say('hello')
Non dimenticare la costruzione per la quale la sintassi decoratore è una scorciatoia:
say = wrap_in_tag('b')(wrap_in_tag('i')(say)))
Sembra che le altre persone hanno già detto come risolvere il problema. Spero che questo vi aiuterà a capire che cosa decoratori sono.
Decoratori sono lo zucchero solo sintattica.
Questo
@decorator
def func():
...
si espande
def func():
...
func = decorator(func)
E, naturalmente, è possibile restituire lambda, nonché da una funzione decorator:
def makebold(f):
return lambda: "<b>" + f() + "</b>"
def makeitalic(f):
return lambda: "<i>" + f() + "</i>"
@makebold
@makeitalic
def say():
return "Hello"
print say()
decoratori Python aggiungono ulteriori funzionalità a un'altra funzione
Un decoratore 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 fondamentalmente è sostituire una funzione con quello appena definito. Ad esempio, ho questa classe
class foo:
def bar(self):
print "hi"
def foobar(self):
print "hi again"
Ora dicono, voglio entrambe le funzioni per la stampa "---" dopo e prima di essere fatto. Potrei aggiungere una stampa "---" prima e dopo ogni istruzione print. Ma perché 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
Così ora posso cambiare la mia classe a
class foo:
@addDashes
def bar(self):
print "hi"
@addDashes
def foobar(self):
print "hi again"
Per ulteriori informazioni su decoratori, Assegno http://www.ibm.com/developerworks/linux/library/l -cpdecor.html
potrebbero fare due decoratori separati che fare quello che vuoi, come illustrato direttamente sotto. Si noti l'uso del *args, **kwargs
nella dichiarazione della funzione wrapped()
che supporta la funzione decorato avere più argomenti (che non è davvero necessario per la funzione ad esempio say()
, ma è incluso per la generalità).
Per motivi analoghi, il decoratore functools.wraps
viene utilizzato per modificare i meta attributi della funzione avvolto essere quelli di un essere decorato. Questo rende i messaggi di errore e la documentazione funzione incorporata (func.__doc__
) siano quelli della funzione decorato invece di wrapped()
di.
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 si può vedere ci sono un sacco di codice duplicato in questi due decoratori. Tenuto conto di questa similitudine sarebbe meglio per voi a fare invece un generico che era in realtà un fabbrica decoratore , in altre parole, un decoratore che fa altri decoratori. In questo modo non ci sarebbe meno codice ripetizione e permettere alle href="https://en.wikipedia.org/wiki/Don't_repeat_yourself" DRY da seguire.
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, è possibile assegnare un nome più descrittivo ai decoratori-fabbrica generata:
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 di cui sopra tutto il lavoro, il codice generato comporta una discreta quantità di overhead sotto forma di funzione estranea chiamate quando più decoratori sono applicati contemporaneamente. Questo potrebbe non importa, a seconda dell'uso esatto (che potrebbe essere di I / O-bound, per esempio).
Se la velocità della funzione decorato è importante, il sovraccarico può essere mantenuto ad una singola chiamata di funzione in più scrivendo una fabbrica-funzione di decoratore leggermente diverso che costituisce la concretizzazione di aggiungere tutti i tag in una sola volta, in modo che possa generare il codice che evita il addtional chiamate di funzione dovute all'utilizzo di decoratori separate per ogni tag.
Questo richiede più codice dall'arredatore sé, ma questo solo viene eseguito quando è applicata a funzionare le definizioni, non più tardi, quando essi stessi sono chiamati. Questo vale anche quando si creano i nomi più leggibili utilizzando le funzioni lambda
come precedentemente illustrato. Esempio:
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'
Oppure, in modo 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 fare due decoratori in Python che farebbe il seguente?
Si desidera che la seguente funzione, quando viene chiamato:
@makebold @makeitalic def say(): return "Hello"
Per tornare:
<b><i>Hello</i></b>
Soluzione semplice
Per la maggior parte semplicemente fare questo, fanno decoratori che restituiscono lambda (funzioni anonime) che chiudono sopra la funzione (chiusure) e lo chiamano:
def makeitalic(fn):
return lambda: '<i>' + fn() + '</i>'
def makebold(fn):
return lambda: '<b>' + fn() + '</b>'
Ora usarli come desiderato:
@makebold
@makeitalic
def say():
return 'Hello'
e ora:
>>> say()
'<b><i>Hello</i></b>'
Problemi con il soluzione semplice
Ma ci sembra di aver quasi perso la funzione originaria.
>>> say
<function <lambda> at 0x4ACFA070>
Per trovarlo, avremmo bisogno di scavare nella chiusura di ogni lambda, uno dei quali è sepolto nella 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 documentazione su questa funzione, o voluto essere in grado di decorare le funzioni che richiedono più di un argomento, o volevamo solo sapere quale funzione stavamo guardando in una sessione di debug, abbiamo bisogno di fare un po ' con i wrapper.
soluzione completa funzionalità - superare la maggior parte di questi problemi
Abbiamo la wraps
decoratore dal modulo functools
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
E 'un peccato che ci sia ancora un po' boilerplate, ma questo è quanto di più semplice come siamo in grado di farlo.
In Python 3, si ottiene anche __qualname__
e __annotations__
assegnato per impostazione predefinita.
Così ora:
@makebold
@makeitalic
def say():
"""This function returns a bolded, italicized 'hello'"""
return 'Hello'
E ora:
>>> 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
Così vediamo che wraps
rende la funzione di involucro fare quasi tutto, tranne che dirci esattamente ciò che la funzione prende come argomenti.
Ci sono altri moduli che possono tentare di affrontare il problema, ma la soluzione non è ancora nella libreria standard.
Un decoratore prende la definizione di funzione e crea una nuova funzione che esegue questa funzione e trasforma il risultato.
@deco
def do():
...
è eqivarent 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
è eqivalent a questo def DO2 (numero): ritorno chr (numero)
do2 = deco(do2)
65 <=> 'a'
print(do(65))
print(do2(65))
>>> B
>>> B
Per capire il decoratore, è importante notare, che decoratore ha creato una nuova funzione di fare che è interiore che esegue func e trasforma il risultato.
Per spiegare decoratore in un modo più semplice:
Con:
@decor1
@decor2
def func(*args, **kwargs):
pass
Quando fare:
func(*args, **kwargs)
È davvero:
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()
Si può anche scrivere decoratore in Class
#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")
Ecco un semplice esempio di concatenamento decoratori. Nota l'ultima riga -. Si vede che cosa sta succedendo sotto le coperte
############################################################
#
# 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 appare come:
17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>
Questa risposta è stata a lungo una risposta, ma ho pensato di condividere la mia classe Decorator che rende la scrittura di nuovi decoratori semplice e compatto.
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 prima Penso che questo rende il comportamento dei decoratori molto chiare, ma rende anche più facile definire nuovi decoratori molto conciso. Per l'esempio di cui sopra, si potrebbe quindi 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"
Si potrebbe anche usare per fare i compiti più complessi, come ad esempio un decoratore che rende automaticamente la funzione venga applicato in modo ricorsivo a tutti gli argomenti in 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 include il tipo list
nella esemplificazione del decoratore, quindi nella dichiarazione stampa finale il metodo viene applicato alla lista stessa, non gli elementi della lista.
A proposito dell'esempio contro - come indicato sopra, il contatore sarà condivisa tra tutte le funzioni che utilizzano 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 vostro decoratore può essere riutilizzato per diverse funzioni (o utilizzati per decorare la stessa funzione più volte: func_counter1 = counter(func); func_counter2 = counter(func)
), e la variabile contatore rimarrà privato a ciascuno.
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
Paolo Bergantino risposta ha il grande vantaggio di usando solo la stdlib, e lavora per questo semplice esempio, dove non ci sono decoratore argomenti né decorate funzione gli argomenti.
Tuttavia dispone di 3 grandi limitazioni se si vuole affrontare più generale casi:
- come si è già notato in alcune risposte, si può facilmente modificare il codice per aggiungere optional come decoratore di argomenti.Per esempio la creazione di un
makestyle(style='bold')
decoratore non è banale. - inoltre, wrapper creato con
@functools.wraps
non conservare la firma, così, se un cattivo argomenti sono forniti saranno avviare l'esecuzione, e potrebbe generare un diverso tipo di errore in più del solitoTypeError
. - infine, è molto difficile in wrapper creato con
@functools.wraps
per accedere a un argomento basato sul suo nome.Infatti l'argomento può apparire in*args
, in**kwargs
, o potrebbe non apparire a tutti (se è opzionale).
Ho scritto decopatch
per risolvere il primo problema, e ha scritto makefun.wraps
per risolvere gli altri due.Nota che makefun
sfrutta lo stesso trucco del famoso decorator
lib.
Questo è come si può creare un decoratore con argomenti che, di ritorno veramente firma di conservazione wrapper:
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
fornisce altri due stili di sviluppo che, di nascondere o mostrare le varie python concetti, a seconda delle vostre preferenze.Il più compatto in stile è 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 si può verificare che il decoratore funziona 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 al documentazione per ulteriori dettagli.