notifications Notificaciones

Marcar todas como leídas

Ver más

lightbulb_outline

Decoradores en Python

timer 4 Min.

remove_red_eye 2125

calendar_today 13/03/20

Sin duda de unos de los features que más utilizo en mi día a día, al trabajar con Python, son los decoradores. A través de los decoradores seremos capaces reducir las líneas de código duplicadas, haremos que nuestro código sea legible, fácil de testear, fácil de mantener y sobre todo, tendremos un código mucho más Pythonico. Es por ello que en esta ocasión me gustaría que habláramos de los decoradores, de cómo podemos crearlos, implementarlos y sobre todo, sacarles el máximo provecho posible. 🐍

Bien, una vez dicho todo esto y sin más dilación comencemos.

Decoradores

Antes de entrar de lleno con el tema de decoradores es importante mencionar que en Python las funciones son ciudadanos de primera clase, eso quiere decir que una función puede ser asignada a una variable, puede ser utilizada como argumento para otra función, o inclusive puede ser retornada. Veamos un ejemplo.

def saludar(): 
    print('Hola soy una función') 

def super_funcion(funcion): 
    funcion() 

funcion = saludar  # Asignamos la función a una variable!

super_funcion(funcion)      

Listo, una vez con esto en cuenta ya podemos pasar el tema de decoradores. Si nunca oíste hablar de los decoradores, no te preocupes, aquí te lo explicamos. Verás, un decorador no es más que una función la cual toma como input una función y asu vez retorna otra función. Puede sonar algo confuso ¿no? lo que nos debe quedar claro es que al momento de implementar un decorador estaremos trabajando, con por lo menos, 3 funciones. El input, el output y la función principal. Para que nos quede más en claro a mi me gusta nombrar a las funciones como: a, b y c.

Donde a recibe como parámetro b para dar como salida a c. Esta es una pequeña "formula" la cual me gusta mucho mencionar. 💻

a(b) -> c

Veamos un ejemplo de como crear un decorador en Python.

def funcion_a(funcion_b):
    def funcion_c():
        print('Antes de la ejecución de la función a decorar')
        funcion_b()
        print('Después de la ejecución de la función a decorar')

    return funcion_c

Ya tenemos el decorador creado, ahora lo que nos hace falta es decorar una función. Al nosotros utilizar la palabra decorar estamos indicando que queremos modificar el comportamiento de una función ya existente, pero sin tener que modificar su código. Esto es muy útil, principalmente, cuando queremos extender nuevas funcionalidades a dicha función. De allí el nombre decorar.

Si me permiten, una buena analogía sería ver este tema como un pastel, donde, en ocasiones, la base del pastel (el pan) no es suficiente para una fiesta y debemos añadir elementos extras, quizás glaseado, velas, aderezos etc ... de esta forma el pastel se verá mucho mejor y lo más importante sabrá mucho mejor. 🎂

En la analogía la base del pastel no será más que nuestra función a decorar y los elementos extras los decoradores.

Para decorar una función basta con colocar, en su parte superior de dicha función, el decorador con el prefijo @.

@funcion_a
def saludar():
    print('Hola mundo!!')

Ahora, ¿Qué pasa si nuestra función a decorar debe recibir argumentos y a su vez debe retornar algún valor? en estos casos haremos uso de los parámetros args y kwargs.

def funcion_a(funcion_b):
    def funcion_c(*args, **kwargs):
        print('Antes de la ejecución de la función a decorar')
        result = funcion_b(*args, **kwargs)
        print('Después de la ejecución de la función a decorar')    

        return result

    return funcion_c

@funcion_a
def suma(a, b):
    return a + b

La sintaxis puede llegar a hacer algo compleja, pero en terminos simples podemos traducirlo a :

>>> decorador = funcion_a(suma)
>>> decorador(10, 20)  

Antes de la ejecución de la función a decorar
Después de la ejecución de la función a decorar
30

Al utilizar los parámetros args y kwargs seremos capaces de reutilizar el decorador, haciendolo aún más flexible de lo que ya es.

Algo que me gustaría mencionar, es que por convención, no es una regla, la función anidada del decorador tendrá por nombre: wrapper, de igual forma, el nombre del decorador debe ser muy descriptivo. En términos simples, el decorador pudiera quedar de la siguiente manera.

def my_custome_decorator(function):
    def wrapper(*args, **kwargs):
        return function(*args, **kwargs)

    return wrapper

Este ejemplo funciona, pero, trabajamos con un ejemplo, un poco más real. Calculemos cuánto le toma a una función completar su ejecución.

def measure_time(function):
    def wrapper(*args, **kwargs):
        import time

        start = time.time()
        result = function(*args, **kwargs)
        total = time.time() - start
        print(total, 'seconds' )
        return result

    return wrapper


@measure_time
def suma(a, b):
    import time
    time.sleep(1)
    return a + b

print(suma(10, 20))

Perfecto, ya sabemos crear e implementar decoradores, sin embargo aún podemos complicar las cosas un poco más. Como mencionamos anteriormente los decoradores no son más que funciones que reciben como argumento otras funciones, en ese caso, ¿Es posible pasar argumentos extras a los decoradores? 🧐La respuesta es sí. 😉

def my_decorator_name(name):
    def my_custome_decorator(function):
        def wrapper(*args, **kwargs):

            print('Name:', name)
            return function(*args, **kwargs)

        return wrapper

    return my_custome_decorator

@my_decorator_name('CodigoFácilito')
def suma(a, b):
    return a + b

En este caso tuvimos que agregar una cuarta función, la cual recibiría los parámetros necesarios. Aquí sin duda las cosas ya se complican más, ya que ahora estamos trabajando con otro tema, el tema de los closures, tema el cual sin duda explicaremos en otra ocasión.

Ya para finalizar, algo que debemos tener muy en cuenta es que los decoradores no están limitados únicamente y exclusivamente a funciones o métodos, para nada, de igual forma podremos decorar clases, sí, leíste bien, clases. Si te interesa conocer más acerca del tema te comparto un vídeo en donde te lo explicamos más en detalle .🐍


Sin duda el tema de los decoradores es sumamente interesante, y puedo asegurarte que si aun no lo utilizas eventualmente lo harás, ya sea por que algún framework te lo pida, encuentres código duplicado, quieras mejorar el código de tu proyecto, o por cualquier otra razón, tarde o temprano harás uso de los decoradores, feature de Python, el cual considero yo, uno de los mejores.

Otros artículos del blog

Comunidad