Aprender a depurar con GitHub Copilot

Identifica y corrige errores en el código solicitando ayuda a GitHub Copilot.

En este artículo

Encontrar y corregir errores en el código puede ser frustrante, especialmente si acabas de empezar como desarrollador. Afortunadamente, herramientas como GitHub Copilot pueden identificar y solventar rápidamente los errores, lo que te permite centrarte en un trabajo más creativo e interesante.

Requisitos previos

En los ejemplos de este artículo se supone que usas GitHub Copilot para depurar un proyecto de Python en Visual Studio Code (VS Code). Para seguir los ejemplos, debes:

Aprender a depurar a través de ejemplos

Hay dos situaciones principales que encontrarás al intentar ejecutar código con errores:

  • El código se cierra antes de que termine de ejecutarse y recibirás un mensaje de error.
  • El código se ejecuta sin errores, pero la salida es diferente de la esperada.

Afortunadamente, Copilot puede ayudar a depurar el código en ambas situaciones. Para obtener información sobre cómo hacerlo, consulta los ejemplos siguientes.

Depuración de un error con GitHub Copilot

Al ejecutar código con errores, a menudo recibirás un mensaje de error. El mensaje te indica el archivo y la línea donde se produjo el error y describe brevemente lo que salió mal. Sin embargo, los mensajes de error pueden resultar confusos. Para comprender y corregir completamente el error, podemos pedir ayuda a Copilot.

Vamos a probar esto con un repositorio de ejemplo: new2code/debug-with-copilot.

Clonación del repositorio de ejemplos

En primer lugar, es necesario crear una copia local del repositorio:

  1. Empieza clonando el repositorio new2code/debug-with-copilot en VS Code.
  2. Elige una ubicación para guardar el repositorio en el equipo y, a continuación, haz clic en Seleccionar como destino del repositorio.
  3. Cuando se te solicite, abre el repositorio.

Ejecución del archivo con errores

Ahora, vamos a ejecutar el archivo bugged_dice_battle.py. Este programa simula una batalla de dados entre dos jugadores.

  1. En VS Code, abre y revise el archivo bugged_dice_battle.py.

  2. Abre la paleta de comandos presionando Ctrl+Mayús+P (Windows/Linux) o Cmd+Mayús+P (Mac).

  3. Escriba Terminal: Create New Terminal y presione Entrar.

  4. En la pestaña del terminal, pega el siguiente comando.

    Windows:

    Shell
    py bugged_dice_battle.py

    Mac o Linux:

    Shell
    python bugged_dice_battle.py

  5. Presiona Entrar para ejecutar el programa.

Desafortunadamente, obtenemos un texto de error en nuestro terminal que termina con el siguiente mensaje:

TypeError: solo puede concatenar str (no "int") a str

Depuración del archivo

Para entender lo que significa este error, presiona Ctrl+Alt+I (Windows/Linux) o Comando+Mayús+I (Mac) para abrir Copilot Chat, pega y envía la siguiente solicitud:

Text
Explain in depth why my code produces the following error and how I can fix it:

TypeError: can only concatenate str (not "int") to str

Copilot responderá que se produce el error porque estamos intentando concatenar los enteros die_1 y die_2 en las cadenas, y solo se pueden concatenar cadenas en cadenas.

También proporcionará una versión actualizada del código que corrige el error mediante la función str() para convertir los enteros en cadenas antes de concatenarlos. Practica el paso final de depuración aplicando las sugerencias de Copilot al archivo.

Depuración de una salida incorrecta con GitHub Copilot

A veces, se ejecuta código con errores sin producir ningún error, pero la salida es claramente incorrecta. En este caso, la depuración puede ser más difícil porque VS Code no puede indicarle la ubicación ni la descripción del error.

Para estos errores "invisibles", Copilot es particularmente útil. Vamos a obtener cierta experiencia práctica con el otro archivo en nuestro repositorio de ejemplo: bugged_factorial_finder.py. Es un programa de Python que se supone que calcula un factorial.

Ejecución del archivo con errores

En primer lugar, vamos a ejecutar el programa para ver la salida incorrecta:

  1. Abre y revisa el archivo bugged_factorial_finder.py.

  2. En el terminal que creaste anteriormente, pega el siguiente comando. Windows:

    Shell
    py bugged_factorial_finder.py

    Mac o Linux:

    Shell
    python bugged_factorial_finder.py

  3. Presiona Entrar para ejecutar el programa.

Desafortunadamente, el código no funciona según lo esperado. Queremos que devuelva 720, el valor correcto de 6 factoriales, pero la salida es mucho mayor que esa.

Depuración del archivo

Para comprender qué ha salido mal, abre Copilot Chat y envía el siguiente mensaje:

Text
Why is the output of this code so much higher than expected? Please explain in depth and suggest a solution.

Copilot señalará que, al estar usando el operador *=, en realidad estamos multiplicando factorial por i y factorial. En otras palabras, estamos multiplicando por un factorial extra para cada iteración del bucle.

Para corregir este error, Copilot sugerirá código que quite el factorial extra de la ecuación o que cambie el operador *= a =. ¡Haz ese cambio ahora!

Depuración de tu propio proyecto

Ahora que has practicado la depuración de algunos programas sencillos con Copilot, puedes usar las mismas metodologías para buscar y corregir errores ocultos en tu propio trabajo.

Por ejemplo, para depurar un mensaje de error generado por el código, envía a Copilot la siguiente solicitud:

Text
Explain in depth why my code produces the following error and how I can fix it:

YOUR-ERROR-MESSAGE

De lo contrario, si estás depurando una salida incorrecta, pregunta a Copilot por qué la salida es incorrecta y cómo puede corregirla. Para obtener los mejores resultados, proporciona tanto contexto como sea posible sobre cómo la salida difiere de tus expectativas.

Con estas tácticas, tienes todo lo necesario para corregir errores en tu proyecto.

Pasos siguientes

A medida que continúes codificando, es probable que encuentres escenarios de problemas y errores específicos que son difíciles de depurar. Para mostrarte una lista de posibles problemas y ejemplos de solicitudes de Copilot Chat para corregirlos, consulta Depuración de errores.