Introducción a los decoradores Python

En Python, un decorador es un patrón de diseño que podemos usar para agregar nueva funcionalidad a un objeto ya existente sin necesidad de modificar su estructura. Un...

Introducción

En Python, un decorador es un patrón de diseño que podemos usar para agregar nueva funcionalidad a un objeto ya existente sin necesidad de modificar su estructura. Se debe llamar a un decorador directamente antes de la función que se va a extender. Con los decoradores, puede modificar la funcionalidad de un método, una función o una clase dinámicamente sin usar subclases directamente. Esta es una buena idea cuando desea ampliar la funcionalidad de una función que no desea modificar directamente. Los patrones de decorador se pueden implementar en todas partes, pero Python proporciona una sintaxis y características más expresivas para eso.

En este artículo, discutiremos los decoradores de Python en detalle.

Cómo crear decoradores

Veamos cómo se pueden crear decoradores en Python. Como ejemplo, crearemos un decorador que podemos usar para convertir la cadena de salida de una función en minúsculas. Para hacerlo, necesitamos crear una función de decorador y necesitamos definir un envoltorio dentro de ella. Mira el siguiente guión:

1
2
3
4
5
6
7
def lowercase(func):
    def wrapper():
        func_ret = func()
        change_to_lowercase = func_ret.lower()
        return change_to_lowercase

    return wrapper

En el script anterior, simplemente hemos creado un decorador llamado minúsculas que toma una función como argumento. Para probar nuestra función minúsculas necesitamos crear una nueva función y luego pasarla a este decorador. Tenga en cuenta que dado que las funciones son de primera clase en Python, puede asignar la función a una variable o tratarla como tal. Emplearemos este truco para llamar a la función decoradora:

1
2
3
4
5
def hello_function():
    return 'HELLO WORLD'

decorate = lowercase(hello_function)
print(decorate())

Producción

1
hello world

Tenga en cuenta que puede fusionar las dos piezas de código anteriores en una sola. Creamos la función hello_function() que devuelve la frase "HOLA MUNDO". Luego llamamos al decorador y pasamos el nombre de esta función como argumento mientras lo asignábamos a la variable "decorar". Cuando se ejecuta, puede ver que la oración resultante se convirtió en minúsculas.

Sin embargo, hay una forma más fácil de aplicar decoradores en Python. Simplemente podemos agregar el símbolo @ antes del nombre de la función decoradora justo encima de la función que se va a decorar. Por ejemplo:

1
2
3
4
5
@lowercase
def hello_function():
    return 'HELLO WORLD'

print(hello_function())

Producción

1
hello world

Cómo aplicar varios decoradores a una función

Python nos permite aplicar más de un decorador a una sola función. Para hacer esto correctamente, asegúrese de aplicar los decoradores en el mismo orden en que los ejecutaría como código normal. Por ejemplo, considere el siguiente decorador:

1
2
3
4
5
6
7
def split_sentence(func):
    def wrapper():
        func_ret = func()
        output = func_ret.split()
        return output

    return wrapper

Aquí hemos creado un decorador que toma una oración de entrada y la divide en varias partes. Al decorador se le ha dado el nombre split_sentence. Apliquemos ahora los decoradores minúsculas y split_sentence a una función.

Para ejecutar estas operaciones en el orden correcto, aplíquelas de la siguiente manera:

1
2
3
4
5
@split_sentence
@lowercase
def hello_function():
    return 'HELLO WORLD'
print(hello_function())

Producción

1
['hello', 'world']

Nuestra oración se dividió en dos y se convirtió a minúsculas ya que aplicamos los decoradores minúsculas y split_sentence a hello_function.

Pasar argumentos a funciones de decorador {#pasar argumentos a funciones de decorador}

Los decoradores de Python también pueden interceptar los argumentos que se pasan a las funciones decoradas. Los argumentos, a su vez, se pasarán a la función decorada en tiempo de ejecución. Considere el siguiente ejemplo:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
def my_decorator(func):
    def my_wrapper(argument1, argument2):
        print("The arguments are: {0}, {1}".format(argument1, argument2))
        func(argument1, argument2)
    return my_wrapper


@my_decorator
def names(firstName, secondName):
    print("Your first and second names are {0} and {1} respectively".format(firstName, secondName))

print(names("Nicholas", "Samuel"))

Producción

1
2
The arguments are: Nicholas, Samuel
Your first and second names are Nicholas and Samuel respectively

En el script anterior, el decorador acepta dos argumentos: argumento1 y argumento1.

Creación de decoradores de uso general

Los decoradores de uso general se pueden aplicar a cualquier función. Este tipo de decoradores son muy útiles para fines de depuración, por ejemplo.

Podemos definirlos usando los argumentos args y **kwargs. Todos los argumentos posicionales y de palabras clave se almacenan en estas dos variables, respectivamente. Con args y kwargs, podemos pasar cualquier número de argumentos durante una llamada de función. Por ejemplo:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
def my_decorator(func):
    def my_wrapper(*args, **kwargs):
        print('Positional arguments:', args)
        print('Keyword arguments:', kwargs)
        func(*args)
    return my_wrapper

@my_decorator
def function_without_arguments():
    print("No arguments")

function_without_arguments()

Producción

1
2
3
Positional arguments: ()
Keyword arguments: {}
No arguments

Como puede ver, no se pasaron argumentos al decorador.

Ahora veamos cómo podemos pasar valores a los argumentos posicionales:

1
2
3
4
5
@my_decorator
def function_with_arguments(x, y, z):
    print(x, y, z)

function_with_arguments(5, 15, 25)

Producción

1
2
3
Positional arguments: (5, 15, 25)
Keyword arguments: {}
5 15 25

Hemos pasado tres argumentos posicionales al decorador. Para pasar argumentos de palabras clave, tenemos que usar palabras clave en la llamada a la función. Aquí hay un ejemplo:

1
2
3
4
5
@my_decorator
def passing_keyword_arguments():
    print("Passing keyword arguments")

passing_keyword_arguments(firstName="Nicholas", secondName="Samuel")

Producción

1
2
3
Positional arguments: ()
Keyword arguments: {'secondName': 'Samuel', 'firstName': 'Nicholas'}
Passing keyword arguments

Se pasaron dos argumentos de palabras clave al decorador.

En la siguiente sección, discutiremos cómo depurar decoradores.

Cómo depurar decoradores

En este punto, debe haber visto que usamos decoradores para envolver funciones. El cierre del contenedor oculta el nombre de la función original, su lista de parámetros y la cadena de documentación.

Por ejemplo: si intentamos obtener los metadatos para el decorador function_with_arguments, obtendremos los metadatos del cierre del contenedor. Demostremos esto:

1
function_with_arguments.__name__

Producción

1
'my_wrapper'

Esto presenta un gran desafío durante la depuración. Sin embargo, Python proporciona el decorador functools.wraps que puede ayudar a resolver este desafío. Funciona copiando los metadatos perdidos a su cierre decorado.

Ahora vamos a demostrar cómo funciona esto:

1
2
3
4
5
6
7
import functools

def lowercase(func):
    @functools.wraps(func)
    def my_wrapper():
        return func().lower()
    return my_wrapper
1
2
3
4
5
6
@lowercase
def hello_function():
    "Saying hello"
    return 'HELLO WORLD'

print(hello_function())

Producción

1
hello world

Como usamos functools.wraps en la función contenedora, podemos inspeccionar los metadatos de la función para "hello_function":

1
hello_function.__name__

Producción

1
'hello_function'
1
hello_function.__doc__

Producción

1
'Saying hello'

La secuencia de comandos anterior muestra claramente que los metadatos ahora se refieren a la función en lugar de al contenedor. Le recomiendo que siempre use functools.wraps cada vez que esté definiendo un decorador. Esto hará que la depuración sea mucho más fácil para usted.

Conclusión

El propósito de los decoradores es cambiar la funcionalidad de una clase, método o función dinámicamente sin usar subclases directamente o cambiar el código fuente de la clase, método o función que necesitamos decorar. En este artículo, vimos cómo crear decoradores simples y de propósito general y cómo pasar argumentos a los decoradores. También vimos cómo depurar los decoradores durante el desarrollo usando el módulo functools.

Licensed under CC BY-NC-SA 4.0