PyCharm 2020.3 Help

Debug tool window

This tool window becomes available when you start debugging.

It displays the output generated by the debugging session for your application. If you are debugging multiple run/debug configurations, the output for each configuration is displayed in a separate tab named after the corresponding configuration.

For each configuration, there are the following nested tabs:

  • Console: displays system information and error messages, and the console input and output of your application.

  • Debugger: this tab is divided into the following areas:

Each area has a context menu that allows you to configure its behavior and navigate between tabs.

Each of the tabs and areas can be hidden/restored, or moved to a location of your choice.

Moving tabs and areas

If you are unhappy with the default layout of the Debug tool window, you can always move the tabs and areas. To do that, just drag a tab or an area to the desired location. The possible target gets highlighted.

Move the tab

Drop the tab or area in the highlighted location.

To restore the default layout of tabs and area, click Restore layout in the Debug toolbar.

Context menu of a tab

Use the context menu of the Frames, Variables or Watches areas to configure the behavior of these areas or navigate between tabs.

HideClick this button to hide the corresponding area
Close OthersClick this button to hide all tabs except for the Console and Debugger tabs.
Focus On StartupIf this option is selected, the selected area gets the focus when you start a debugging session.
Focus On BreakpointIf this option is selected, the selected area gets the focus when a breakpoint is reached.
Select Next Tab / Select Previous Tab
Ctrl+Alt+Right/ Ctrl+Alt+Left
Use these options to switch between the Console and the Debugger tabs.

Debug toolbar

Regardless of the selected tab, you can always use the following toolbar controls in the left part of the window:

ItemTooltip and ShortcutDescription
Click this button to stop the current application and run it again.
ResumeResume Program
When an application is paused, click this button to resume program execution.
PausePause Program

Click this button to pause program execution.

Click this button to terminate the current process externally by means of the standard shutdown script.
View breakpointsView Breakpoints
Click this button to open the Breakpoints dialog where you can configure breakpoints behavior.
Mute breakpointsMute Breakpoints

Use this button to toggle breakpoints status.

When the Icons debugger mute breakpoints button is pressed in the toolbar of the Debug tool window, all the breakpoints in a project are muted, and their icons become grey: Muted breakpoint.

You can temporarily mute all the breakpoints in a project to execute the program without stopping at breakpoints.

Show options menuSettings

Click this button to open the menu with the following options:

  • Show Values Inline: select this option to enable the Inline Debugging feature that allows viewing the values of variables right next to their usage in the editor.

  • Sort Values Alphabetically: select this option to sort the values in the Variables pane in the alphabetical order.

  • Unmute Breakpoints on Session Finish: select this option to re-enable all disabled breakpoints after the debugging session has been finished.

  • Show Return Values: select this option to display the return values of the executed functions in the current frame while stepping.

  • Simplified Variables View: Select this option to include the following names into the Special Variables group:

    • all variables with the dunder names.

    • all instances of function, classobj and module.

    • all the IPython internal variables, if debug console with IPython has been started.

  • Variables Loading Policy. You can choose one of the following policies:

    • Synchronously: If this check command is selected, the message shown is Collecting data, and after that the debugger shows the variables' values.

    • Asynchronously: If this check command is selected, the variables in the debugger are loaded separately (asynchronously). In this case, if loading a variable takes a long time, the debugger shows ...Loading Value message, and only after that it shows its value or the Loading timed out message, if the variable is too slow. Mind the warning message that suggest switching to the on demand mode.

    • On demand: If this check command is selected, the debugger shows Show Value message. Click it to enable loading.

    Note that any changes in the loading policies become effective after you rerun the debugging process.

Icons general pin tabPin TabClick this button to pin or unpin the current tab. You may need to pin a tab to prevent it from closing automatically when the maximum number of tabs is reached in this window.

Stepping toolbar

ItemTooltip and ShortcutDescription
Show Execution PointShow Execution Point
Click this button to highlight the current execution point in the editor and show the corresponding stack frame in the Frames pane.
Step overStep Over
Click this button to execute the program until the next line in the current method or file, skipping the methods referenced at the current execution point (if any). If the current line is the last one in the method, execution steps to the line executed right after this method.
Step intoStep Into

Click this button to have the debugger step into the method called at the current execution point.

Force step intoForce Step Into
Click this button to have the debugger step into the method called in the current execution point even if this method is to be skipped.
Step into my codeStep Into My Code
Click this button to skip stepping into library sources and keep focused on your own code.
Step outStep Out
Click this button to have the debugger step out of the current method, to the line executed right after it.
Run to cursorRun to Cursor

Click this button to resume program execution and pause until the execution point reaches the line at the current cursor location in the editor. No breakpoint is required. Actually, there is a temporary breakpoint set for the current line at the caret, which is removed once program execution is paused. Thus, if the caret is positioned at the line which has already been executed, the program will be just resumed for further execution, because there is no way to roll back to previous breakpoints. This action is especially useful when you have stepped deep into the methods sequence and need to step out of several methods at once.

If there are breakpoints set for the lines that should be executed before bringing you to the specified line, the debugger will pause at the first encountered breakpoint.

Evaluate expressionEvaluate Expression
Click this button to. evaluate expressions.
Last modified: 14 April 2021