Debugging your Python code
Visual Studio provides a comprehensive debugging experience for Python, including attaching to running processes, evaluating expressions in the Watch and Immediate windows, inspecting local variables, breakpoints, step in/out/over statements, Set Next Statement, and more.
Also see the following scenario-specific debugging articles:
- Linux remote debugging
- Azure remote debugging
- Mixed-mode Python/C++ debugging
- Symbols for mixed-mode debugging
|Watch a video (Microsoft Virtual Academy) for a demonstration of Python debugging (3m 32s).|
Python in Visual Studio supports debugging without a project. With a stand-alone Python file open, right-click in the editor, select Start with Debugging, and Visual Studio launches the script with the global default environment (see Python environments) and no arguments. But from then on, you have full debugging support.
To control the environment and arguments, create a project for the code, which is easily done with the From existing Python code project template.
The basic debugging workflow involves settings breakpoints, stepping through code, inspecting values, and handling exceptions as described in the following sections. For complete details on the Visual Studio debugger, see Debugging in Visual Studio.
A debugging session starts with the Debug > Start Debugging command, the Start button on the toolbar, or the F5 key. These actions launch your project's startup file (shown in bold in Solution Explorer) with the project's active environment and any command-line arguments or search paths that have been specified in Project Properties (see Project debugging options. Visual Studio 2017 version 15.6 and later alerts you if you don't have a startup file set; earlier versions may open an output window with the Python interpreter running, or the output window briefly appears and disappears. In any case, right-click the appropriate file and select Set as Startup File.
The debugger always starts with the active Python environment for the project. To change the environment, make a different one active as described on Selecting a Python environment for a project.
Breakpoints stop execution of code at a marked point so you can inspect the program state. Set breakpoints by clicking in the left margin of the code editor or by right-clicking a line of code and selecting Breakpoint > Insert Breakpoint. A red dot appears on each line with a breakpoint.
Clicking the red dot or right-clicking the line of code and selecting Breakpoint > Delete Breakpoint removes the breakpoint. You can also disable it without removing it using the Breakpoint > Disable Breakpoint command.
Some breakpoints in Python can be surprising for developers who have worked with other programming languages. In Python, the entire file is executable code, so Python runs the file when it's loaded to process any top-level class or function definitions. If a breakpoint has been set, you may find the debugger breaking part-way through a class declaration. This behavior the correct, even though it's sometimes surprising.
You can customize the conditions under which a breakpoint is triggered, such as breaking only when a variable is set to a certain value or value range. To set conditions, right-click the breakpoint's red dot, select Condition, then create expressions using Python code. For full details on this feature in Visual Studio, see Breakpoint conditions
When setting conditions, you can also set Action and create a message to log to the output window, optionally continuing execution automatically. Logging a message creates what is called a tracepoint without adding logging code to your application directly:
Stepping through code
Once stopped at a breakpoint, you have various ways to step through code or run blocks of code before breaking again. These commands are available in a number of places, including the top debug toolbar, the Debug menu, on the right-click context menu in the code editor, and through keyboard shortcuts (through not all commands are in all places):
|Continue||F5||Runs code until the next breakpoint is reached.|
|Step Into||F11||Runs the next statement and stops. If the next statement is a call to a function, the debugger stops at the first line of the function being called.|
|Step Over||F10||Runs the next statement, including making a call to a function (running all its code) and applying any return value. Stepping over allows you to easily skip functions that you do not need to debug.|
|Step Out||Shift+F11||Runs code until the end of the current function, then steps to the calling statement. This command is useful when you don't need to debug the remainder of the current function.|
|Run to Cursor||Ctrl+F10||Runs code up to the location of the caret in the editor. This command allows you to easily skip over a segment of code that you don't need to debug.|
|Set Next Statement||Ctrl+Shift+F10||Changes the current run point in the code to the location of the caret. This command allows you to omit a segment of code from being run at all, such as when you know the code is faulty or produces and unwanted side-effect.|
|Show Next Statement||Alt+Num *||Returns you to the next statement to run. This command is helpful if you've been looking around in your code and don't remember where the debugger is stopped.|
Inspecting and modifying values
When stopped in the debugger, you can inspect and modify the values of variables. You can also use the Watch window to monitor individual variables as well as custom expressions. (See Inspect Variables for general details.)
To view a value using DataTips, simply hover the mouse over any variable in the editor. You can click on the value to change it:
The Autos window (Debug > Windows > Autos) contains variables and expressions that are close to the current statement. You can double-click in the value column or select and press F2 to edit the value:
The Locals window (Debug > Windows > Locals) displays all variables that are in the current scope, which can again be edited:
For more on using Autos and Locals, see Inspecting Variables in the Autos and Locals Windows.
The Watch windows (Debug > Windows > Watch > Watch 1-4) allow you to enter arbitrary Python expressions and view the results. Expressions are reevaluated for each step:
For more on using Watch, see Setting a Watch on Variables using the Watch and QuickWatch Windows.
When inspected a string value(
bytearray are all considered strings for this purpose), a magnifying glass icon appears on the right side of the value. Clicking the icon displays the unquoted string value in a popup dialog, with wrapping and scrolling, which is useful for long strings. In addition, selecting the drop-down arrow on the icon allows you to select plain text, HTML, XML, and JSON visualizations:
HTML, XML, and JSON visualizations appear in separate popup windows with syntax highlighting and tree views.
If an error occurs in your program during debugging, but you don't have an exception handler for it, the debugger breaks at the point of the exception:
At this point you can inspect the program state, including the call stack. However, if you attempt to step through the code, the exception continues being thrown until it is either handled or your program exits.
The Debug > Windows > Exception Settings menu command brings up a window in which you can expand Python Exceptions:
The checkbox for each exception controls whether the debugger always breaks when it is raised. Check this box when you want to break more often for a particular exception.
By default, most exceptions break when an exception handler cannot be found in the source code. To change this behavior, right-click any exception and check or uncheck Continue When Unhandled in User Code. Clear this box when you want to break less often for an exception.
To configure an exception that does not appear in this list, click the Add button to add it. The name must match the full name of the exception.
Project debugging options
By default, the debugger starts your program with the standard Python launcher, no command-line arguments, and no other special paths or conditions. Startup options are changed through the project's debug properties accessed by right-clicking your project in Solution Explorer, selecting Properties, and selecting the Debug tab.
Launch mode options
|Standard Python launcher||Uses debugging code written in portable Python that is compatible with CPython, IronPython, and variants such as Stackless Python. It provides the best experience for debugging pure Python code. When you attach to a running
|Web launcher||Starts your default browser on launch and enables debugging of templates. See the Web template debugging section for more information.|
|Django Web launcher||Identical to the Web launcher and shown only for backwards compatibility.|
|IronPython (.NET) launcher||Uses the .NET debugger, which only works with IronPython but allows for stepping between any .NET language project, including C# and VB. This launcher is used if you attach to a running .NET process that is hosting IronPython.|
Run options (search paths, startup arguments, and environment variables)
|Search Paths||These values match what's shown in the project's Search Paths node in Solution Explorer. You can modify this value here, but it's easier to use Solution Explorer that lets you browse folders and automatically converts paths to relative form.|
|Script Arguments||These arguments are added to the command used to launch your script, appearing after your script's filename. The first item here is available to your script as
|Interpreter Arguments||These arguments are added to the launcher command line before the name of your script. Common arguments here are
|Interpreter Path||Overrides the path associated with the current environment. value may be useful for launching your script with a non-standard interpreter.|
|Environment Variables||In this multi-line text box, add entries of the form
Immediate and interactive windows
There are two interactive windows you can use during a debugging session: the standard Visual Studio Immediate window, and the Python Debug Interactive window.
The Immediate window (Debug > Windows > Immediate) is used for quick evaluation of Python expressions and inspection or assignment of variables within the running program. See the general Immediate Window article for details.
The Python Debug Interactive window (Debug > Windows > Python Debug Interactive) is richer as it makes the full Interactive REPL experience available while debugging, including writing and running code. It automatically connects to any process started in the debugger using the Standard Python launcher (including processes attached through Debug > Attach to Process). It's not, however, available when using mixed-mode C/C++ debugging.
The Debug Interactive window supports special meta-commands in addition to the standard REPL commands:
||Starts running the program from the current statement.|
||Move the current frame one level down in the stack trace.|
||Displays the current frame id.|
||frame id||Switches the current frame to the specified frame id.|
||Loads commands from file and executes until complete|
||Displays the current process id.|
||process id||Switches the current process to the specified process id.|
||Lists the processes currently being debugged.|
||Steps into the next function call, if possible.|
||Steps out of the current function.|
||Steps over the next function call.|
||Displays the current thread id.|
||thread id||Switches the current thread to the specified thread id.|
||Lists the threads currently being debugged.|
||Move the current frame one level up in the stack trace.|
||Lists the frames for the current thread.|
Note that the standard debugger windows such as Processes, Threads, and Call Stack are not synchronized with the Debug Interactive window. Changing the active process, thread, or frame in the Debug Interactive window does not affect the other debugger windows. Similarly, changing the active process, thread, or frame in the other debugger windows does not affect the Debug Interactive window.
The Debug Interactive window has its own set of options, which you can access through Tools > Options > Python Tools > Debug Interactive Window. Unlike the regular Python Interactive window, which has a separate instance for each Python environment, there is only one Debug Interactive window and it always uses the Python interpreter for the process being debugged. See Options - Debugging options.