JetBrains DataSpell 2021.1 Help

Run Python code

Once you have created a Python file and configured a virtual environment, you can execute your code.

The Python editor toolbar provides quick access to the most popular run/debug actions:

IconActionDescription
the Run buttonRun code in the Python Console.Execute the Python script in the selected console. See Run a file in the Python Console for more details.
Debug Python codeDebug Python codeStart debugging the Python script. See Debug Python code for more details.
Run cell and select below.Run the code line in the Python ConsoleExecute the line at caret. See Run a code fragment in the console for more details.
Run/Debug configurationEdit run/debug configurationModify the way JetBrains DataSpell executes your code. See Run/Debug Configuration: Python for more details.

A simplest way to do it is to run the file in the Run tool window. However, you can also execute your script in the interactive read-evaluate-print loop (REPL) Python Console. You can even execute a selected fragment of your code, or a Python code cell.

Execute code in the Run tool window

To run a Python script, do the following:

  • For the main clause, click the icon Run your application in the gutter, and then choose Run <script name>.

  • Press Ctrl+Shift+F10.

You can preview the execution status and script output in the Run tool window. If your code involves any plots, they will be shown in a separate window.

Running Python script in the Run tool window

Click Run/Debug configuration on the editor toolbar to configure the way JetBrains DataSpell executes your code.

Refer to Run tool window for more details about the tool window actions.

Python console enables executing Python commands and scripts line by line, similar to your experience with Python Shell. The console is located in the lower group of the JetBrains DataSpell tool windows and it opens each time you initiate code execution in it. You can also open it by selecting Windows | Tool Windows | Python Console from the main menu.

Run a file in the Python Console

  • To run a Python script in the console, click the Run button on the Python editor toolbar.

    The Run button on the toolbar

Once you initiate running, the Python Console opens and you should see the code execution.

Running file in the Python Console

By default, each console has a name that corresponds to the filename of the executed file with the index. So, if you want to execute sample.py in a new console, it will be run in the tab with the name sample (1). Use the list in the upper-right corner of the Python editor to select a particular console you need.

Running a file in several consoles

To rename a console tab, right-click the it, select Rename Console, and enter any meaningful name.

Renaming the console tab

The renamed console is shown in the list of the consoles:

Renamed console

Run a code fragment in the console

  • Place a caret at any code line and click Run cell and select below. JetBrains DataSpell executes that line and moves the caret to the next line.

    Executing a line
  • Preview execution results in the Python Console.

    Execute selection

    When executing a selected fragment, mind code dependencies and required import statements.

Run code cells

You can format your Python code as a set of executable cells to run each separately.

  1. To split your code into cells, add # %% lines where appropriate.

    Splitting code into cells
  2. Each cell has a Run icon (the Run button) in the gutter. Click it to execute a cell. Note that the kernel_stats variable is not defined until you execute the first cell. So, mind code dependencies and required imports.

    Running the second cell

Use the Python Console toolbar to configure the way JetBrains DataSpell present the execution output.

Python Console Toolbar

ItemTooltip and shortcutDescription
Rerun consoleRerun console
Ctrl+F5
Click this button to terminate the current process and launch the new one.
the Stop buttonStop
Ctrl+F2

Click this button to stop the current process.

Clicking the button once invokes soft kill allowing the application to catch the SIGINT event and perform graceful termination (on Windows, the Ctrl+C event is emulated). After the button is clicked once, it is replaced with the Kill Process button indicating that subsequent click will lead to force termination of the application, for example on Unix SIGKILL is sent.

Run commandExecute Current Statement
Enter.
Click this button to execute the command at caret, entered in the input pane of the console.
DebugAttach DebuggerAttaches the debugger process to the console.
SettingsSettings

You can specify the following settings of the Python console:

  • 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.

Add a new consoleNew ConsoleClick this button to start a new console session.
the Soft-Wrap buttonUse Soft WrapsClick this button to toggle the soft wrap mode of the output.
Scroll to the endScroll to the endClick this button to navigate to the bottom of the stack trace and have the cursor jump to the corresponding location in the source code.
the Print buttonPrintClick this button to send the console text to the default printer.
Debugger watchesShow variablesClick this button to show in a separate pane the variables declared in the console. Right-click a variable in this pane reveals a context menu.
Browse Data Source History Browse Data Source History Browse History
Ctrl+Alt+E

Open a dialog that shows all the statements that you have run for the corresponding data source. queries that you have run in the console.

See also, Using the History dialog.

Last modified: 19 March 2021