davrot/pytutorial
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Signed-off-by: David Rotermund <54365609+davrot@users.noreply.github.com>
This commit is contained in:
David Rotermund 2023-12-16 13:58:01 +01:00 committed by GitHub
parent 8d9bc7b923
commit b10a92f2da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
workflow/vscode_debug/README.md
View file

@ -115,102 +115,115 @@ Then ![image24](2022-04-01_21-31.png) Step Out :
## Breakpoints
Normal Breakpoints
No breakpoint => No debugging. You need to set breakpoints. Thus the debugger know where you want it to stop and allow you to investigate the state of your program.
## Normal Breakpoints
**No breakpoint => No debugging.** You need to set breakpoints. Thus the debugger know where you want it to stop and allow you to investigate the state of your program.
You can create breakpoints by making these red dot in your source code. You just click left beside the line number (with the left mouse button) and get a new breakpoint.
![image26](2022-04-01_21-18.png)
If you click again then the red dot vanishes and the breakpoint is removed.
You can use the context menu (right mouse button) do deactivate or enable an existing breakpoint. In the case of a disabled breakpoint it turns gray.
![image27](2022-04-01_21-20.png)
In the breakpoint window, you see all your breakpoints. The X Symbol removes the breakpoint. Removing a blue checkmark disables the corresponding breakpoint.
![image28](2022-04-01_21-15_0.png)
### Expression
Expression
We can use the context menu (right mouse click) to add "Add Conditional Breakpoint...". Expression allow to define a condition that needs to be true to activate the breakpoint.
![image29](2022-04-02_00-55.png)
Now is a not fully filled dot.
![image30](2022-04-02_00-56_0.png)
You can use the context menu to change the condition or delete the breakpoint.
If you start debugging, this is where the debugger stops as initial breakpoint:
![image31](2022-04-02_01-00_0.png)
### Hit Count
Hit Count
Hit Count (defined via the context menu) allows to set an integer value for how often a position in a source code needs to be "hit" (i.e. run) until a breakpoint is activated.
![image32](2022-04-02_01-03.png)
![image33](2022-04-02_01-06_0.png)
If you start debugging, this is where the debugger stops as initial breakpoint:
![image34](2022-04-02_01-07_0.png)
### Log Message / Add Log Point...
Log Message / Add Log Point...
Log Message allows you to add the generation debug messages (messages in the debug console). If this "breakpoint" is passed by the debugger then a debug message is generated. However this is not a breakpoint that stops running the program like a normal breakpoint would. The message is defined akin to "Formatted String Literals" (also called f-string).
Log Message allows you to add the generation debug messages (messages in the debug console). If this "breakpoint" is passed by the debugger then a debug message is generated. However this is not a breakpoint that stops running the program like a normal breakpoint would. The message is defined akin to ["Formatted String Literals"](https://docs.python.org/3/tutorial/inputoutput.html#tut-f-strings) (also called f-string).
![image35](2022-04-02_01-11.png)
![image36](2022-04-02_01-13.png)
Running the debugger creates the following messages in the Debug Console:
![image37](2022-04-02_01-12.png)
### Function Breakpoints
Function Breakpoints
In the Breakpoints window we can add Function Breakpoints. If the function named in the list is called that a breakpoint is initiated.
Use the + symbol:
![image38](2022-04-02_01-40_0.png)
![image39](2022-04-02_01-38_0.png)
### Raise Exception Breakpoints
Raise Exception Breakpoints
You can break on throwing exceptions even if we catch them. However, we need another breakpoint (disabled or enabled) otherwise we cannot enable the Raise Exception breakpoints.
![image40](2022-04-02_01-46_0.png)
![image41](2022-04-02_01-52_0.png)
## Starting the debug process
Starting the debug process
When we are happy with the placement of the breakpoints, we click on "Run and Debug". Then we tell the debugger that this is a Python file.
![image42](2022-04-01_21-25_0.png)
The yellow thingy tells us where in the source code we are in the moment:
![image43](2022-04-01_21-28.png)
If we press **Continue** then the debugger goes to the next breakpoint and we can view the content of the variables:
If we press Continue then the debugger goes to the next breakpoint and we can view the content of the variables:
![image44](2022-04-01_21-44_0.png)
## Watch window
Watch window
You can add variables to the watch window. This allows to observe variables and we can even watch slices of a numpy array:
![image45](2022-04-02_01-26_0.png)
You can add variables from the variable window via the context menu.
Debug console
When the debugger waits for the next command from us, we can use the Debug Console to interact with the program. For example: We can print the value of variables or replace them with new values. If the console is not open already then you find it in the menu under View -> Debug Console.
## Debug console
When the debugger waits for the next command from us, we can use the **Debug Console** to interact with the program. For example: We can print the value of variables or replace them with new values. If the console is not open already then you find it in the menu under View -> Debug Console.
![image46](2022-04-01_21-59_0.png)
## References
* Navigate through code by using the Visual Studio debugger
* Debugging in VS Code
* Python debugging in VS Code
* [Navigate through code by using the Visual Studio debugger](https://docs.microsoft.com/en-us/visualstudio/debugger/navigating-through-code-with-the-debugger?view=vs-2022)
* [Debugging in VS Code](https://code.visualstudio.com/docs/editor/debugging)
* [Python debugging in VS Code](https://code.visualstudio.com/docs/python/debugging)