IntelliJ IDEA 2021.1 Help

Run and debug Jupyter notebook code cells

Code fragments in a Jupyter notebook file are structured as executable cells. Each cell is marked with the #%% comment and can be executed independently by clicking the Run cell icon in the gutter. To execute all cells at once, click Run cell on the Jupyter toolbar.

Execute Jupyter Cell command

Run code cells

  • Click the Execute cell icon and select Run Cell. IntelliJ IDEA launches the Jupyter server, executes the code cell, and renders the output in the Preview pane.

    When executing one cell at a time, mind code dependencies. For example, the second cell in the code fragment uses the variables defined in the first cell. So, if you modify the N value, the changes will be reflected in the scatter chart only after the first cell gets executed.

  • To execute all code cells in your notebook, click Run all on the notebook toolbar or press Ctrl + Shift + Alt + Enter. To run all code cells above the current cell and handle possible code dependencies, click Jupyter Quick List on the notebook toolbar and select the Run All Above command from the quick list.

When you stop the server and change the server or kernel, you have to execute all cells with dependencies again, because execution results are valid for the current server session only.

View variables

  • When you execute a cell, the Variables tab of the Jupyter server tool window opens automatically.

    Jupyter server tool window: the Variables tab

    You can click the link to the right of the variable to preview its values in the tabular form:

    Viewing variables as array
    Viewing variables as array

    Note that Variables tab will appear each time you execute a cell, so if, by some reasons, you need to close it permanently, deselect the corresponding option in the project settings (Settings/Preferences | Build, Execution, Deployment | Jupyter ).

    In addition to previewing values of the variables in the Variables tab, you can watch the values of the variable usages in the editor. Note that variable assignments are not shown.

    Inline variables in the source editor

    This option is enabled by default. To disable it, deselect the Show Inline Values in the Editor checkbox in the project settings (Settings/Preferences | Build, Execution, Deployment | Jupyter ).

When you work with a substantial number of code cells, you can effectively navigate between the Editor and Preview panes by using auto scrolling.

Jump to the target output fragment or target code cell

  1. Enable auto scrolling from the source by clicking the Auto scroll from Source icon, then select a code cell in the Editor pane. You will be positioned on the target output fragment in the Preview pane.

  2. Enable auto scrolling to the source code by clicking the Auto scroll to Source icon on the Jupyter toolbar, then select an arbitrary output fragment in the Preview pane. You'll be positioned on the source code cell in the Editor pane.

IntelliJ IDEA provides the full-functional Jupyter Notebook Debugger.

Debug code in Jupyter notebook

  1. Set the breakpoints in the selected cell and press Alt + Shift + Enter for Windows or ⌥⇧↩ for macOS. Alternatively, you can click the Run cell icon, and select Debug Cell.

    The Jupyter Notebook Debugger tool window opens.

    Jupyter Notebook Debugger tool window
  2. Use the stepping toolbar buttons stepping toolbar to choose on which line you want to stop next and switch to the Debugger tab to preview the variable values:

    Stepping over in the Jupyter Notebook Debugger

    Debugging is performed within a single code cell. However, if your code cell calls a function from any cell that has been already debugged, you can step into it. The related breakpoints will also work. Note that the cell with the function must be debugged not just executed.

    Stepping into the previous cell

    Similarly, you can step into a function called from a Python file that is located in the same project.

    Stepping into a Python file

  3. Proceed with the debugging steps to complete the execution of the cell.

    Debugging is complete

Clear the notebook output

  • To erase the execution output in the Preview area, click Quick list on the Jupyter notebook toolbar and select the Clear Outputs command from the quick list. Evaluate the results in the Preview area.

With IntelliJ IDEA you can always quickly preview reference documentation for a particular variable, type, or argument.

Preview reference documentation

  1. To view reference information for any element of a particular code cell, place the caret within the target code cell and type ? <type/variable/argument>. (in this example, you will preview documentation for plt.scatter ). Note that a code element should be accessible within the code cell.

  2. Execute the cell. The Introspection tab opens in the Jupyter tool window.

    Previewing reference documentation for plt.scatter

  3. Preview reference documentation in the Introspection tab.

Note that the Introspection tab shows documentation for the latest requested code element. Even though you proceed with executing other code cells, restart the server, or delete the line with your request, this information will be shown.

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: 24 March 2021