PyCharm 2019.1 Help

Debugging

Start a debugging session

  1. To debug CoffeeScript, TypeScript, and Dart code, you need to generate a source map for it. This will set the correspondence between lines in your original code and in the generated JavaScript code. If no source map is generated, your breakpoints will not be recognized and processed correctly.

  2. Define a run/debug configuration for the application to be debugged.

  3. Create a breakpoint.

  4. Click the Debug icon. Read more about debugging sessions in Starting the Debugger Session.

After you've started a debug session, the Debug icon that marks the Debug tool window toggles to the Active Debugger icon to indicate that the debug process is active.

Debug

After you have configured a run configuration for your project, you can launch it in debug mode by pressing Shift+F9.

In the Debug tool window you can see the list of frames and threads with their states, variables and watches. When you select a frame, you see the variables corresponding to the selected frame.

Breakpoints

Customize breakpoint settings

To customize breakpoint settings, press Ctrl+Shift+F8. To see all breakpoints in the project (with additional settings), click More or press the same shortcut Ctrl+Shift+F8 again.

Breakpoint properties

Do not suspend code execution

Use action breakpoints to evaluate a variable at a particular line of code without suspending code execution. To create an action breakpoint, click the gutter while pressing Shift.

Adding an action breakpoint

Create a temporary breakpoint

To create a breakpoint that stops only once, click the left gutter while holding Shift+Alt. For more information, refer to the section Breakpoints.

Setting a temporary breakpoint

Disable breakpoints

To disable a breakpoint, click the breakpoint while pressing Alt. Refer to the section Breakpoints for details.

Disabling breakepoints

Debugger session

Smart step into

Sometimes it happens that you stay at a line and want to step into a particular method but not the first one that will be invoked. In this case use Smart step into by pressing Shift+F7 to choose a particular method.

Refer to the section Choosing a Method to Step Into for details.

Run to cursor

  1. Create a breakpoint.

  2. Run a debugging session. To run a debugging session, click the Run Application icon (the Run Application icon) in the gutter area and select Debug <configuration_name>.

To stop code execution at the cursor position without adding another breakpoint, click the Run to cursor icon (the Run to cursor icon) or press Alt+F9. Alternatively, you can click the line number in the gutter area.

Run to cursor

The icon Run to Cursor is described in the toolbar reference of the Debug tool window.

Evaluate expression

While in debug mode, you can evaluate any expression by pressing Alt+F8.

Evaluate expressions

This tool provides code completion just as in the editor so it’s very easy to enter any expression:

py evaluate expression

Refer to the section Evaluating Expressions for details.

Settings

Configuring debugger settings

To change debugger settings, click File | Settings. In the Settings menu, click Build, Execution, Deployment | Debugger.

Useful debugger shortcuts

Action

Hotkey

Toggle breakpointCtrl+F8
Resume programF9
Step overF8
Step intoF7

Stop

Ctrl+F2
View breakpoint details/all breakpointsCtrl+Shift+F8

Debug code at caret

Shift+F9 (within the main method), or Shift+Alt+F9

Last modified: 17 May 2019

See Also