¿Cómo hacer decoradores de funciones y encadenarlos?

2934

¿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 hacerlo de HTMLesta manera en una aplicación real, solo trato de entender cómo funcionan los decoradores y el encadenamiento de decoradores.

0
3023

Consulte la documentación para ver cómo funcionan los decoradores. Esto es lo que pidió:

from functools import wraps

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

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

@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>"
3
  • 267
    Considere usar functools.wraps o, mejor aún, el módulo decorador de PyPI : conservan ciertos metadatos importantes (como __name__y, hablando sobre el paquete decorador, la firma de la función). Marius Gedminas 11 mar 11 a las 2:30
  • 34
    *argsy **kwargsdebe agregarse en la respuesta. La función decorada puede tener argumentos y se perderán si no se especifican. Blusky 2/04/2017 a las 11:47
  • 4
    Aunque esta respuesta tiene la gran ventaja de usar solo stdlib, y funciona para este ejemplo simple donde no hay argumentos de decorador ni argumentos de función decorada , tiene 3 limitaciones principales: (1) no hay soporte simple para argumentos de decorador opcionales (2) no la firma de preservación (3) hay una forma sencilla de extraer un argumento con nombre de *args, **kwargs. Una manera fácil de resolver estos 3 problemas a la vez es usarlo decopatchcomo se explica aquí . También puedes usar decoratorcomo ya lo mencionó Marius Gedminas, para resolver los puntos 2 y 3.smarie 11/03/19 a las 15:28
4426
+250

Si no le gustan las explicaciones largas, consulte la respuesta de Paolo Bergantino .

Conceptos básicos del decorador

Las funciones de Python son objetos

Para comprender a los decoradores, primero debe comprender 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 as e:
    print(e)
    #outputs: "name 'shout' is not defined"

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

Mantén esto en mente. Volveremos a ello 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 as e:
    print(e)
    #outputs : "name 'whisper' is not defined"*
    #Python's functions are objects

Referencias de funciones

Vale, ¿sigues aquí? Ahora la parte divertida ...

Has visto que las funciones son objetos. Por tanto, funciones:

  • se puede asignar a una variable
  • se puede definir en otra función

Eso significa que una función puede returnotra 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 returnuna 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, 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, probablemente quieras que cada vez que llames a_stand_alone_function, a_stand_alone_function_decoratedse llame en su lugar. Eso es fácil, simplemente sobrescriba a_stand_alone_functioncon 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 del 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. @decoratores solo un atajo para:

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 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 en el que estableces a 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 su cerebro un poco más 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

Métodos de decoración

Una cosa ingeniosa de Python es que los métodos y las funciones son realmente los mismos. 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 selfen cuenta:

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 que aplicará a cualquier función o método, sin importar sus argumentos, simplemente 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, ¿qué dirías ahora sobre pasar argumentos al decorador en sí?

Esto puede volverse algo retorcido, 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 apresurarnos 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. " my_decorator" se llama. Entonces, cuando usted @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 .

Consigamos el 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 es de extrañar aquí.

Hagamos EXACTAMENTE lo mismo, pero omita todas las molestas variables intermedias:

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? ¡Usamos una llamada a 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://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

Aquí está: un decorador con argumentos. Los argumentos se pueden establecer como variables:

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 cualquier función usando este truco. Incluso puedes usarlo *args, **kwargssi lo deseas. Pero recuerde que los decoradores se llaman solo una vez . Justo cuando Python importa el script. No puede establecer dinámicamente los argumentos después. Cuando haces "importar x", la función ya está decorada , por lo que no puedes cambiar nada.


Practiquemos: decorar un decorador

De acuerdo, como beneficio adicional, te daré un fragmento para que cualquier decorador acepte genéricamente cualquier argumento. Después de todo, para aceptar argumentos, creamos nuestro decorador usando otra función.

Envolvimos al decorador.

¿Algo más que vimos recientemente con esa función envuelta?

¡Oh, sí, decoradores!

Divirtámonos y escribamos 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 tuviste este sentimiento fue después de escuchar a un chico decir: "antes de entender la recursividad, primero debes entender la recursividad". Pero ahora, ¿no te sientes bien al 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 se puede quitar la decoración de una función. (No son hacks para crear decoradores que se pueden quitar, pero nadie los usa.) Así que una vez que una función está decorado, está decorado de todo el código .
  • Los decoradores envuelven funciones, lo que puede dificultar su depuración. (Esto mejora con Python> = 2.5; ver más abajo).

El functoolsmódulo se introdujo 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 curioso: ¡ functools.wraps()es decoradora! ☺)

# 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 genial 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 puede modificarla) o para depurarla (no desea modificarla porque es temporal).

Puedes usarlos para extender varias funciones a la manera de 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 puedes usarlos de inmediato en casi cualquier cosa sin tener que reescribir. 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!

Propio Python proporciona varios decoradores: property, staticmethod, etc.

  • Django usa decoradores para administrar el almacenamiento en caché y ver los permisos.
  • Twisted to fake inlining llamadas a funciones asincrónicas.

Este es realmente un gran patio de recreo.

2
  • 21
    "No se puede quitar la decoración de una función". - Aunque normalmente es cierto, es posible acceder al interior del cierre en el retorno de la función mediante un decorador (es decir, a través de su __closure__atributo) para extraer la función original sin decorar. En esta respuesta se documenta un uso de ejemplo que cubre cómo es posible inyectar una función de decorador en un nivel inferior en circunstancias limitadas. metatoaster 22/10/15 a las 0:04
  • 10
    Si bien esta es una gran respuesta, creo que es un poco engañosa de alguna manera. La @decoratorsintaxis de Python probablemente se usa con mayor frecuencia para reemplazar una función con un cierre de envoltura (como describe la respuesta). Pero también puede reemplazar la función con otra cosa. La orden interna property, classmethody staticmethoddecoradores reemplazan la función con un descriptor, por ejemplo. Un decorador también puede hacer algo con una función, como guardar una referencia a ella en un registro de algún tipo y luego devolverla, sin modificar, sin ningún envoltorio. Blckknght 11/04/2016 a las 13:04
151

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 al 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 produciría:

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

No olvide la construcción para la que la sintaxis del decorador es una abreviatura:

say = wrap_in_tag('b')(wrap_in_tag('i')(say)))
1
  • 6
    En mi opinión, es mejor evitar en la medida de lo posible a más de un decorador. Si tuviera que escribir una función de fábrica, la codificaría con * kwargs como def wrap_in_tag(*kwargs)entonces@wrap_in_tag('b','i')guneysus 29/10/2013 a las 22:29
132

Parece que las otras personas ya le han dicho cómo resolver el problema. Espero que esto te ayude a comprender qué son los decoradores.

Los decoradores son simplemente azúcar sintáctico.

Esta

@decorator
def func():
    ...

se expande a

def func():
    ...
func = decorator(func)
2
  • 3
    Esto es tan elegante, simple y fácil de entender. 10000 votos a favor para usted, Sir Ockham. eric 2 de septiembre de 2017 a las 17:01
  • 3
    Gran y sencilla respuesta. Me gustaría agregar que cuando se usa @decorator()(en lugar de @decorator) es azúcar sintáctico para func = decorator()(func). Esta también es una práctica común cuando necesita generar decoradores "sobre la marcha"Omer Dagan 28 de septiembre de 2017 a las 11:00
71

Y, por supuesto, también puede devolver 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()
5
  • 13
    Y un paso más:makebold = lambda f : lambda "<b>" + f() + "</b>"Robᵩ 4 mar 13 a las 22:26
  • 14
    @ Robᵩ: Para ser sintácticamente correcto:makebold = lambda f: lambda: "<b>" + f() + "</b>"martineau 20 dic 2013 a las 16:01
  • 13
    Tarde para la fiesta, pero realmente sugeriríamakebold = lambda f: lambda *a, **k: "<b>" + f(*a, **k) + "</b>" ... seequ 6 feb.15 a las 18:19
  • Esto necesita functools.wrapspara no descartar la cadena de documentos / firma / nombre desayEric 17 de septiembre de 2018 a las 6:58
  • Bueno, lo que importa es si se menciona en tu respuesta. Tener @wrapsotro lugar en esta página no me ayudará cuando imprima help(say)y obtenga "Ayuda sobre la función <lambda>` en lugar de "Ayuda sobre la función, por ejemplo" .Eric 18 de septiembre de 2018 a las 18:02
64

Los decoradores de Python agregan funcionalidad adicional a otra función

Un decorador de 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. Básicamente, lo que 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 "---" después y antes de que se hagan. Podría agregar una letra "---" antes y después de cada declaración de impresión. Pero como no me gusta repetirme, haré decoradora

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

Entonces 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, consulte http://www.ibm.com/developerworks/linux/library/l-cpdecor.html

4
  • Nota tan elegante como las funciones lambda propuestas por @Rune Kaagaardrds 19/08/11 a las 10:46
  • 1
    @Phoenix: El selfargumento es necesario porque el newFunction()definido en addDashes()fue diseñado específicamente para ser un decorador de métodos, no un decorador de funciones generales. El selfargumento representa la instancia de la clase y se pasa a los métodos de la clase, ya sea que lo usen o no; consulte la sección titulada Métodos de decoración en la respuesta de @ e-satis. martineau 12/07/2013 a las 15:46
  • 1
    Imprima la salida también, por favor. user1767754 26 de mayo de 2015 a las 17:38
  • Faltafunctools.wrapsEric 17 de septiembre de 2018 a las 6:58
44

Usted podría hacer dos decoradores independientes que hacen lo que usted quiere, como se ilustra a continuación directamente. Tenga en cuenta el uso de *args, **kwargsen la declaración de la wrapped()función que admite que la función decorada tenga múltiples argumentos (que no es realmente necesario para la say()función de ejemplo , pero se incluye por razones de generalidad).

Por razones similares, el functools.wrapsdecorador se utiliza para cambiar los meta atributos de la función envuelta para que sean los de la que se está decorando. Esto hace que los mensajes de error y la documentación de la función incrustada ( func.__doc__) sean los de la función decorada en lugar de los de la función wrapped().

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 mucho código duplicado en estos dos decoradores. Dada esta similitud, sería mejor que en su lugar creara uno genérico que en realidad fuera una fábrica de decoradores, en otras palabras, una función de decorador que hace a otros decoradores. De esa forma, 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 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 así:

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, el código generado implica una gran cantidad de gastos generales en forma de llamadas a 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 llamada de función adicional escribiendo una función de fábrica del decorador ligeramente diferente que implemente la adición de todas las etiquetas a la vez, para que pueda generar código que evite las llamadas de función adicionales incurridas utilizando decoradores separados para cada etiqueta.

Esto requiere más código en el propio decorador, pero esto solo se ejecuta cuando se aplica a las definiciones de funciones, no más tarde, cuando se llaman a ellas mismas. Esto también se aplica al crear nombres más legibles mediante el uso de 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>
0
23

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, de forma más flexible:

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'
1
  • Necesidades functools.update_wrapperpara mantenersayhi.__name__ == "sayhi"Eric 17 de septiembre de 2018 a las 6:57
21

How can I make two decorators in Python that would do the following?

Quieres la siguiente función, cuando se llama:

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

Regresar:

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

Solución simple

Para hacer esto de manera más simple, cree decoradores que devuelvan lambdas (funciones anónimas) que cierren sobre la función (cierres) y llámenla:

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

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

Ahora utilícelos como desee:

@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 en esta función, o queremos poder decorar funciones que toman más de un argumento, o simplemente queremos saber qué función estamos viendo en una sesión de depuración, necesitamos hacer un poco más con nuestro envoltura.

Solución con todas las funciones: superando 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 algo de repetición, pero esto es tan simple como podemos hacerlo.

En Python 3, también obtiene __qualname__y se __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 envoltura haga casi todo excepto decirnos exactamente qué toma la función como argumentos.

Hay otros módulos que pueden intentar abordar el problema, pero la solución aún no está en la biblioteca estándar.

14

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 equivalente a:

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 esto

def do2(number):
    return chr(number)

do2 = deco(do2)

65 <=> 'a'

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

Para entender al decorador, es importante notar que ese decorador creó una nueva función que es interna que ejecuta la función y transforma el resultado.

0
10
#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")
1
  • 1
    La razón para que me guste una clase aquí es que hay un comportamiento claramente relacionado, con dos instancias. De hecho, puede obtener sus dos decoradores asignando las clases construidas a los nombres que desea, en lugar de repetir los parámetros. Esto es más difícil de hacer con una función. Agregarlo al ejemplo señalaría por qué esto no es solo redundante. Jon Jay Obermark 28/08/14 a las 15:46
10

Esta respuesta ha sido respondida durante mucho tiempo, pero pensé en compartir mi clase de Decorador, 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 deja muy claro el comportamiento de los decoradores, pero también facilita la definición de nuevos decoradores de manera muy concisa. Para el ejemplo mencionado 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 puede usarlo para realizar tareas más complejas, como por ejemplo un decorador que automáticamente hace que la función se aplique de forma recursiva 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 instanciación 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.

8

A continuación, se muestra un ejemplo sencillo de cómo encadenar decoradores. Tenga en cuenta la última línea: muestra lo que está sucediendo debajo de las sábanas.

############################################################
#
#    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 así:

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

Hablando del ejemplo del contador, como se indicó anteriormente, el contador se compartirá entre todas las funciones que usan 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 reutilizarse para diferentes funciones (o usarse para decorar la misma función varias veces :) func_counter1 = counter(func); func_counter2 = counter(func), y la variable de contador permanecerá privada para cada uno.

7

Decora 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  
1
  • 1
    Esto fácilmente podría hacerse aún más versátil al proporcionar también soporte para argumentos de palabras clave a través de def wrapper(*args, **kwargs):y fn(*args, **kwargs). martineau 17 de mayo de 2015 a las 2:33
7

La respuesta de Paolo Bergantino tiene la gran ventaja de usar solo stdlib, y funciona para este ejemplo simple donde no hay argumentos de decorador ni argumentos de función decorados .

Sin embargo, tiene 3 limitaciones principales si desea abordar casos más generales:

  • como ya se señaló en varias respuestas, no puede modificar fácilmente el código para agregar argumentos decoradores opcionales . Por ejemplo, crear un makestyle(style='bold')decorador no es trivial.
  • además, los contenedores creados con @functools.wraps no conservan la firma , por lo que si se proporcionan argumentos incorrectos, comenzarán a ejecutarse y podrían generar un tipo de error diferente al habitual TypeError.
  • Por último, es muy difícil en envoltorios creados con @functools.wrapsal acceder a un argumento basado en su nombre . De hecho, el argumento puede aparecer en *args, en **kwargso puede no aparecer en absoluto (si es opcional).

Escribí decopatchpara resolver el primer problema y escribí makefun.wrapspara resolver los otros dos. Tenga en cuenta que makefunaprovecha el mismo truco que la famosa decoratorlib.

Así es como crearía un decorador con argumentos, devolviendo envoltorios que realmente preservan la firma:

from decopatch import function_decorator, DECORATED
from makefun import wraps

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

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

    return wrapped

decopatchle proporciona otros dos estilos de desarrollo que ocultan o muestran los distintos conceptos de Python, según sus preferencias. El estilo más compacto es el siguiente:

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

En ambos casos puedes comprobar que el decorador funciona como se esperaba:

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

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

Consulte la documentación para obtener más detalles.

0

Agrego un caso cuando necesita agregar parámetros personalizados en el decorador, pasarlo a la función final y luego trabajar con él.

los mismos decoradores:

def jwt_or_redirect(fn):
  @wraps(fn)
  def decorator(*args, **kwargs):
    ...
    return fn(*args, **kwargs)
  return decorator

def jwt_refresh(fn):
  @wraps(fn)
  def decorator(*args, **kwargs):
    ...
    new_kwargs = {'refreshed_jwt': 'xxxxx-xxxxxx'}
    new_kwargs.update(kwargs)
    return fn(*args, **new_kwargs)
  return decorator

y la función final:

@app.route('/')
@jwt_or_redirect
@jwt_refresh
def home_page(*args, **kwargs):
  return kwargs['refreched_jwt']