You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 057679e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: content/get-started/learning-to-code/learning-to-debug-with-github-copilot.md
+21-43Lines changed: 21 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,38 +30,21 @@ Thankfully, {% data variables.product.prodname_copilot_short %} can help debug y
30
30
31
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
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:
33
+
Let's try this out with an example repository: [`new2code/debug-with-copilot`](https://github.com/new2code/debug-with-copilot).
34
34
35
-
```python
36
-
# Import the random module to easily generate pseudo-random numbers
37
-
import random
35
+
#### Cloning the example repository
38
36
39
-
# Define a function that simulates a dice battle between two players
40
-
defdice_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 create a local copy of the example repository:
37
+
First, we need to create a local copy of the repository:
58
38
59
39
1.[Start cloning the new2code/debug-with-copilot repository](vscode://vscode.git/clone?url=https://github.com/new2code/debug-with-copilot) in {% data variables.product.prodname_vscode_shortname %}. <!-- markdownlint-disable-line GHD003 -->
60
40
1. Choose a location to save the repository on your computer, then click **Select as Repository Destination**.
61
41
1. When prompted, open the repository.
62
42
63
-
Now that we've cloned the repository, let's run `bugged_dice_battle.py` to see the output:
43
+
#### Running the bugged file
44
+
45
+
Now, let's run the [`bugged_dice_battle.py`](https://github.com/new2code/debug-with-copilot/blob/main/bugged_dice_battle.py) file. This program simulates a dice battle between two players.
64
46
47
+
1. In {% data variables.product.prodname_vscode_shortname %}, open and review the `bugged_dice_battle.py` file.
65
48
1. Open the Command Palette by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) or <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac).
66
49
1. Type `Terminal: Create New Terminal` and press <kbd>Enter</kbd>.
67
50
1. In the terminal tab, paste the following command.
@@ -84,38 +67,31 @@ Unfortunately, we get some error text in our terminal ending with the following
84
67
85
68
> TypeError: can only concatenate str (not "int") to str
86
69
87
-
To understand what this means, press <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>I</kbd> (Windows/Linux) or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (Mac) to **open {% data variables.product.prodname_copilot_chat_short %}**, then paste and send the following prompt:
70
+
#### Debugging the file
71
+
72
+
To understand what this error means, press <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>I</kbd> (Windows/Linux) or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (Mac) to **open {% data variables.product.prodname_copilot_chat_short %}**, then paste and send the following prompt:
88
73
89
74
```text copy
90
75
Explain in depth why my code produces the following error and how I can fix it:
91
76
92
77
TypeError: can only concatenate str (not "int") to str
93
78
```
94
79
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()`functionto convert the integers to strings before concatenating them.
80
+
{% 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.
81
+
82
+
It will also provide an **updated version of our code** that fixes the bug by using the `str()`functionto convert the integers to strings before concatenating them. Practice the final step of debugging by applying {% data variables.product.prodname_copilot_short %}'s suggestion to the file.
96
83
97
84
### Debugging an incorrect output with {% data variables.product.prodname_copilot %}
98
85
99
86
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
87
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
88
+
For these "invisible" bugs, {% data variables.product.prodname_copilot_short %} is particularly useful. Let's get some hands-on experience with the other file in our example repository: `bugged_factorial_finder.py`. It's a Python program that's supposed to calculate a factorial.
109
89
110
-
# Loop from 1 to number (inclusive) and multiply factorial by each number
111
-
foriin range(1, number + 1):
112
-
factorial *= factorial * i
90
+
#### Running the bugged file
113
91
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:
92
+
First, let's run the program to see the incorrect output:
118
93
94
+
1. Open and review the `bugged_factorial_finder.py` file.
119
95
1. In the terminal you created earlier, paste the following command.
120
96
Windows:
121
97
@@ -133,15 +109,17 @@ Since we've already cloned the repository locally, let's run `bugged_factorial_f
133
109
134
110
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.
135
111
136
-
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:
112
+
#### Debugging the file
113
+
114
+
To understand what went wrong, open {% data variables.product.prodname_copilot_chat_short %} and send the following prompt:
137
115
138
116
```text copy
139
117
Why is the output of this code so much higher than expected? Please explain in depth and suggest a solution.
140
118
```
141
119
142
120
{% 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.
143
121
144
-
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 `=`.
122
+
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 `=`. Make that change now!
0 commit comments