Gestión de los warnings en Python: Controlando el flujo de información

Los mensajes de advertencia en Python, a los que se les suele llamar por su nombre en inglés warnings, informa de posibles problemas durante la ejecución del código. Sin interrumpir la ejecución del código como sí hacen los errores. Los warnings son mensajes no críticos que se deben tener en cuenta para mejorar los programas y evitar posibles errores. En esta entrada, se analizará en detalle la gestión de los warnings en Python. Explicando los tipos de mensajes de warning que hay, la forma de ocular (tanto de forma genérica como selectiva), reactivar los mensajes de warning después de ocultarlos y como lanzarlos desde funciones propias.

Por qué son importantes los mensajes de warning

Antes de analizar la gestión de los mensajes de advertencia o warnings en Python es importante conocer por qué son importantes. Ayudando a mejorar la calidad del código. Básicamente, los mensajes de advertencia sirven para:

• Detectar posibles problemas: Las advertencias pueden ayudar a identificar situaciones que podrían conducir a errores o resultados inesperados en el código.
• Mantener la compatibilidad: Las advertencias de depreciación avisan a sobre características que pronto serán eliminadas, o cambiarán su funcionamiento, en futuras versiones, lo que permite actualizar el código para que siga funcionando.
• Facilitar la depuración: Las advertencias pueden proporcionar pistas útiles durante la depuración, ayudando a identificar rápidamente las partes problemáticas en los códigos.

Gestión de los warnings en Python

Una vez analizado la importancia de los mensajes de warning, se puede ver cómo gestionarlos de manera efectiva en Python.

Ocultar los mensajes de warning

En algunas ocasiones, especialmente cuando se trabaja con bibliotecas de terceros que generan advertencias innecesarias o molestas, una solución al problema es ocultar los mensajes de warning. Para hacer esto, se debe usar la función warnings.filterwarnings() con el argumento "ignore". Lo que se muestra en el siguiente ejemplo de código.

import warnings

# Ocultar todas las advertencias
warnings.filterwarnings("ignore")

Una vez ejecutada esta línea de código, se dejará de mostrar cualquier advertencia en la sesión o programa. Haciendo que el usuario no los vea. Algo que puede ser útil, especialmente para evitar que un usuario sin conocimientos técnicos los confunda con errores. Sin embargo, ocultar los mensajes de warning puede hacer que no se muestre información importante sobre posibles problemas en el código. Generalmente es una mejor opción filtrar los mensajes de una forma selectiva, ocultando solamente aquellos que no son necesarios.

Filtrar los mensajes de warning de forma selectiva

En lugar de ocultar todas las advertencias, a veces es mejor filtrarlas selectivamente para mostrar solo las que son relevantes. Lo que se puede pasar como segundo parámetro de la función warnings.filterwarnings() el tiempo de mensaje que se desea ocultar.

import warnings

# Ocultar advertencias específicas
warnings.filterwarnings("ignore", category=DeprecationWarning)

En este ejemplo, únicamente se dejarán de mostrar las advertencias de depreciación. El resto de mensajes de warning se seguirán mostrando cuando sea necesario. Lo que permite enfocar el proceso de depuración en las advertencias específicas que son relevantes.

En Python, existen varias categorías de advertencias que se pueden usar para filtrarlas de forma selectiva. Las categorías más comunes de mensajes de warning son:

• DeprecationWarning: Se emite cuando se utiliza una característica obsoleta que pronto será eliminada.
• SyntaxWarning: Se emite cuando hay algún problema de sintaxis que podría llevar a un comportamiento inesperado.
• RuntimeWarning: Se emite cuando se detecta un problema que no necesariamente causa un error, pero podría indicar un problema en tiempo de ejecución.
• FutureWarning: Se emite cuando se utiliza una característica que se comportará de manera diferente en versiones futuras de Python.
• UserWarning: Se utiliza cuando se desea emitir una advertencia personalizada desde el propio código del usuario.

Restaurar los mensajes de warning

Después de haber ocultado advertencias, es posible que se desee restaurar estas. Por ejemplo, una vez finalizado una parte del programa donde se generan demasiadas advertencias innecesarias. Para restablecer la configuración de advertencias a su estado predeterminado solamente se debe llamar a la función warnings.resetwarnings(), tal como se muestra a continuación.

import warnings

# Restaurar todas las advertencias
warnings.resetwarnings()

Lanzar mensajes de warning desde funciones propias

Los mensajes de warning no solamente los pueden lanzar Python y las librerías de terceros, sino que también se puede incluir en funciones propias. Una opción para informar a los usuarios de posibles problemas. Al igual que para la gestión de advertencias se debe importar warnings y usar la función warnings.warn() con el mensaje de warning como primer parámetro y la advertencia como segundo. Un ejemplo se puede ver en la siguiente función donde se lanza un mensaje cuando se le pasa en el parámetro el valor 42.

import warnings

def mi_funcion(algo):
    if algo == 42:
        warnings.warn("¡Cuidado! El valor es 42.", DeprecationWarning)

En este ejemplo, la función mi_funcion() lanzará una advertencia de depreciación si el argumento es igual a 42. Una advertencia graciosa con la que se puede ver claramente el proceso para lanzar estos mensajes.

Conclusiones

En esta entrada, se ha explorado en detalle cómo gestionar los mensajes de warning o advertencias en Python. Empezando por cómo ocultar advertencias, hasta lanzarlas de manera controlada desde el código propio. Recordemos siempre la importancia de las advertencias como herramienta para mejorar la calidad del código y la experiencia de desarrollo en Python. Por lo que no es recomendable ocultarlas como solución, sino gestionarlas para que el código sea funcional y fiable.

Imagen de 8ocho8 en Pixabay