PyCharm 2020.2 Help

Breakpoints

Breakpoints are special markers that suspend program execution at a specific point. This lets you examine the program state and behavior. Breakpoints can be simple (for example, suspending the program on reaching some line of code) or involve more complex logic (checking against additional conditions, writing log messages, and so on).

Once set, a breakpoint remains in your project until you remove it explicitly, except for temporary breakpoints).

Types of breakpoints

The following types of breakpoints are available in PyCharm:

  • Line breakpoints: suspend the program upon reaching the line of code where the breakpoint was set. This type of breakpoints can be set on any executable line of code.

  • Exception breakpoints: suspend the program when Exception or its subclasses are thrown. In PyCharm, you can set breakpoints for Python exceptions. For PyCharm Professional, Django, Jinja2, JavaScript, and Jupyter exception breakpoints are available. They apply globally to the exception condition and do not require a particular source code reference.

Set breakpoints

Set line breakpoints

  • Click the gutter at the executable line of code where you want to set the breakpoint. Alternatively, place the caret at the line and press Ctrl+F8.

    Line breakpoint

Set exception breakpoints

  1. Click View Breakpoints View Breakpoints button in the left part of the Debug tool window or press Ctrl+Shift+F8.

  2. In the Breakpoints dialog, press Alt+Insert or click the Add button, and select Python Exception Breakpoint or JavaScript Exception Breakpoint.

Manage breakpoints

Remove breakpoints

  • For non-exception breakpoints: click the breakpoint in the gutter.

  • For all breakpoints: from the main menu, select Run | View Breakpoints Ctrl+Shift+F8, select the breakpoint, and click Remove Delete.

To avoid accidentally removing a breakpoint and losing its parameters, you can choose to remove breakpoints by dragging them to the editor or clicking the middle mouse button. To do this, go to Settings/Preferences | Build, Execution, Deployment | Debugger and select Drag to the editor or click with middle mouse button. Clicking a breakpoint will then enable or disable it.

Mute breakpoints

If you don't need to stop at your breakpoints for some time, you can mute them. This allows you to resume normal program operation without leaving the debugger session. After that, you can unmute breakpoints and continue debugging.

  • Click the Mute Breakpoints button Mute Breakpoints button in the toolbar of the Debug tool window.

Enable/disable breakpoints

When you remove a breakpoint, its internal configuration is lost. To temporarily turn an individual breakpoint off without losing its parameters, you can disable it:

  • For non-exception breakpoints: right-click it and set the Enabled option as required. You can also toggle them with the middle mouse button if removing breakpoints is not assigned to it.

  • For all breakpoints: click View Breakpoints Ctrl+Shift+F8 and check/uncheck the breakpoint on the list.

Move/copy breakpoints

  • To move a breakpoint, drag it to another line.

  • To copy a breakpoint, hold Ctrl and drag a breakpoint to another line. This creates a breakpoint with the same parameters at the destination.

Configure breakpoints' properties

Depending on the breakpoint type, you can configure additional properties which allow you to tailor its operation for specific needs. The most used options are available via intentions.

  • To access breakpoint intentions, place the caret at the line with the breakpoint and press Alt+Enter. Use this option when you need to quickly configure basic breakpoint properties.

  • To access the full list of properties, right-click the breakpoint and click More or press Ctrl+Shift+F8. Use this option for a bird's eye view of all breakpoints and full control over their configuration.

Intentions reference

IntentionDescription
Remove breakpointRemoves the breakpoint at the selected line.
Disable breakpointDisables the breakpoint at the selected line.
Edit breakpoint Opens a dialog with the most used breakpoint properties. For more properties, click More or press Ctrl+Shift+F8.

Breakpoints' properties

OptionDescriptionBreakpoint type
Enabled Clear the checkbox to temporarily disable a breakpoint without removing it from the project. Disabled breakpoints will be skipped during the debugging process. All types
Suspend

Select the checkbox to pause the program execution when a breakpoint is hit. Suspending an application is useful if you need to obtain logging information or calculate an expression at a certain point without interrupting the program. If you need to create a master breakpoint that will trigger dependent breakpoints when hit, choose not to suspend the program at that breakpoint.

Choose the suspend policy:

  • All: all threads will be suspended

  • Thread: only the containing this breakpoint will be suspended. If you want the Thread policy to be used as the default one, click the Make default button.

All types
Condition

Select to specify a condition for hitting a breakpoint.A condition is a Python Boolean expression.

This expression must be valid at the line where the breakpoint is set, and it is evaluated each time the breakpoint is hit. If the evaluation result is True, the selected actions are performed.

You can enter multi-line expressions, for example:

if attempted_password == os.environ['USER_PASSWORD']: session['logged_in'] = True else: session['logged_in'] = False error = 'Invalid credentials. Please, try again.' return session['logged_in']

Python Line and Exception breakpoints
Log

Select if you want to log the following events to the console:

  • "Breakpoint hit" message: a log message will be displayed in the console output when the breakpoint is hit.

  • Stack trace: when the breakpoint is hit, its stack trace will be printed to the console.

    This is useful if you want to check what paths have led to this point without interrupting the program's execution.

Python Line and Exception breakpoints
Evaluate and log

Select to evaluate an expression when the breakpoint is hit, and show the result in the console output.

Python Line and Exception breakpoints
Remove once hit Select to remove the breakpoint from your project right after it has been hit. Django Exception, Jinja2 Exception, and JavaScript Exception breakpoints
Disable until breakpoint is hit Select the breakpoint that will trigger the current breakpoint. Until that breakpoint is hit, the current breakpoint will be disabled. You can also select if you wish to disable it again or leave it enabled once it has been hit. All types
Uncaught only Select to be notified when you've hit a breakpoint on an uncaught exception. JavaScript Exception breakpoints
Activation policy
On termination Select to stop the debugger when the process terminates on throwing this exception. Python Exception breakpoints
On raise Select to stop the debugger on throwing this exception. In this case the process doesn't terminate. Python Exception breakpoints
Ignore library files Select if you do not want the debugger to stop if this exceptions is thrown inside a library. Python Exception breakpoints

Breakpoint statuses

Breakpoints can have the following statuses:

Status Description
Verified After you have started a debugger session, the debugger checks whether it is technically possible to suspend the program at the breakpoint. If yes, the debugger marks the breakpoint as verified.
Warning If it is technically possible to suspend the program at the breakpoint, however there are issues related to it, the debugger gives you a warning. This may happen, for example, when it is impossible to suspend the program at one of the method's implementations.
Invalid If it is technically impossible to suspend the program at the breakpoint, the debugger marks it as invalid. The most common cause for this is that there is no executable code on the line.
Inactive/dependent A breakpoint is marked as inactive/dependent when it is configured to be disabled until another breakpoint is hit, and this has not happened yet.
Muted All breakpoints are temporarily inactive because they have been muted.
Disabled This breakpoint is temporarily inactive because it has been disabled.
Non-suspending The suspend policy is set for this breakpoint so that it does not suspend the execution when hit.

Breakpoint icons

Depending on their type and status, breakpoints are marked with the following icons:

LineMethodException
Regular line breakpointmethod breakpointexception breakpoint
Disabled disabled line breakpointdisabled method breakpointdisabled exception breakpoint
Verified verified line breakpointverified method breakpoint
Muted muted line breakpointmuted method breakpoint
Inactive/dependent inactive/dependent line breakpointinactive/dependent method breakpoint
Muted disabled muted disabled line breakpointmuted disabled method breakpoint
Non-suspending non-suspending line breakpointnon-suspending method breakpoint
Verified non-suspending verified non-suspending line breakpointverified non-suspending method breakpoint
Invalid invalid breakpoint

Productivity tips

Use breakpoints for "printf" debugging
Use non-suspending logging breakpoints (sometimes referred to as watchpoints in other debuggers) instead of inserting print statements in your code. This provides a more flexible and centralized way of handling debug log messages.
Set logging breakpoints more quickly
To set a non-suspending logging breakpoint, hold Shift and click the gutter. This will not suspend the program execution and instead log a message like Breakpoint reached at ocean.Whale.main(Whale.java:5). If you want to log some expression that is in front of you in the editor, select it before holding Shift and clicking the gutter.
Add breakpoint descriptions
If you have many breakpoints in your project, you can add descriptions to breakpoints for ease of search. To do this, right-click a breakpoint in the Breakpoints dialog Ctrl+Shift+F8 and select Edit description from the menu. Now when you start typing the breakpoint name, it gets the focus.
Group breakpoints
You can organize breakpoints into groups, for example, if you need to mark out breakpoints for a specific problem. To do this, in the Breakpoints dialog Ctrl+Shift+F8, select a breakpoint you want to place in a group and select Move to group from the menu.
Lambda expressions vs. method references
Due to JVM design, method references don't provide meaningful information in stack traces, as opposed to lambda expressions. Moreover, it is impossible to set a breakpoint on a method reference. If a method reference reduces traceability where it is critical, consider using lambda instead.
Diagnose the cause of fatal errors
As exception breakpoints work with Throwable, you can also use them to suspend the program when a subclass of Error is thrown. This is useful for investigating the causes of errors like OutOfMemoryError and StackOverflowError. With an exception breakpoint set up for them, you will be able to look into what happened in the program before it crashes.
Test your program for concurrency issues
A good way to find out if a multi-threaded program is robust in terms of concurrency is to use breakpoints that only suspend one thread when hit. Stopping a single thread may reveal problems in the design of the application, which would not otherwise be evident.
Last modified: 25 May 2020