parametros - programacion funcional python pdf
¿Cómo hacer una cadena de decoradores funcionales? (16)
¿Cómo puedo hacer dos decoradores en Python que hagan lo siguiente?
Desea la siguiente función, cuando se le llama:
@makebold @makeitalic def say(): return "Hello"
Regresar:
<b><i>Hello</i></b>
Solución simple
Para hacer la mayoría simplemente, haga decoradores que devuelvan lambdas (funciones anónimas) que cierran sobre la función (cierres) y llámenlos:
def makeitalic(fn):
return lambda: ''<i>'' + fn() + ''</i>''
def makebold(fn):
return lambda: ''<b>'' + fn() + ''</b>''
Ahora úsalos como desees:
@makebold
@makeitalic
def say():
return ''Hello''
y ahora:
>>> say()
''<b><i>Hello</i></b>''
Problemas con la solución simple.
Pero parece que casi hemos perdido la función original.
>>> say
<function <lambda> at 0x4ACFA070>
Para encontrarlo, tendríamos que profundizar en el cierre de cada lambda, uno de los cuales está enterrado en el otro:
>>> say.__closure__[0].cell_contents
<function <lambda> at 0x4ACFA030>
>>> say.__closure__[0].cell_contents.__closure__[0].cell_contents
<function say at 0x4ACFA730>
Entonces, si ponemos documentación sobre esta función, o quisiéramos poder decorar las funciones que toman más de un argumento, o simplemente quisiéramos saber qué función estábamos viendo en una sesión de depuración, necesitamos hacer un poco más con nuestro envoltura.
Solución completa: superar la mayoría de estos problemas
¡Tenemos el decorador wrapsdel functoolsmódulo en la biblioteca estándar!
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
Es desafortunado que todavía haya un poco de repetitivo, pero es tan simple como podemos hacerlo.
En Python 3, también obtiene __qualname__y __annotations__asigna de forma predeterminada.
Y ahora:
@makebold
@makeitalic
def say():
"""This function returns a bolded, italicized ''hello''"""
return ''Hello''
Y ahora:
>>> say
<function say at 0x14BB8F70>
>>> help(say)
Help on function say in module __main__:
say(*args, **kwargs)
This function returns a bolded, italicized ''hello''
Conclusión
Entonces vemos que wrapshace que la función de ajuste haga casi todo, excepto que nos diga exactamente qué toma la función como argumentos.
Hay otros módulos que pueden intentar solucionar el problema, pero la solución aún no está en la biblioteca estándar.
¿Cómo puedo hacer dos decoradores en Python que hagan lo siguiente?
@makebold
@makeitalic
def say():
return "Hello"
... que debería devolver:
"<b><i>Hello</i></b>"
No estoy tratando de hacer HTML esta manera en una aplicación real, solo trato de entender cómo funcionan los decoradores y el encadenamiento de decoradores.
Decorar funciones con diferente número de argumentos:
def frame_tests(fn):
def wrapper(*args):
print "/nStart: %s" %(fn.__name__)
fn(*args)
print "End: %s/n" %(fn.__name__)
return wrapper
@frame_tests
def test_fn1():
print "This is only a test!"
@frame_tests
def test_fn2(s1):
print "This is only a test! %s" %(s1)
@frame_tests
def test_fn3(s1, s2):
print "This is only a test! %s %s" %(s1, s2)
if __name__ == "__main__":
test_fn1()
test_fn2(''OK!'')
test_fn3(''OK!'', ''Just a test!'')
Resultado:
Start: test_fn1
This is only a test!
End: test_fn1
Start: test_fn2
This is only a test! OK!
End: test_fn2
Start: test_fn3
This is only a test! OK! Just a test!
End: test_fn3
Alternativamente, puede escribir una función de fábrica que devuelva un decorador que envuelva el valor de retorno de la función decorada en una etiqueta pasada a la función de fábrica. Por ejemplo:
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
Esto le permite escribir:
@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 habría escrito el decorador de manera algo diferente:
from functools import wraps
def wrap_in_tag(tag):
def factory(func):
@wraps(func)
def decorator(val):
return func(''<%(tag)s>%(val)s</%(tag)s>'' %
{''tag'': tag, ''val'': val})
return decorator
return factory
que daría lugar a:
@wrap_in_tag(''b'')
@wrap_in_tag(''i'')
def say(val):
return val
say(''hello'')
No olvide la construcción para la cual la sintaxis del decorador es una abreviatura:
say = wrap_in_tag(''b'')(wrap_in_tag(''i'')(say)))
Echa un vistazo a la documentación para ver cómo trabajan los decoradores. Esto es lo que pediste:
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>"
Los decoradores de Python agregan funcionalidad extra a otra función
Un decorador en cursiva podría ser como
def makeitalic(fn):
def newFunc():
return "<i>" + fn() + "</i>"
return newFunc
Tenga en cuenta que una función se define dentro de una función. Lo que básicamente hace es reemplazar una función con la recién definida. Por ejemplo, tengo esta clase
class foo:
def bar(self):
print "hi"
def foobar(self):
print "hi again"
Ahora diga, quiero que ambas funciones impriman "---" antes y después de que se terminen. Podría agregar una impresión "---" antes y después de cada declaración de impresión. Pero como no me gusta repetirme, haré un decorador.
def addDashes(fn): # notice it takes a function as an argument
def newFunction(self): # define a new function
print "---"
fn(self) # call the original function
print "---"
return newFunction
# Return the newly defined function - it will "replace" the original
Así que ahora puedo cambiar mi clase a
class foo:
@addDashes
def bar(self):
print "hi"
@addDashes
def foobar(self):
print "hi again"
Para obtener más información sobre decoradores, visite http://www.ibm.com/developerworks/linux/library/l-cpdecor.html
Parece que las otras personas ya te han dicho cómo resolver el problema. Espero que esto te ayude a entender qué son los decoradores.
Los decoradores son solo azúcar sintáctica.
Esta
@decorator
def func():
...
se expande a
def func():
...
func = decorator(func)
Si no te gustan las explicaciones largas, lee la respuesta de Paolo Bergantino .
Fundamentos del decorador
Las funciones de Python son objetos.
Para entender a los decoradores, primero debes entender que las funciones son objetos en Python. Esto tiene importantes consecuencias. Veamos por qué con un simple ejemplo:
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!''
Mantén esto en mente. Vamos a regresar a él en breve.
Otra propiedad interesante de las funciones de Python es que se pueden definir dentro de otra función.
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
Referencias de funciones
Está bien, todavía aquí? Ahora la parte divertida ...
Has visto que las funciones son objetos. Por lo tanto, funciona:
- se puede asignar a una variable
- Se puede definir en otra función.
Eso significa que una función puede return otra función .
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...
¡Hay más!
Si puede return una función, puede pasar una como parámetro:
def doSomethingBefore(func):
print("I do something before then I call the function you gave me")
print(func())
doSomethingBefore(scream)
#outputs:
#I do something before then I call the function you gave me
#Yes!
Bueno, solo tienes todo lo necesario para entender a los decoradores. Verás, los decoradores son "envoltorios", lo que significa que te permiten ejecutar código antes y después de la función que decoran sin modificar la función en sí.
Decoradores artesanales
Cómo lo harías 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
Ahora, es probable que desees que cada vez que llames a_stand_alone_function , a_stand_alone_function_decorated sea llamado en su lugar. Eso es fácil, solo sobrescriba a_stand_alone_function con la función devuelta por my_shiny_new_decorator :
a_stand_alone_function = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function()
#outputs:
#Before the function runs
#I am a stand alone function, don''t you dare modify me
#After the function runs
# That’s EXACTLY what decorators do!
Decoradores desmitificados
El ejemplo anterior, usando la sintaxis de decorador:
@my_shiny_new_decorator
def another_stand_alone_function():
print("Leave me alone")
another_stand_alone_function()
#outputs:
#Before the function runs
#Leave me alone
#After the function runs
Sí, eso es todo, es así de simple. @decorator es solo un acceso directo a:
another_stand_alone_function = my_shiny_new_decorator(another_stand_alone_function)
Los decoradores son solo una variante pitónica del patrón de diseño del decorador . Hay varios patrones de diseño clásicos integrados en Python para facilitar el desarrollo (como los iteradores).
Por supuesto, puedes acumular decoradores:
def bread(func):
def wrapper():
print("</''''''''''''/>")
func()
print("</______/>")
return wrapper
def ingredients(func):
def wrapper():
print("#tomatoes#")
func()
print("~salad~")
return wrapper
def sandwich(food="--ham--"):
print(food)
sandwich()
#outputs: --ham--
sandwich = bread(ingredients(sandwich))
sandwich()
#outputs:
#</''''''''''''/>
# #tomatoes#
# --ham--
# ~salad~
#</______/>
Usando la sintaxis del decorador de Python:
@bread
@ingredients
def sandwich(food="--ham--"):
print(food)
sandwich()
#outputs:
#</''''''''''''/>
# #tomatoes#
# --ham--
# ~salad~
#</______/>
El orden que establezcas los decoradores importa:
@ingredients
@bread
def strange_sandwich(food="--ham--"):
print(food)
strange_sandwich()
#outputs:
##tomatoes#
#</''''''''''''/>
# --ham--
#</______/>
# ~salad~
Ahora: para responder a la pregunta ...
Como conclusión, puede ver fácilmente cómo responder a la pregunta:
# 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>
Ahora puede simplemente irse feliz o quemar un poco más su cerebro y ver los usos avanzados de los decoradores.
Llevando a los decoradores al siguiente nivel
Pasando argumentos a la función decorada.
# 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
Metodos de decoracion
Una cosa ingeniosa acerca de Python es que los métodos y las funciones son realmente iguales. La única diferencia es que los métodos esperan que su primer argumento sea una referencia al objeto actual ( self ).
¡Eso significa que puedes construir un decorador para métodos de la misma manera! Solo recuerda tener en cuenta a ti self :
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 está creando un decorador de propósito general, uno se aplicará a cualquier función o método, sin importar sus argumentos, entonces solo use *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?
Pasando argumentos al decorador.
Genial, ahora, ¿qué dirías acerca de pasarle argumentos al decorador?
Esto se puede torcer un poco, ya que un decorador debe aceptar una función como argumento. Por lo tanto, no puede pasar los argumentos de la función decorada directamente al decorador.
Antes de apresurarse a la solución, escribamos un pequeño recordatorio:
# 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
Es exactamente lo mismo. Se my_decorator " my_decorator ". Entonces, cuando @my_decorator , le está diciendo a Python que llame a la función ''etiquetada por la variable " my_decorator "''.
¡Esto es importante! La etiqueta que le dé puede apuntar directamente al decorador, o no .
Vayamos al mal. ☺
def decorator_maker():
print("I make decorators! I am executed only once: "
"when you make me create a decorator.")
def my_decorator(func):
print("I am a decorator! I am executed only when you decorate a function.")
def wrapped():
print("I am the wrapper around the decorated function. "
"I am called when you call the decorated function. "
"As the wrapper, I return the RESULT of the decorated function.")
return func()
print("As the decorator, I return the wrapped function.")
return wrapped
print("As a decorator maker, I return a decorator")
return my_decorator
# Let’s create a decorator. It’s just a new function after all.
new_decorator = decorator_maker()
#outputs:
#I make decorators! I am executed only once: when you make me create a decorator.
#As a decorator maker, I return a decorator
# Then we decorate the function
def decorated_function():
print("I am the decorated function.")
decorated_function = new_decorator(decorated_function)
#outputs:
#I am a decorator! I am executed only when you decorate a function.
#As the decorator, I return the wrapped function
# Let’s call the function:
decorated_function()
#outputs:
#I am the wrapper around the decorated function. I am called when you call the decorated function.
#As the wrapper, I return the RESULT of the decorated function.
#I am the decorated function.
No hay sorpresa aquí.
Hagamos EXACTAMENTE lo mismo, pero omitamos todas las variables intermedias molestas:
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.
Hagámoslo aún más corto :
@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.
Oye, ¿viste eso? Utilizamos una llamada de función con la sintaxis " @ "! :-)
Entonces, volvamos a los decoradores con argumentos. Si podemos usar funciones para generar el decorador sobre la marcha, podemos pasar argumentos a esa función, ¿verdad?
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://.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
Aquí está: un decorador con argumentos. Los argumentos se pueden establecer como 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
Como puede ver, puede pasar argumentos al decorador como a cualquier función usando este truco. Incluso puedes usar *args, **kwargs si lo deseas. Pero recuerda que los decoradores solo son llamados una vez . Justo cuando Python importa el script. No puedes establecer dinámicamente los argumentos después. Cuando haces "importar x", la función ya está decorada , así que no puedes cambiar nada.
Practiquemos: decorar un decorador.
Bueno, como bono, te daré un fragmento para hacer que cualquier decorador acepte genéricamente cualquier argumento. Después de todo, para aceptar argumentos, creamos nuestro decorador usando otra función.
Envolvimos el decorador.
¿Algo más que vimos recientemente que envolvió la función?
¡Oh sí, decoradores!
Vamos a divertirnos y escribir un decorador para los decoradores:
def decorator_with_args(decorator_to_enhance):
"""
This function is supposed to be used as a decorator.
It must decorate an other function, that is intended to be used as a decorator.
Take a cup of coffee.
It will allow any decorator to accept an arbitrary number of arguments,
saving you the headache to remember how to do that every time.
"""
# We use the same trick we did to pass arguments
def decorator_maker(*args, **kwargs):
# We create on the fly a decorator that accepts only a function
# but keeps the passed arguments from the maker.
def decorator_wrapper(func):
# We return the result of the original decorator, which, after all,
# IS JUST AN ORDINARY FUNCTION (which returns a function).
# Only pitfall: the decorator must have this specific signature or it won''t work:
return decorator_to_enhance(func, *args, **kwargs)
return decorator_wrapper
return decorator_maker
Se puede utilizar de la siguiente manera:
# 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 sé, la última vez que tuvo este sentimiento, fue después de escuchar a un tipo que decía: "antes de comprender la recursión, primero debe entender la recursión". Pero ahora, ¿no te sientes bien de dominar esto?
Buenas prácticas: decoradores.
- Los decoradores se introdujeron en Python 2.4, así que asegúrese de que su código se ejecute en> = 2.4.
- Los decoradores ralentizan la llamada a la función. Mantenlo en mente.
- No puedes des-decorar una función. (Hay trucos para crear decoradores que pueden eliminarse, pero nadie los usa). Por lo tanto, una vez que una función está decorada, está decorada para todo el código .
- Los decoradores envuelven las funciones, lo que puede dificultar su depuración. (Esto mejora con Python> = 2.5; ver más abajo.)
El módulo functools fue introducido en Python 2.5. Incluye la función functools.wraps() , que copia el nombre, el módulo y la cadena de documentos de la función decorada en su envoltorio.
(Dato functools.wraps() : functools.wraps() es un decorador! ☺)
# For debugging, the stacktrace prints you the function __name__
def foo():
print("foo")
print(foo.__name__)
#outputs: foo
# With a decorator, it gets messy
def bar(func):
def wrapper():
print("bar")
return func()
return wrapper
@bar
def foo():
print("foo")
print(foo.__name__)
#outputs: wrapper
# "functools" can help for that
import functools
def bar(func):
# We say that "wrapper", is wrapping "func"
# and the magic begins
@functools.wraps(func)
def wrapper():
print("bar")
return func()
return wrapper
@bar
def foo():
print("foo")
print(foo.__name__)
#outputs: foo
¿Cómo pueden ser útiles los decoradores?
Ahora la gran pregunta: ¿Para qué puedo usar decoradores?
Parece fresco y poderoso, pero un ejemplo práctico sería genial. Bueno, hay 1000 posibilidades. Los usos clásicos son extender el comportamiento de una función desde una biblioteca externa (no se puede modificar) o para la depuración (no se quiere modificar porque es temporal).
Puedes usarlas para extender varias funciones de una manera DRY, así:
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
Por supuesto, lo bueno de los decoradores es que puede usarlos de inmediato en casi cualquier cosa sin tener que volver a escribir. SECO, dije:
@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 proporciona varios decoradores: property , staticmethod , etc.
- Django utiliza decoradores para administrar el almacenamiento en caché y ver los permisos.
- Torcido para falsificar las llamadas de funciones asíncronas en línea.
Esto realmente es un gran patio de recreo.
Y, por supuesto, también puede devolver las lambdas desde una función decoradora:
def makebold(f):
return lambda: "<b>" + f() + "</b>"
def makeitalic(f):
return lambda: "<i>" + f() + "</i>"
@makebold
@makeitalic
def say():
return "Hello"
print say()
Esta respuesta ha sido respondida durante mucho tiempo, pero pensé que compartiría mi clase de Decorador, lo que hace que escribir nuevos decoradores sea fácil y compacto.
from abc import ABCMeta, abstractclassmethod
class Decorator(metaclass=ABCMeta):
""" Acts as a base class for all decorators """
def __init__(self):
self.method = None
def __call__(self, method):
self.method = method
return self.call
@abstractclassmethod
def call(self, *args, **kwargs):
return self.method(*args, **kwargs)
Por un lado, creo que esto hace que el comportamiento de los decoradores sea muy claro, pero también facilita la definición concisa de los nuevos decoradores. Para el ejemplo enumerado anteriormente, podría resolverlo como:
class MakeBold(Decorator):
def call():
return "<b>" + self.method() + "</b>"
class MakeItalic(Decorator):
def call():
return "<i>" + self.method() + "</i>"
@MakeBold()
@MakeItalic()
def say():
return "Hello"
También podría usarlo para realizar tareas más complejas, como por ejemplo un decorador que automáticamente hace que la función se aplique recursivamente a todos los argumentos en un iterador:
class ApplyRecursive(Decorator):
def __init__(self, *types):
super().__init__()
if not len(types):
types = (dict, list, tuple, set)
self._types = types
def call(self, arg):
if dict in self._types and isinstance(arg, dict):
return {key: self.call(value) for key, value in arg.items()}
if set in self._types and isinstance(arg, set):
return set(self.call(value) for value in arg)
if tuple in self._types and isinstance(arg, tuple):
return tuple(self.call(value) for value in arg)
if list in self._types and isinstance(arg, list):
return list(self.call(value) for value in arg)
return self.method(arg)
@ApplyRecursive(tuple, set, dict)
def double(arg):
return 2*arg
print(double(1))
print(double({''a'': 1, ''b'': 2}))
print(double({1, 2, 3}))
print(double((1, 2, 3, 4)))
print(double([1, 2, 3, 4, 5]))
Que imprime:
2
{''a'': 2, ''b'': 4}
{2, 4, 6}
(2, 4, 6, 8)
[1, 2, 3, 4, 5, 1, 2, 3, 4, 5]
Tenga en cuenta que este ejemplo no incluyó el listtipo en la creación de instancias del decorador, por lo que en la declaración de impresión final el método se aplica a la lista en sí, no a los elementos de la lista.
Dios bendiga.
Hablando del ejemplo del contador, como se indicó anteriormente, el contador se compartirá entre todas las funciones que utilizan el decorador:
def counter(func):
def wrapped(*args, **kws):
print ''Called #%i'' % wrapped.count
wrapped.count += 1
return func(*args, **kws)
wrapped.count = 0
return wrapped
De esa manera, su decorador puede ser reutilizado para diferentes funciones (o usado para decorar la misma función varias veces:) func_counter1 = counter(func); func_counter2 = counter(func), y la variable del contador permanecerá privada para cada una.
Otra forma de hacer lo mismo:
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, más flexiblemente:
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''
Para explicar el decorador de una manera más sencilla:
Con:
@decor1
@decor2
def func(*args, **kwargs):
pass
Cuando hacer
func(*args, **kwargs)
Realmente lo haces:
decor1(decor2(func))(*args, **kwargs)
Un decorador toma la definición de la función y crea una nueva función que ejecuta esta función y transforma el resultado.
@deco
def do():
...
es eqivarent para
do = deco(do)
Ejemplo:
def deco(func):
def inner(letter):
return func(letter).upper() #upper
return inner
Esta
@deco
def do(number):
return chr(number) # number to letter
es equivalente a este def do2 (número): return chr (número)
do2 = deco(do2)
65 <=> ''a''
print(do(65))
print(do2(65))
>>> B
>>> B
Para entender al decorador, es importante tener en cuenta que el decorador creó una nueva función que es interna que ejecuta la función y transforma el resultado.
Aquí hay un ejemplo simple de encadenar decoradores. Observe la última línea: muestra lo que está pasando debajo de las cubiertas.
############################################################
#
# 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 salida se ve como:
17/6/2013
<b>17/6/2013</b>
6/17/2013
<b>6/17/2013</b>
<b>6/17/2013</b>
Usted podría hacer dos decoradores independientes que hacen lo que usted quiere, como se ilustra a continuación directamente. Observe el uso de *args, **kwargsen la declaración de la wrapped()función que admite la función decorada con múltiples argumentos (que no es realmente necesario para la say()función de ejemplo , pero se incluye para generalidad)
Por razones similares, el functools.wrapsdecorador se usa para cambiar los meta atributos de la función envuelta para que sean los del decorado. Esto hace que los mensajes de error y la documentación de la función incorporada ( func.__doc__) sean los de la función decorada en lugar 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>
Refinamientos
Como puede ver, hay muchos códigos duplicados en estos dos decoradores. Dada esta similitud, sería mejor que usted creara una genérica que en realidad era una fábrica de decoradores; en otras palabras, un decorador que crea otros decoradores. De esa manera, habría menos repetición de código y permitiría seguir el 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>
Para hacer que el código sea más legible, puede asignar un nombre más descriptivo a los decoradores generados en fábrica:
makebold = html_deco(''b'')
makeitalic = html_deco(''i'')
@makebold
@makeitalic
def greet(whom=''''):
return ''Hello'' + ('' '' + whom) if whom else ''''
print(greet(''world'')) # -> <b><i>Hello world</i></b>
O incluso combinarlos de esta manera:
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>
Eficiencia
Si bien los ejemplos anteriores funcionan correctamente, el código generado implica una gran cantidad de gastos generales en forma de llamadas de funciones extrañas cuando se aplican varios decoradores a la vez. Esto puede no importar, dependiendo del uso exacto (que podría estar vinculado a E / S, por ejemplo).
Si la velocidad de la función decorada es importante, la sobrecarga se puede mantener en una sola función de función adicional escribiendo una función de fábrica de decorador ligeramente diferente que implementa la adición de todas las etiquetas a la vez, para que pueda generar un código que evite las funciones adicionales llamadas mediante el uso de decoradores separados para cada etiqueta.
Esto requiere más código en el decorador en sí, pero solo se ejecuta cuando se aplica a definiciones de funciones, no más tarde cuando se llaman ellas mismas. Esto también se aplica cuando se crean nombres más legibles utilizando lambdafunciones como se ilustró anteriormente. Muestra:
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>
#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()
También puedes escribir decorador en clase.
#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")