Comment faire une chaîne de décorateurs de fonction?
Comment puis-je faire deux décorateurs en Python qui feraient ce qui suit?
@makebold
@makeitalic
def say():
return "Hello"
...qui devrait retourner:
"<b><i>Hello</i></b>"
Je n'essaie pas de faire HTML
de cette façon dans une application réelle - juste essayer de comprendre comment les décorateurs et l'enchaînement de décorateur fonctionne.
15 réponses
consultez la documentation pour voir comment travaillent les décorateurs. Voici ce que vous avez demandé:
def makebold(fn):
def wrapped():
return "<b>" + fn() + "</b>"
return wrapped
def makeitalic(fn):
def wrapped():
return "<i>" + fn() + "</i>"
return wrapped
@makebold
@makeitalic
def hello():
return "hello world"
print hello() ## returns "<b><i>hello world</i></b>"
si vous n'êtes pas en longues explications, voir réponse de Paolo Bergantino .
Les Bases Du Décorateur
les fonctions de Python sont des objets
pour comprendre les décorateurs, vous devez d'abord comprendre que les fonctions sont des objets en Python. Ceci a des conséquences importantes. Voyons pourquoi avec un exemple simple:
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, e:
print(e)
#outputs: "name 'shout' is not defined"
print(scream())
# outputs: 'Yes!'
gardez ceci à l'esprit. Nous allons revenir à elle bientôt.
une autre propriété intéressante des fonctions Python est qu'elles peuvent être définies à l'intérieur d'une autre fonction!
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, e:
print(e)
#outputs : "name 'whisper' is not defined"*
#Python's functions are objects
fonctions Références
OK, toujours là? Maintenant la partie amusante...
vous avez vu que les fonctions sont des objets. Par conséquent, fonctions:
- peut être affecté à une variable
- peut être défini dans une autre fonction
Qui signifie que une fonction return
autre fonction .
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...
il y a plus!
si vous pouvez return
une fonction, vous pouvez passer un paramètre:
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!
Eh bien, vous avez juste tout ce qu'il faut pour comprendre les décorateurs. Vous voyez, les décorateurs sont des "wrappers", ce qui signifie que ils vous laissent exécuter le code avant et après la fonction qu'ils décorent sans modifier la fonction elle-même.
décorateurs artisanaux
comment faire à la main:
# 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
Maintenant, vous voulez probablement que chaque fois que vous appelez a_stand_alone_function
, a_stand_alone_function_decorated
est appelé à la place. C'est facile, juste écraser a_stand_alone_function
avec la fonction retournée par 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!
décorateurs demystified
l'exemple précédent, en utilisant la syntaxe decorator:
@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
Oui, c'est tout, c'est aussi simple que cela. @decorator
n'est qu'un raccourci vers:
another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)
décorateurs sont juste une variante pythonique du décorateur motif . Il existe plusieurs modèles de conception classiques intégrés dans Python pour faciliter le développement (comme les itérateurs).
bien sûr, vous pouvez accumulent les décorateurs:
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~
#<\______/>
utilisant la syntaxe Python decorator:
@bread
@ingredients
def sandwich(food="--ham--"):
print(food)
sandwich()
#outputs:
#</''''''\>
# #tomatoes#
# --ham--
# ~salad~
#<\______/>
L'ordre que vous donnez aux décorateurs est important:
@ingredients
@bread
def strange_sandwich(food="--ham--"):
print(food)
strange_sandwich()
#outputs:
##tomatoes#
#</''''''\>
# --ham--
#<\______/>
# ~salad~
Maintenant: pour répondre à la question...
en conclusion, vous pouvez facilement voir comment répondre à la question:
# 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>
vous pouvez maintenant partir heureux, ou brûler votre cerveau un peu plus et voir utilisations avancées de décorateurs.
la Prise de décorateurs au prochain niveau
passer des arguments à la fonction décorée
# 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éthodes de décoration
une chose intéressante à propos de Python est que les méthodes et les fonctions sont vraiment les mêmes. La seule différence est que les méthodes s'attendent à ce que leur premier argument soit une référence à l'objet courant ( self
).
cela signifie que vous pouvez construire un décorateur pour les méthodes de la même manière! N'oubliez pas de prendre self
en considération:
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?
si vous faites décorateur universel--un que vous appliquerez à n'importe quelle fonction ou méthode, peu importe ses arguments--alors il suffit d'utiliser *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?
passer des arguments au Décorateur
Grand, maintenant Que diriez-vous sur passer des arguments au Décorateur?
Cela peut être un peu tordu, depuis un décorateur doit accepter une fonction comme argument. Par conséquent, vous ne pouvez pas passer les arguments de la fonction décorée directement au Décorateur.
avant de nous précipiter vers la solution, écrivons un petit rappel:
# 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
C'est exactement la même. " my_decorator
" s'appelle. Donc quand vous @my_decorator
, vous dites à Python d'appeler la fonction 'étiquetée par la variable" my_decorator
"".
C'est important! L'étiquette que vous donnez peut pointer directement au Décorateur- ou pas .
soyons mauvais. ☺
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.
pas de surprise ici.
faisons exactement la même chose, mais sautons toutes les variables intermédiaires pesantes:
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.
faisons même plus court :
@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.
Hé, tu as vu ça? Nous avons utilisé un appel de fonction avec la syntaxe " @
"! :- )
Donc, retour à la décorateurs avec des arguments. Si nous pouvons utiliser des fonctions pour générer le décorateur à la volée, on peut passer des arguments à cette fonction, non?
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: /q/can-you-explain-closures-as-they-relate-to-python-26817/"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
voici: un décorateur avec des arguments. Les Arguments peuvent être définis comme variable:
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
As vous pouvez voir, vous pouvez passer des arguments au Décorateur comme n'importe quelle fonction en utilisant ce truc. Vous pouvez même utiliser *args, **kwargs
si vous le souhaitez. Mais rappelez-vous que les décorateurs sont appelés une seule fois . Juste quand Python importe le script. Vous ne pouvez pas dynamiquement régler les arguments après. Quand vous faites "importer x", la fonction est déjà décorée , donc vous ne pouvez pas
changer quoi que ce soit.
pratiquons: décorer un décorateur
OK, en prime, je vais vous donner un petit détail pour faire accepter à n'importe quel décorateur n'importe quel argument Générique. Après tout, afin d'accepter les arguments, nous avons créé notre décorateur en utilisant une autre fonction.
nous avons enveloppé le décorateur.
autre chose que nous avons vu récemment cette fonction enveloppée?
Oh oui, décorateurs!
nous allons avoir du plaisir et d'écrire un décorateur pour les décorateurs:
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
Il peut être utilisé comme suit:
# 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!
je sais, la dernière fois que vous avez eu ce sentiment, c'était après avoir écouté un gars dire:"avant de comprendre la récursion, vous devez d'abord comprendre la récursion". Mais maintenant, tu ne te sens pas bien de maîtriser ça?
meilleures pratiques: décorateurs
- décorateurs ont été introduits en Python 2.4, alors assurez-vous que votre code sera lancé sur >= 2.4.
- les décorateurs ralentissent l'appel de fonction. Gardez cela à l'esprit.
- vous ne pouvez pas décorer une fonction. (il sont hacks pour créer des décorateurs qui peuvent être enlevés, mais personne ne les utilise. Ainsi, une fois qu'une fonction est décorée, elle est décorée pour tout le code .
- fonctions d'enveloppement des décorateurs, ce qui peut les rendre difficiles à déboguer. (Cela s'améliore avec Python > = 2.5; voir ci-dessous.)
le module functools
a été introduit en python 2.5. Il inclut la fonction functools.wraps()
, qui copie le nom, le module, et docstring de la fonction décorée à son emballage.
(fait Amusant: functools.wraps()
est un décorateur!
# 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
comment les décorateurs peuvent-ils être utiles?
maintenant la grande question: Que puis-je utiliser décorateurs pour?
semble cool et puissant, mais un exemple pratique serait grand. Eh bien, il ya plus de 1000 possibilités. Les utilisations classiques consistent à étendre le comportement d'une fonction à partir d'une lib externe (vous ne pouvez pas la modifier), ou pour le débogage (vous ne voulez pas la modifier parce que c'est temporaire).
vous pouvez les utiliser pour étendre plusieurs fonctions D'une manière sèche, comme so:
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
bien sûr, la bonne chose avec les décorateurs est que vous pouvez les utiliser tout de suite sur presque n'importe quoi sans réécriture. Sec, j'ai dit:
@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 lui-même fournit plusieurs décorateurs: property
, staticmethod
, etc.
- Django utilise des décorateurs pour gérer la mise en cache et les permissions de visionnement.
- Tordu de faux inline asynchrone des appels de fonctions.
C'est vraiment un grand terrain de jeu.
alternativement, vous pouvez écrire une fonction d'usine qui renvoie un décorateur qui enveloppe la valeur de retour de la fonction décorée dans une étiquette passée à la fonction d'usine. Par exemple:
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
Cela vous permet d'écrire:
@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'
Personnellement, j'aurais écrit le décorateur un peu différemment:
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
qui donnerait:
@wrap_in_tag('b')
@wrap_in_tag('i')
def say(val):
return val
say('hello')
N'oubliez pas les constructions dont le décorateur la syntaxe est un raccourci:
say = wrap_in_tag('b')(wrap_in_tag('i')(say)))
Il semblerait que les autres ont déjà dit comment résoudre le problème. J'espère que cela vous aidera à comprendre ce que sont les décorateurs.
les décorateurs ne sont que du sucre syntaxique.
Ce
@decorator
def func():
...
se développe en
def func():
...
func = decorator(func)
et bien sûr vous pouvez retourner lambdas ainsi d'une fonction de décorateur:
def makebold(f):
return lambda: "<b>" + f() + "</b>"
def makeitalic(f):
return lambda: "<i>" + f() + "</i>"
@makebold
@makeitalic
def say():
return "Hello"
print say()
les décorateurs Python ajoutent des fonctionnalités supplémentaires à une autre fonction
un décorateur en italique pourrait être comme
def makeitalic(fn):
def newFunc():
return "<i>" + fn() + "</i>"
return newFunc
Notez qu'une fonction est définie à l'intérieur d'une fonction. Ce qu'il fait est de remplacer une fonction avec la nouvelle définition. Par exemple, j'ai cette classe
class foo:
def bar(self):
print "hi"
def foobar(self):
print "hi again"
Maintenant, dites, je veux que les deux fonctions impriment "- - - " après et avant qu'elles soient faites. Je pourrais ajouter une impression "- - - " avant et après chaque déclaration imprimée. Mais parce que je n'aime pas me répéter, je vais faire un décorateur
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
donc maintenant je peux changer ma classe en
class foo:
@addDashes
def bar(self):
print "hi"
@addDashes
def foobar(self):
print "hi again"
pour en savoir plus sur les décorateurs, consultez http://www.ibm.com/developerworks/linux/library/l-cpdecor.html
Vous pourrait faire deux décorateurs que faire ce que vous voulez comme illustré directement ci-dessous. Notez l'utilisation de *args, **kwargs
dans la déclaration de la fonction wrapped()
qui soutient la fonction décorée ayant des arguments multiples (qui n'est pas vraiment nécessaire pour l'exemple say()
fonction, mais est inclus pour la généralité).
pour des raisons similaires, le functools.wraps
decorator est utilisé pour changer les attributs meta de la enveloppé fonction de ceux de l'être décoré. Cela rend les messages d'erreur et la documentation de la fonction embarquée ( func.__doc__
) être ceux de la fonction décorée au lieu de 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>
raffinements
comme vous pouvez le voir, il y a beaucoup de code double dans ces deux décorateurs. Compte tenu de cette similitude, il serait préférable pour vous de faire à la place un générique qui était en fait un décorateur usine -en d'autres termes, un décorateur qui rend les autres décorateurs. De cette façon, il y aurait moins de répétition de code-et permettrait le principe sec à suivre.
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>
pour rendre le code plus lisible, vous pouvez attribuer un nom plus descriptif aux décorateurs générés en usine:
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 même les combiner comme ceci:
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>
efficacité
bien que les exemples ci-dessus fassent tout le travail, le code généré implique une bonne quantité de frais généraux sous forme d'appels de fonctions externes lorsque plusieurs décorateurs sont appliqués à la fois. Cela peut ne pas avoir d'importance, en fonction de l'usage exact (qui peut être lié aux e/s, par exemple).
si la vitesse de la fonction décorée est importante, la tête peut être maintenue à une seule fonction supplémentaire appel en écrivant un décorateur légèrement différent usine-fonction qui met en œuvre ajoutant toutes les étiquettes à la fois, de sorte qu'il peut générer du code qui évite les appels de fonction supplémentaires engagés en utilisant des décorateurs séparés pour chaque étiquette.
cela nécessite plus de code dans le décorateur lui-même, mais cela ne fonctionne que lorsqu'il est appliqué aux définitions de fonction, pas plus tard quand eux-mêmes sont appelés. Ceci s'applique également lors de la création de noms plus lisibles en utilisant les fonctions lambda
comme illustré précédemment. Exemple:
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>
une Autre façon de faire la même chose:
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 manière plus souple:
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'
Comment puis-je faire deux décorateurs en Python qui feraient ce qui suit?
vous voulez la fonction suivante, lorsqu'elle est appelée:
@makebold @makeitalic def say(): return "Hello"
De retour:
<b><i>Hello</i></b>
solution Simple
pour le faire plus simplement, faire décorateurs qui renvoient lambdas (fonctions anonymes) qui ferment sur le fonction (fermetures) et l'appeler:
def makeitalic(fn):
return lambda: '<i>' + fn() + '</i>'
def makebold(fn):
return lambda: '<b>' + fn() + '</b>'
maintenant les utiliser comme désiré:
@makebold
@makeitalic
def say():
return 'Hello'
et maintenant:
>>> say()
'<b><i>Hello</i></b>'
problèmes avec la solution simple
mais nous semblons avoir presque perdu la fonction originale.
>>> say
<function <lambda> at 0x4ACFA070>
Pour la trouver, nous avions besoin de creuser dans la clôture de chaque lambda, dont l'un est enterré dans l'autre:
>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>
donc si nous mettons de la documentation sur cette fonction, ou si nous voulons pouvoir décorer des fonctions qui prennent plus d'un argument, ou si nous voulons juste savoir quelle fonction nous regardons dans une session de débogage, nous devons faire un peu plus avec notre wrapper.
Complet de la solution de surmonter la plupart de ces problèmes
nous avons le décorateur wraps
du module functools
dans la bibliothèque 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
il est regrettable qu'il y ait encore quelques boilerplate, mais c'est aussi simple que nous pouvons le faire.
en Python 3, vous obtenez aussi __qualname__
et __annotations__
assignés par défaut.
Donc maintenant:
@makebold
@makeitalic
def say():
"""This function returns a bolded, italicized 'hello'"""
return 'Hello'
et maintenant:
>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:
say(*args, **kwargs)
This function returns a bolded, italicized 'hello'
Conclusion
donc nous voyons que wraps
rend la fonction d'Emballage faire presque tout sauf nous dire exactement ce que la fonction prend comme arguments.
Il y a d'autres modules qui peuvent tenter de résoudre le problème, mais la solution n'est pas encore dans la bibliothèque standard.
Un décorateur prend la définition de la fonction et crée une nouvelle fonction qui exécute cette fonction et transforme le résultat.
@deco
def do():
...
est eqivarent:
do = deco(do)
exemple:
def deco(func):
def inner(letter):
return func(letter).upper() #upper
return inner
Ce
@deco
def do(number):
return chr(number) # number to letter
est équivalent à ce def do2 (nombre): retour chr(nombre)
do2 = deco(do2)
65 <=> 'un'
print(do(65))
print(do2(65))
>>> B
>>> B
pour comprendre le décorateur, il est important de noter, que le décorateur a créé une nouvelle fonction do qui est intérieure qui exécute func et transforme le résultat.
pour expliquer le décorateur d'une manière plus simple:
avec:
@decor1
@decor2
def func(*args, **kwargs):
pass
quand faire:
func(*args, **kwargs)
vraiment, Vous n':
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()
vous pouvez aussi écrire décorateur dans la 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")
parlant du compteur exemple - comme indiqué ci-dessus, le compteur sera partagé entre toutes les fonctions qui utilisent le décorateur:
def counter(func):
def wrapped(*args, **kws):
print 'Called #%i' % wrapped.count
wrapped.count += 1
return func(*args, **kws)
wrapped.count = 0
return wrapped
de cette façon, votre décorateur peut être réutilisé pour différentes fonctions (ou utilisé pour décorer la même fonction plusieurs fois: func_counter1 = counter(func); func_counter2 = counter(func)
), et la variable counter restera privé pour chacun.
voici un exemple simple d'enchaînement de décorateurs. Remarque la dernière ligne, il montre ce qui se passe sous les couvertures.
############################################################
#
# 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))()
la sortie ressemble à:
17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>
décorer les fonctions avec un nombre différent d'arguments:
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!')
résultat:
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