|
| 1 | +--- |
| 2 | +title: Learning to debug with GitHub Copilot |
| 3 | +intro: 'Identify and fix errors in your code by asking {% data variables.product.prodname_copilot %} for help.' |
| 4 | +topics: |
| 5 | + - Copilot |
| 6 | +versions: |
| 7 | + fpt: '*' |
| 8 | +shortTitle: Debug with Copilot |
| 9 | +--- |
| 10 | + |
| 11 | +Finding and fixing bugs in code can be frustrating, especially when you're a new developer. Thankfully, tools like {% data variables.product.prodname_copilot %} can quickly identify and squash bugs, letting you focus on more creative, interesting work. |
| 12 | + |
| 13 | +## Prerequisites |
| 14 | + |
| 15 | +The examples in this article assume you're using {% data variables.product.prodname_copilot %} to debug a Python project in {% data variables.product.prodname_vscode %} ({% data variables.product.prodname_vscode_shortname %}). To follow the examples, you need to: |
| 16 | +* Complete [Set up {% data variables.product.prodname_vscode %} with {% data variables.product.prodname_copilot_short %}](https://code.visualstudio.com/docs/copilot/setup-simplified) in the {% data variables.product.prodname_vscode %} documentation. |
| 17 | +* [Download Python](https://www.python.org/downloads/). |
| 18 | +* Install the [Python extension for {% data variables.product.prodname_vscode %}](https://marketplace.visualstudio.com/items?itemName=ms-python.python). |
| 19 | + |
| 20 | +## Learning to debug through examples |
| 21 | + |
| 22 | +There are two main situations you'll encounter when you try to run bugged code: |
| 23 | + |
| 24 | +* Your code exits before it finishes running, and you receive an error message. |
| 25 | +* Your code runs without errors, but the output is different from what you expected. |
| 26 | + |
| 27 | +Thankfully, {% data variables.product.prodname_copilot_short %} can help debug your code in both situations. To learn how, work through the following examples. |
| 28 | + |
| 29 | +### Debugging an error with {% data variables.product.prodname_copilot %} |
| 30 | + |
| 31 | +When you run bugged code, you'll often receive an error message. The message tells you the file and line where the error occurred and briefly describes what went wrong. However, error messages can be confusing. To fully understand and fix the bug, we can ask {% data variables.product.prodname_copilot_short %} for help. |
| 32 | + |
| 33 | +Let's try this out with the [`bugged_dice_battle.py`](https://github.com/new2code/debug-with-copilot/blob/main/bugged_dice_battle.py) file in the [`new2code/debug-with-copilot`](https://github.com/new2code/debug-with-copilot) repository. This program simulates a dice battle between two players using the following code: |
| 34 | + |
| 35 | +```python |
| 36 | +# Import the random module to easily generate pseudo-random numbers |
| 37 | +import random |
| 38 | + |
| 39 | +# Define a function that simulates a dice battle between two players |
| 40 | +def dice_battle(): |
| 41 | + |
| 42 | + # Generate random numbers between 1 and 6 for each player's die roll |
| 43 | + die_1 = random.randint(1, 6) |
| 44 | + die_2 = random.randint(1, 6) |
| 45 | + |
| 46 | + # Compare the die rolls and return the result as a string |
| 47 | + if die_1 > die_2: |
| 48 | + return "Player 1 rolled a " + die_1 + " and Player 2 rolled a " + die_2 + ". Player 1 wins!" |
| 49 | + elif die_1 < die_2: |
| 50 | + return "Player 1 rolled a " + die_1 + " and Player 2 rolled a " + die_2 + ". Player 2 wins!" |
| 51 | + else: |
| 52 | + return "Player 1 rolled a " + die_1 + " and Player 2 rolled a " + die_2 + ". It's a tie!" |
| 53 | + |
| 54 | +print(dice_battle()) |
| 55 | +``` |
| 56 | + |
| 57 | +First, we need to clone the repository locally: |
| 58 | +1. In {% data variables.product.prodname_vscode_shortname %}, open the Command Palette by pressing <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux). |
| 59 | +1. Type `Git: Clone` and press <kbd>Enter</kbd>. |
| 60 | +1. Paste the URL of the `new2code/debug-with-copilot` repository: |
| 61 | + |
| 62 | + ```text copy |
| 63 | + https://github.com/new2code/debug-with-copilot |
| 64 | + ``` |
| 65 | + |
| 66 | +1. Press <kbd>Enter</kbd>, then choose a location to save the repository on your computer. |
| 67 | +1. When prompted, open the repository in {% data variables.product.prodname_vscode_shortname %}. |
| 68 | + |
| 69 | +Now that we've cloned the repository, let's run `bugged_dice_battle.py` to see the output: |
| 70 | + |
| 71 | +1. Open the Command Palette by pressing <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux). |
| 72 | +1. Type `Terminal: Create New Terminal` and press <kbd>Enter</kbd>. |
| 73 | +1. If you are using Mac or Linux, in the terminal tab, paste the following code: |
| 74 | + |
| 75 | + ```shell copy |
| 76 | + python bugged_dice_battle.py |
| 77 | + ``` |
| 78 | + |
| 79 | + Otherwise, if you are using Windows, paste the following code: |
| 80 | + |
| 81 | + ```shell copy |
| 82 | + py bugged_dice_battle.py |
| 83 | + ``` |
| 84 | + |
| 85 | +1. Press <kbd>Enter</kbd> to run the program. |
| 86 | + |
| 87 | +Unfortunately, we get some error text in our terminal ending with the following message: `TypeError: can only concatenate str (not "int") to str`. To understand what this means, press <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>I</kbd> (Windows/Linux) to open {% data variables.product.prodname_copilot_chat_short %}, then paste and send the following prompt: |
| 88 | + |
| 89 | +```text copy |
| 90 | +Explain in depth why my code produces the following error and how I can fix it: |
| 91 | +
|
| 92 | +TypeError: can only concatenate str (not "int") to str |
| 93 | +``` |
| 94 | + |
| 95 | +{% data variables.product.prodname_copilot_short %} will respond that the error occurs because we are trying to concatenate the integers `die_1` and `die_2` to strings, and you can only concatenate strings to strings. It will then provide an updated version of our code that fixes the bug by using the `str()` function to convert the integers to strings before concatenating them. |
| 96 | +
|
| 97 | +### Debugging an incorrect output with {% data variables.product.prodname_copilot %} |
| 98 | +
|
| 99 | +Sometimes, bugged code runs without throwing any errors, but the output is clearly incorrect. In this case, debugging can be more difficult because {% data variables.product.prodname_vscode_shortname %} can't tell you the location or description of the bug. |
| 100 | +
|
| 101 | +For these "invisible" bugs, {% data variables.product.prodname_copilot_short %} is particularly useful. Let's get some hands-on experience using the [`bugged_factorial_finder.py`](https://github.com/new2code/debug-with-copilot/blob/main/bugged_factorial_finder.py) file in the [`new2code/debug-with-copilot`](https://github.com/new2code/debug-with-copilot) repository. The Python program is supposed to calculate a factorial, and it contains the following code: |
| 102 | +
|
| 103 | +```python |
| 104 | +# Initialize the factorial result to 1 |
| 105 | +factorial = 1 |
| 106 | + |
| 107 | +# Initialize the input number to 6 |
| 108 | +number = 6 |
| 109 | + |
| 110 | +# Loop from 1 to number (inclusive) and multiply factorial by each number |
| 111 | +for i in range(1, number + 1): |
| 112 | + factorial *= factorial * i |
| 113 | + |
| 114 | +print(f"The factorial of {number} is {factorial}") |
| 115 | +``` |
| 116 | +
|
| 117 | +Since we've already cloned the repository locally, let's run `bugged_factorial_finder.py` to see the output: |
| 118 | +
|
| 119 | +1. In {% data variables.product.prodname_vscode_shortname %}, open the Command Palette by pressing <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux). |
| 120 | +1. Type `Terminal: Create New Terminal` and press <kbd>Enter</kbd>. |
| 121 | +1. If you are using Mac or Linux, in the terminal tab, paste the following code: |
| 122 | +
|
| 123 | + ```shell copy |
| 124 | + python bugged_factorial_finder.py |
| 125 | + ``` |
| 126 | +
|
| 127 | + Otherwise, if you are using Windows, paste the following code: |
| 128 | +
|
| 129 | + ```shell copy |
| 130 | + py bugged_factorial_finder.py |
| 131 | + ``` |
| 132 | +
|
| 133 | +1. Press <kbd>Enter</kbd> to run the program. |
| 134 | +
|
| 135 | +Unfortunately, the code isn't working as expected. We want it to return `720`, the correct value of 6 factorial, but the output is much higher than that. |
| 136 | +
|
| 137 | +To understand what went wrong, with the `bugged_factorial_finder.py` file open in {% data variables.product.prodname_vscode_shortname %}, open {% data variables.product.prodname_copilot_chat_short %} and send the following prompt: |
| 138 | +
|
| 139 | +```text copy |
| 140 | +Why is the output of this code so much higher than expected? Please explain in depth and suggest a solution. |
| 141 | +``` |
| 142 | +
|
| 143 | +{% data variables.product.prodname_copilot_short %} will point out that, because we're using the `*=` operator, we're actually multiplying `factorial` by both `i` **and** `factorial`. In other words, we're multiplying by an extra `factorial` for each iteration of the loop. |
| 144 | +
|
| 145 | +To fix this error, {% data variables.product.prodname_copilot_short %} will suggest code that removes the extra `factorial` from the equation, or that changes the `*=` operator to `=`. |
| 146 | +
|
| 147 | +## Debugging your own project |
| 148 | +
|
| 149 | +Now that you've practiced debugging some simple programs with {% data variables.product.prodname_copilot_short %}, you can use the same methodologies to find and fix bugs hiding in your own work. |
| 150 | +
|
| 151 | +For example, to debug an error message generated by your code, send {% data variables.product.prodname_copilot_short %} the following prompt: |
| 152 | +
|
| 153 | +```text copy |
| 154 | +Explain in depth why my code produces the following error and how I can fix it: |
| 155 | +
|
| 156 | +YOUR-ERROR-MESSAGE |
| 157 | +``` |
| 158 | +
|
| 159 | +Otherwise, if you're debugging an incorrect output, ask {% data variables.product.prodname_copilot_short %} why the output is incorrect and how you can fix it. For the best results, provide as much context as possible on how the output differs from your expectations. |
| 160 | +
|
| 161 | +With these tactics, you're well equipped to start squashing bugs in your project! |
| 162 | +
|
| 163 | +## Next steps |
| 164 | +
|
| 165 | +As you continue coding, you'll likely encounter specific problem scenarios and errors that are difficult to debug. For a list of potential issues and example {% data variables.product.prodname_copilot_chat_short %} prompts to fix them, see [AUTOTITLE](/copilot/example-prompts-for-github-copilot-chat/debugging-errors). |
0 commit comments