Run/Debug Configuration: Python

Run | Edit Configurations | | Python

Prerequisites

Before you start working with Python, make sure that Python plugin is installed and enabled. Press Ctrl+Alt+S, go to Plugins and inspect the Installed tab to ensure the plugin is enabled.

Also make sure that the following prerequisites are met:

Python SDK is downloaded and installed on your machine.
The required framework SDKs are downloaded and installed on your machine.

Refer to their respective download and installation pages for details:

Use this dialog to create a run/debug configuration for Python scripts.

Configuration tab

Item	Description
Script path/Module name	Click the list to select a type of target to run. Then, in the corresponding field, specify the path to the Python script or the module name to be executed.
Parameters	In this field, specify parameters to be passed to the Python script. When specifying the script parameters, follow these rules: Use spaces to separate individual script parameters. Script parameters containing spaces should be delimited with double quotes, for example, `some" "param` or `"some param"`. If script parameter includes double quotes, escape the double quotes with backslashes, for example: `-s"main.snap_source_dirs=[\"pcomponents/src/main/python\"]" -s"http.cc_port=8189" -s"backdoor.port=9189" -s"main.metadata={\"location\": \"B\", \"language\": \"python\"}"` .
Environment
Project	Click this list to select one of the projects, opened in the same IntelliJ IDEA window, where this run/debug configuration should be used. If there is only one open project, this field is not displayed.
Environment variables	This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons. By default, the field contains the variable `PYTHONUNBUFFERED` set to 1. To fill in the list, click the browse button, or press `Shift+Enter` and specify the desired set of environment variables in the Environment Variables dialog. To create a new variable, click , and type the desired name and value. You might want to populate the list with the variables stored as a series of records in a text file, for example: Variable1 = Value1 Variable2 = Value2 Just copy the list of variables from the text file and click Paste () in the Environmental Variables dialog. The variables will be added to the table. Click Ok to complete the task. At any time, you can select all variables in the Environment Variables dialog, click Copy , and paste them into a text file.
Emulate terminal in output node	On Linux and macOS systems, select this checkbox to emulate the terminal in the Run tool window. On Windows, this option is not visible.
Show command line afterwards	Select this checkbox to leave the console opened after a project run or a debug session, saving its context.
Python Interpreter
Interpreter options	In this field, specify the command-line options to be passed to the interpreter. If necessary, click , and type the string in the editor.
Working directory	Specify a directory to be used by the running task. When a default run/debug configuration is created by the keyboard shortcut `Ctrl+Shift+F10`, or by choosing Run from the context menu of a script, the working directory is the one that contains the executable script. This directory may differ from the project directory. When this field is left blank, the bin directory of the IntelliJ IDEA installation will be used.
Path mappings	This field appears, if a remote interpreter has been selected in the field Python interpreter. Click the browse button to define the required mappings between the local and remote paths. In the Edit Path Mappings dialog, use / buttons to create new mappings, or delete the selected ones.
Add content roots to PYTHONPATH	Select this checkbox to add all content roots of your project to the environment variable PYTHONPATH;
Add source roots to PYTHONPATH	Select this checkbox to add all source roots of your project to the environment variable PYTHONPATH;
Execution
Run with Python console	Enables running your script or module with the Python console.
Docker container settings This field only appears when a Docker-based remote interpreter is selected for a project.. Speaking about the correspondence of settings with some options (`--net`, `--link`, and so on), note that these options come from Docker command line arguments. Click to open the dialog and specify the following settings:
Options	Disable networking: select this checkbox to have the networking disabled. This corresponds to `--net="none"`, which means that inside a container the external network resources are not available. Network mode: corresponds to the other values of the option `--net`. `bridge` is the default value. An IP address will be allocated for container on the bridge’s network and traffic will be routed through this bridge to the container. Containers can communicate via their IP addresses by default. To communicate by name, they must be linked. `host`: use the host's network stack inside the container. `container:<name\|id>`: use the network stack of another container, specified via its name or id. Refer to the Network settings documentation for details. Links: Use this section to link the container to be created with the other containers. This is applicable to `Network mode = bridge` and corresponds to the `--link` option. Publish all ports: Expose all container ports to the host. This corresponds to the option `--publish-all`. Port bindings: Specify the list of port bindings. Similar to using the `-p` option with `docker run`. Extra hosts: This corresponds to the `--add-host` option. Refer to the page Managing /etc/hosts for details. Volume bindings: Use this field to specify the bindings between the special folders-volumes and the folders of the computer, where the Docker daemon runs. This corresponds to the `-v` option. See Managing data in containers for details. Environment variables: Use this field to specify the list of environment variables and their values. This corresponds to the `-e` option. Refer to the page ENV (environment variables) for details. Click to expand the tables. Click , , or to make up the lists.

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item	Description
Is Active	Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File Entry	The read-only fields in this column list the log files to show. The list can contain: Full paths to specific files. Ant patterns that define the range of files to be displayed. Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown. If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.
Skip Content	Select this checkbox to have the previous content of the selected log skipped.
Save console output to file	Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when a message is printed to standard output stream	Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.
Show console when a message is printed to standard error stream	Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.
	Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
	Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
	Click this button to remove the selected log entry from the list.

Common settings

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item	Description
Name	Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup `Alt+Shift+F10`.
Allow parallel run	Select to allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, IntelliJ IDEA suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.
Store as project file	Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, IntelliJ IDEA suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

Item	Shortcut	Description
	`Alt+Insert`	Create a run/debug configuration.
	`Alt+Delete`	Delete the selected run/debug configuration. Note that you cannot delete default configurations.
	`Ctrl+D`	Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
		The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
		Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created. Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons. To remove grouping, select a folder and click .
		Click this button to sort configurations in the alphabetical order.

Before launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item	Shortcut	Description
	`Alt+Insert`	Click this icon to add one of the following available tasks: Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in IntelliJ IDEA yet, add its definition. For more information, see External tools and External Tools. Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run. Build Artifacts: select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built. Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger. Run Ant target: select this option to run an Ant target. In the dialog that opens, select the target to be run. Run Grunt task: select this option to run a Grunt task. In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package. Run gulp task: select this option to run a Gulp task. In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool. Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package. Run Maven Goal: select this option to run a Maven goal. In the dialog that opens, select the goal to be run. Run npm script: select this option to execute an npm script. In the NPM Script dialog that opens, specify the npm run/debug configuration settings. Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected: If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start. If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched. Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located. Run Remote External Tool: adds a remote SSH external tool. Run Rake task: add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button , and select the desired task from the list of available tasks. Note that code completion is available here. Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/	`Alt+Up`/`Alt+Down`	Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this page		Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window		By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing `Alt+4` or `Alt+5`.

Last modified: 02 August 2022