Indice / Herramientas / 0.1

Depurar en VS Code: breakpoints y la consola

Un programa que no anda no se arregla mirandolo fijo. Se para en el medio, se abre y se mira que tiene adentro. Esta leccion es la herramienta que hace eso, y es la que mas tiempo te va a ahorrar en toda la materia.

Para que sirve

Cuando algo da mal, casi todo el mundo hace lo mismo: agrega un print, vuelve a correr, mira, agrega otro print, vuelve a correr. Funciona, y por eso cuesta abandonarlo. Pero tiene tres costos que se pagan todos los dias:

• Cada pregunta cuesta una corrida entera. Con un archivo de 500 filas no se nota; con uno de dos millones, si.
• Solo ves lo que se te ocurrio imprimir. Lo que no sospechabas queda invisible, y el error casi siempre esta ahi.
• Los print quedan. Se olvidan, se commitean, y despues alguien borra el que si servia.

El depurador da vuelta la relacion: en vez de vos preguntandole cosas al programa de a una y por adelantado, el programa se queda quieto y vos le preguntas lo que quieras, en el orden que quieras, con los datos de verdad cargados en memoria. Lo vas a usar cada vez que un TypeError no diga en que columna, que es casi siempre.

Lo minimo que hay que saber

Son cinco teclas y un click. Con eso alcanza para el 90 % de los casos; el resto de la leccion es sacarle punta.

El ejemplo minimo

Este es el programa que vamos a recorrer. Calcula el promedio de las tres notas del primer estudiante, sin pandas todavia: solo la biblioteca estandar.

import csv

def promedio(valores):
    total = 0.0
    for v in valores:
        total = total + float(v)
    return total / len(valores)

with open("estudiantes_notas.csv", encoding="utf-8") as f:
    filas = list(csv.DictReader(f))

fila = filas[0]
notas = [fila["nota_1"], fila["nota_2"], fila["nota_3"]]
print(fila["estudiante"], promedio(notas))

Karina Acosta 7.666666666666667

Lo mismo, paso a paso

Nueve pasos: poner el breakpoint, arrancar, avanzar linea por linea, entrar en la funcion y preguntarle cosas a la consola con el programa detenido. Mira las tres zonas a la vez - el codigo, las variables y la consola -, porque aprender a mirarlas juntas es la habilidad.

Sobre datos de verdad

El programa de arriba anda. Ahora el mismo calculo, con pandas, sobre las 40 filas del archivo:

import pandas as pd

notas = pd.read_csv("estudiantes_notas.csv")
columnas = ["nota_1", "nota_2", "nota_3"]

try:
    notas["promedio"] = notas[columnas].mean(axis=1)
    print(notas["promedio"].round(2).head())
except TypeError as error:
    print("TypeError:", error)

print()
print("El mensaje no dice que columna, ni que fila, ni que valor.")
print("Dice que en algun lado se intento sumar un float con un str.")

TypeError: unsupported operand type(s) for +: 'float' and 'str'

El mensaje no dice que columna, ni que fila, ni que valor.
Dice que en algun lado se intento sumar un float con un str.

Este es el error tipico de la materia, y el mensaje es un ejemplo perfecto de lo inutil que puede ser un mensaje correcto. Dice la verdad - alguien sumo un float con un str - y no dice nada de lo que necesitas: que columna, que fila, que valor. Con tres columnas y 40 filas hay 120 candidatos.

Encontrarlo con el depurador

Cinco preguntas y el caso esta cerrado. Lo importante no es el resultado sino el orden, que es siempre el mismo y sirve para cualquier error de tipos:

1. notas.dtypes - ¿de que tipo quedo cada columna?
2. sorted(col.dropna().unique())[:4] - ¿cual es el valor raro?
3. (col == "-").sum() - ¿cuantas filas?
4. df.loc[col == "-", "legajo"] - ¿cuales?
5. Probar el arreglo ahi mismo, antes de tocar el archivo.

Las tres primeras, escritas como programa, imprimen esto:

import pandas as pd

notas = pd.read_csv("estudiantes_notas.csv")

# Cada una de estas lineas es una expresion que se tipea en la consola con la
# ejecucion detenida. Aca van juntas para poder mostrar sus salidas.
print(notas.dtypes)

print()
print("primeros valores distintos de nota_3, ordenados:")
print(sorted(notas["nota_3"].dropna().unique())[:4])

print()
print("cuantas filas tienen el guion:", int((notas["nota_3"] == "-").sum()))

legajo            str
estudiante        str
nota_1        float64
nota_2        float64
nota_3            str
dtype: object

primeros valores distintos de nota_3, ordenados:
['-', '-1.0', '3.2', '3.4']

cuantas filas tienen el guion: 2

Y la cuarta le pone nombre y apellido al problema:

import pandas as pd

notas = pd.read_csv("estudiantes_notas.csv")

culpables = notas["nota_3"] == "-"
print(notas.loc[culpables].to_string(index=False))

print()
print("Esa misma condicion sirve como breakpoint condicional:")
print('   notas["nota_3"][i] == "-"')
print("y el depurador se detiene solo en esas filas.")

legajo      estudiante  nota_1  nota_2 nota_3
 L2621 Zacarías Juárez     3.5     5.5      -
 L2629  Zacarías Gómez     5.7     5.1      -

Esa misma condicion sirve como breakpoint condicional:
   notas["nota_3"][i] == "-"
y el depurador se detiene solo en esas filas.

Con el arreglo puesto, el programa anda y ademas queda declarado en el codigo que el guion significa ausente:

import pandas as pd

notas = pd.read_csv("estudiantes_notas.csv", na_values=["-"])
columnas = ["nota_1", "nota_2", "nota_3"]

print("dtype de nota_3:", notas["nota_3"].dtype)
print("ausentes en nota_3:", int(notas["nota_3"].isna().sum()))

notas["promedio"] = notas[columnas].mean(axis=1)
print()
print(notas[["legajo", "estudiante", "promedio"]].head(3).round(2).to_string(index=False))

dtype de nota_3: float64
ausentes en nota_3: 5

legajo     estudiante  promedio
 L2601  Karina Acosta      7.67
 L2602 Santiago Ramos      4.67
 L2603     Carla Luna      5.17

La consola de depuracion

Si de toda la leccion te queda una sola cosa, que sea esta. La Consola de depuracion (Ctrl+Shift+Y) no es un panel de mensajes: es un interprete de Python parado adentro de tu programa, en la linea exacta donde esta detenido y con todas sus variables vivas.

Eso cambia como se trabaja. Lo que en un cuaderno de Jupyter harias en una celda nueva, aca lo haces sobre los datos reales del programa, en el punto exacto del problema, sin volver a cargar nada:

Tres cosas mas que rinden mucho

Breakpoint condicional

Frenar en cada una de las 40 vueltas de un bucle para encontrar la fila mala es insoportable. Click derecho en la canaleta → Add Conditional Breakpoint, y se escribe una expresion de Python: el programa frena solo cuando esa expresion da verdadero.

Con el caso de arriba, la condicion seria fila["nota_3"] == "-": de 40 vueltas, frena en 2. Es la diferencia entre usar el depurador y odiarlo.

Logpoint

Click derecho → Add Logpoint. Es un breakpoint que no frena: escribe un mensaje en la consola y sigue. Sirve para lo mismo que un print, con dos ventajas: no toca el archivo (asi que no hay nada que borrar despues) y se pone o se saca sin volver a correr.

Watch

En el panel Watch se anotan expresiones que se recalculan solas en cada paso. Poner ahi notas["nota_3"].dtype y avanzar es ver el tipo de la columna cambiar en vivo, sin escribirlo de nuevo cada vez.

Donde se rompe

Aca hay que elegir

Recetario

Ponete a prueba

notas = pd.read_csv("estudiantes_notas.csv")
columnas = ["nota_1", "nota_2", "nota_3"]

notas["promedio"] = notas[columnas].mean(axis=1)