Depuración de código en Python con Snoop

La depuración es una de las fases más importantes dentro del proceso de desarrollo. Aunque también suele ser una de las más frustrantes. Para solucionar un problema es necesario encontrar la causa del mal funcionamiento, pero, identificar el motivo concreto por el que se obtiene un resultado para unos parámetros dados en una función puede llevar horas. Por lo que contar con unas buenas herramientas es de gran ayuda. Recientemente, he descubierto el paquete Snoop con el que es posible ver todas los pasos y asignaciones que realiza una función, permitiendo ver cuándo se produce el comportamiento erróneo. Haciendo que el proceso de depuración de código en Python sea un proceso más simple.

Instalación de Snoop

Antes de poder usar Snoop es necesario instalarlo en nuestro sistema, algo que se puede hacer fácilmente con pip. Solamente hay que escribir en la terminal el siguiente comando

pip install snoop

Depurar una función en Python con Snoop

Una vez instalado Snoop, para emplearlo en nuestro código solamente hay que importarlo y usar el decorador @snoop antes de la función que deseamos evaluar. Por ejemplo, para depurar una función simple de suma se puede escribir el siguiente código

import snoop

@snoop
def sum_range(a, b):
    result = a + b
    return result

sum_range(10, 20)

19:47:07.56 >>> Call to sum_range in File "<ipython-input-1-4a686faa18e9>", line 4
19:47:07.56 ...... a = 10
19:47:07.56 ...... b = 20
19:47:07.56    4 | def sum_range(a, b):
19:47:07.56    5 |     result = a + b
19:47:07.56 .......... result = 30
19:47:07.56    6 |     return result
19:47:07.56 <<< Return value from sum_range: 30

Obteniendo como resultado la hora en la que se ejecutó cada línea y los valores asignados en cada una de estas. Por ejemplo, se puede ver que se ha pasado como parámetro los valores 10 y 20, en la línea 5 se suma los valores en resutls, obteniendo como resultado 30, y este es el resultado de la función.

En este caso los resultados son triviales, pero en muchas ocasiones no se sabe cuales son los parámetros que llegan a la función y sí estos son la causa del error.

Ver la evolución de un bucle en una función

La potencia de la librería se puede apreciar mejor con ejemplos un poco más complejos. Por ejemplo, una función que tenga un bucle for. Muchos de los problemas que tenemos a la hora de depurar es encontrar el cual de los pasos de un bucle se produce un error. Algo que se soluciona imprimiendo por pantalla todos los pasos intermedios del bucle. ¡Justamente lo que hace Snoop!. Además de hacerlo con un decorador, no llenando el código de funciones print.

Así, en el siguiente ejemplo, donde se han creado una función con la que se suman los valores de un vector es posible ver la evolución de los resultados.

import snoop

@snoop
def sum_vect(vect):
    result = 0
    
    for v in vect:
        result += v
        
    return result


sum_vect([1, 2, 3])

19:47:07.77 >>> Call to sum_vect in File "<ipython-input-2-4d85fcd4b492>", line 4
19:47:07.77 ...... vect = [1, 2, 3]
19:47:07.77 ...... len(vect) = 3
19:47:07.77    4 | def sum_vect(vect):
19:47:07.77    5 |     result = 0
19:47:07.78    7 |     for v in vect:
19:47:07.78 .......... v = 1
19:47:07.78    8 |         result += v
19:47:07.82 .............. result = 1
19:47:07.82    7 |     for v in vect:
19:47:07.88 .......... v = 2
19:47:07.88    8 |         result += v
19:47:07.89 .............. result = 3
19:47:07.89    7 |     for v in vect:
19:47:07.89 .......... v = 3
19:47:07.89    8 |         result += v
19:47:07.90 .............. result = 6
19:47:07.90    7 |     for v in vect:
19:47:07.90   10 |     return result
19:47:07.93 <<< Return value from sum_vect: 6

En el caso de que el error en nuestro código se produzca en uno de los pasos se podrá ver fácilmente cuál de ellos es.

Ver los pasos en funciones recursivas

Otro problema a la hora de depurar suele ser las funciones recursivas, puede que el error se produzca en una de las llamadas. Por ejemplo, la función Fibonacci, una función que se ha usado en múltiples ocasiones para comparar el rendimiento y ver como mejorar este con herramientas como Cython o Numba. En este tipo de funciones cada una de llamadas aparece indentada, por lo que se puede diferenciar fácilmente los resultados en cada una de estas.

import snoop

@snoop
def fibonacci(n):
    if n < 2:
        return n
    else:
        return fibonacci(n-1) + fibonacci(n-2)


fibonacci(3)

19:47:07.95 >>> Call to fibonacci in File "<ipython-input-3-3a8a2a235e67>", line 4
19:47:07.95 ...... n = 3
19:47:07.95    4 | def fibonacci(n):
19:47:07.95    5 |     if n < 2:
19:47:07.95    8 |         return fibonacci(n-1) + fibonacci(n-2)
    19:47:07.95 >>> Call to fibonacci in File "<ipython-input-3-3a8a2a235e67>", line 4
    19:47:07.95 ...... n = 2
    19:47:07.95    4 | def fibonacci(n):
    19:47:07.95    5 |     if n < 2:
    19:47:07.96    8 |         return fibonacci(n-1) + fibonacci(n-2)
        19:47:07.96 >>> Call to fibonacci in File "<ipython-input-3-3a8a2a235e67>", line 4
        19:47:07.96 ...... n = 1
        19:47:07.96    4 | def fibonacci(n):
        19:47:07.96    5 |     if n < 2:
        19:47:07.96    6 |         return n
        19:47:07.96 <<< Return value from fibonacci: 1
        19:47:07.96 >>> Call to fibonacci in File "<ipython-input-3-3a8a2a235e67>", line 4
        19:47:07.96 ...... n = 0
        19:47:07.96    4 | def fibonacci(n):
        19:47:07.96    5 |     if n < 2:
        19:47:07.97    6 |         return n
        19:47:07.97 <<< Return value from fibonacci: 0
    19:47:07.97    8 |         return fibonacci(n-1) + fibonacci(n-2)
    19:47:07.97 <<< Return value from fibonacci: 1
    19:47:07.97 >>> Call to fibonacci in File "<ipython-input-3-3a8a2a235e67>", line 4
    19:47:07.97 ...... n = 1
    19:47:07.97    4 | def fibonacci(n):
    19:47:07.97    5 |     if n < 2:
    19:47:07.97    6 |         return n
    19:47:07.97 <<< Return value from fibonacci: 1
19:47:07.98    8 |         return fibonacci(n-1) + fibonacci(n-2)
19:47:07.98 <<< Return value from fibonacci: 2

Conclusiones

Hoy hemos descubierto una librería gracias a la cual la depuración de código en Python se puede realizar de una forma bastante sencilla. Solamente con el uso del decorador @snoop se puede sacar por pantalla todos los pasos de una función. Incluyendo el tiempo, algo que puede ser clave a la hora de localizar cuellos de botella en nuestro código.

Imagen de Dhruvil Patel en Pixabay