Run/Debug Configuration: Python
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.
|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.|
In this field, specify parameters to be passed to the Python script.
When specifying the script parameters, follow these rules:
|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
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 = Value2Just 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 system, 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.|
|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.|
Specify a directory to be used by the running task.
|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;|
|Run with Python console||Enables running your script or module with the Python console.|
|Docker container settings|
Click to open the dialog and specify the following settings:
Click to expand the tables. Click , , or to make up the lists.
|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:
|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.|
When you edit a run configuration (but not a run configuration template), you can specify the following options:
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.
|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.|
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.
Click this icon to add one of the following available tasks:
|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|
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.