Hoy voy a redactar sobre los decoradores en python. ¿Qué es eso?

Recordamos que una función puede recibir como argumento para su parámetro otra función.

Un decorador es una función que recibe como argumento a otra función para devolver otra función..

Bien, podríamos decirlo también así:

Importante! La función A toma como argumento la función B para devolver una función C

Los decoradores pueden definirse como estereotipos o patrones de diseño. Que permiten a una función (A) o clase de objeto (A) tomar otra función (B) como argumento para devolver una función (C). De esta manera obtendremos funciones dinámicas (que pueden cambiar) sin tener nosotros que cambiar su código fuente!

Un decorador es como un envoltorio con el cual envolvemos una función o una clase.

Bien ahora veamos esto más en profundidad y llevado a la práctica como a mi me gusta! Pero antes déjame aclararte que podemos dividir a los decoradores en grupos, los que permiten argumentos y los que no. Y también los que modifican la firma o signatura del método que decoran y los que no.

Ya te lié! Ya puedo vivir en paz.. Que no! Vamos a crear un decorador, venga!

🖋️ Creando un decorador en python

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pythones.net

# Creamos la función decorador con el argumento `func`
def decorador(func):
    def nueva_funcion():
        print("Perro dice:")  # Añadimos una modificación antes de llamar a la función original
        func()  # Llamamos a la función que se pasó como argumento
    return nueva_funcion  # Devolvemos la nueva función

# Decoramos la función `saluda` con nuestro decorador
@decorador
def saluda():
    print("Guau!")

# Llamamos a la función decorada
saluda()

Resultado:

Perro dice:

Guau!

Como puedes ver en el diagrama la función Saluda() pasará por el decorador siempre dando como resultado una nueva función ejecutada que muestra lo que se encuentra dentro del decorador, es decir, la función Saluda() sale decorada!

A sería el decorador

B sería la función saluda

C sería la función nueva.

En este caso func() que brindamos como argumento será la función a la aplicaremos el decorador.

Bien espero que lo hallas entendido!! Ahora supongamos que definimos otra función bajo de este decorador, que en este caso sera Despedida().

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pythones.net

# Creamos la función decorador (A)
def decorador(func):
    # Creamos la nueva función (C)
    def nueva_funcion():
        print("Perro dice:")  # Añadimos una modificación antes de ejecutar la función original (B)
        func()  # Llamamos a la función original pasada como argumento
    return nueva_funcion  # Retornamos la función modificada (C)

# Decoramos la función saluda con el decorador
@decorador
def saluda():
    print("Guau!")

# Función normal, sin decorar
def despedida():
    print("Chau")

# Llamamos a las funciones
saluda()      # Esta sí está decorada
despedida()   # Esta no lo está

Resultado:

Perro dice:
Guau!
Chau

Como vez no vuelve a imprimir «Perro dice:» porque no se aplico el decorador, para eso debe volverse a colocar antes de la función Despedida() en este caso, así:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pythones.net

# Creamos la función decorador (A)
def decorador(func):
    # Creamos la nueva función (C)
    def nueva_funcion():
        print("Perro dice:")  # Añadimos una modificación antes de ejecutar la función original (B)
        func()  # Llamamos a la función original pasada como argumento
    return nueva_funcion  # Devolvemos la función modificada

# Decoramos la función saluda
@decorador
def saluda():
    print("Guau!")

# Decoramos la función despedida
@decorador
def despedida():
    print("Chau")

# Función sin decorador
def movercola():
    print("El perro mueve la cola")

# Llamadas a las funciones
saluda()       # Decorada
despedida()    # Decorada
movercola()    # No decorada

Resultado:

Perro dice:
Guau!
Perro dice:
Chau
El perro mueve la cola

Bueno, también agregue una función para que mueva la cola sin decorador para que vieras la diferencia.

🫰 Decoradores en clases – python – OOP

Ahora que comprendemos mejor los decoradores en python; vamos a llevar esto para trabajar con clases y descubrir que representa un decorador y como lo aplicamos dentro de la programación orientada a objetos. Anteriormente te había mostrado algunos decoradores en variables de métodos de las clases. Pero ahora utilizamos los nuestros propios.

Seguimos con los perritos que ladran, pero en este caso vamos a crear una clase perro y dentro el método saluda con un mensaje personalizado. Por supuesto vamos a decorar este método utilizando el mismo decorador.

Ejemplo

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pythones.net

# Decorador que recibe una función con self y mensaje
def decorador(func):
    def nueva_funcion(self, mensaje):
        print("Perro dice:")  # Lógica adicional del decorador
        func(self, mensaje)   # Llamamos a la función original con sus argumentos
    return nueva_funcion

# Definimos la clase perro
class perro(object):
    def __init__(self, nombre):
        self.nombre = nombre

    @decorador  # Aplicamos el decorador al método de instancia
    def saluda(self, mensaje):
        self.mensaje = mensaje
        print(mensaje)      # Imprime el mensaje que recibe
        print("Guau!")      # Lógica del método

# Instanciamos el objeto
maty = perro('Maty')

# Llamamos al método decorado
maty.saluda('¡Uso Puppy Linux!')

Resultado:

Perro dice:
Uso Puppy Linux!
Guau!

Excelente, pero si aun no has entendido los decoradores en python lo volvemos a explicar mostrando el orden en el que trabaja el código. Solo para que tengas en cuenta los decoradores son justamente eso, una plantilla, una fabrica de ensamblar una función dentro de otra y devolver una más gorda. Como viste en mi diagrama 😛

Fíjate como funciona con clases, casi igual solo que superpusimos una clase y nuestra función esta dentro como un método de esta clase.

Ahora si lo entiendes!. Verdad?

Cada vez que se llame al método .saluda() primero se pasará por el decorador y el método saldrá modificado.

La dinámica de los decoradores en python

Pero acaso ¿no era que los decoradores nos permitían dinamizar estas funciones en python?, porque estas utilizando los parámetros en el decorador. ¿Y si usáramos el mismo decorador en otro método? ¿Estamos obligados a usar los mismos parámetros para la función func y nueva_funcion o que?.

Aquí con utilizar los mismos parámetros nos referimos a que si utilizáramos el mismo decorador en otro método, el método debería tener el parámetro mensaje. Por lo tanto no estamos dinamizando el decorador, solo sería aplicable a ese método. Pero hay una solución para esto:

En este caso fíjate que cambiamos el parámetro «mensaje» por «parametro1» y volvemos a utilizar el método decorado Saluda() y además añadimos otro método llamado Orden() que también es decorado con el mismo decorador.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# pythones.net

# Decorador que intercepta métodos con un parámetro además de self
def decorador(func):
    def nueva_funcion(instancia, parametro1):
        print("Perro dice:")
        func(instancia, parametro1)
    return nueva_funcion

# Clase perro con dos métodos decorados
class perro(object):
    def __init__(self, nombre):
        self.nombre = nombre

    @decorador
    def saluda(self, mensaje):
        self.mensaje = mensaje
        print(mensaje)
        print("Guau!")

    @decorador
    def ordeno(self, orden):
        self.orden = orden
        print(orden)
        print("¡La pata, la pata afgsad! Guau!")

# Instanciamos
maty = perro('Maty')
maty.saluda('Uso Puppy Linux!')
maty.ordeno('Doy la pata')

Resultado:

Perro dice:
Uso Puppy Linux!
Guau!
Perro dice:
Doy la pata
La pata, la pata afgsad! Guau!

Como ves cambiamos los parámetros de func()por solo parametro1 y self por instanciar. Agregamos otro método al decorador y lo llamamos también!. Todo ok, todo perfecto!!

Esta es la estructura correcta para usar decoradores en clases. Así que a partir de ahora recuerda esto a la hora de trabajar con clases porque te permitirá ahorrar mucho código no teniendo que volver a colocar todo ese código que esta dentro del decorador para cada método.

---

🖌️ Usando clases como decoradores en python

Ahora te la voy a liar más.. Acaso, ¿no notas feo el uso de una función sobre una clase en el código anterior?, es muy desprolijo y estamos modificando un método desde fuera de la clase con una función a secas. ¿Qué tal si creara un decorador que es también una clase?

Como sabes en python todo es o puede ser un objeto. Una función, una clase pueden ser objetos también si así lo deseamos. Podemos utilizar una clase como decorador haciéndola llamable (invocable). Para ello debemos utilizar la función __call__ que nos permitirá emular un objeto como si fuese una función.

Así que venga sin más vueltas vamos a crear una clase que llamaremos «midecorador» de la siguiente manera:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# decoradores.py

# Decorador basado en clase
class midecorador(object):
    def __init__(self, func):  # Recibe la función como parámetro
        print("He construido la clase")
        func()  # Llamamos la función de inmediato al instanciar

    def __call__(self):  # Hacemos la clase "llamable" como una función
        print("Soy una clase llamada mediante __call__")

# Función a decorar
def hablar():
    print("Hola soy la función hablar")

# Aplicamos el decorador manualmente (sin usar @)
matias = midecorador(hablar)  # Se ejecuta __init__
matias()  # Se ejecuta __call__

Resultado:

He construido la clase
Hola soy la función hablar

Instanciamos el objeto matias a la clase «midecorador» brindando como argumento la función que queremos decorar con esta clase. Y dicha función, recordemos en este caso es invocada dentro del init. Por lo que automáticamente se ejecutará con el constructor de la clase siempre que fuera creada una instancia de esta clase.

Pero también podemos recurrir al «@» para decorar sin instanciar.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# decoradores.py

class midecorador(object):
    def __init__(self, func):
        self.func = func  # Guardamos la función
        print("He construido la clase")

    def __call__(self):
        print("Soy una clase llamada mediante __call__")
        self.func()  # Ejecutamos la función decorada

@midecorador
def hablar():
    print("Hola soy la función hablar")

hablar()

Resultado:

He construido la clase
Hola soy la función hablar

Vemos que ni siquiera llamamos la función, sino que solo con decorarla al definirla esta es llamada automáticamente.

Pero si nosotros queremos que la misma no sea llamada automáticamente debemos almacenarla en el constructor y llamarla en el call.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# decoradores.py

class midecorador(object):
    def __init__(self, func):
        # Damos como parámetro una función y la almacenamos
        print("He construido la clase")
        self.func = func

    def __call__(self):
        # Hacemos la clase "llamable"
        print("Soy una clase llamada mediante __call__")
        self.func()  # Ejecutamos la función decorada

@midecorador
def hablar():
    print("Hola soy la función hablar")

# Llamamos la función decorada
hablar()

 

Resultado:

He construido la clase
Soy una clase llamada mediante call
Hola soy la función hablar

También podemos pasarle argumentos a esta función utilizando *args y **kargs en call.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# decoradores.py

class midecorador(object):
    def __init__(self, func):
        # Damos como parámetro una función y la almacenamos
        print("He construido la clase")
        self.func = func

    def __call__(self, *args, **kwargs):
        # Hacemos la clase "llamable" y aceptamos cualquier argumento
        print("Soy una clase llamada mediante __call__")
        self.func(*args, **kwargs)  # Ejecutamos la función decorada con sus argumentos

@midecorador
def hablar(mensaje):
    print(mensaje)

# Llamamos la función decorada pasando argumentos
hablar("Soy un argumento para el parámetro mensaje")

Resultado:

He construido la clase
Soy una clase llamada mediante call
Soy un argumento para el parámetro mensaje

De esta forma hemos aprendido a crear nuestros propios decoradores en python lo que nos permitirán añadir funcionalidades extra a una función.

Y esto es todo por hoy. Necesito dormir!! Espero te halla sido de utilidad y no critiques mis diagramas, que tu con el paint no eres Picasso! Un abrazo y no olvides compartir con aquellos interesados en programar. Nos vemos pronto en otra entrada!