Run/Debug Configuration: Python
Create:
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.
For more information, refer to their respective download and installation pages:
Use this dialog to create a run/debug configuration for Python scripts.
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 configuration to quickly identify it among others when editing or running. |
Allow multiple instances | 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, CLion suggests stopping the running instance and starting another one. This is helpful when a run 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 CLion stores run configuration settings in .idea/workspace.xml. |
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. You can use path variables in this field. |
Parameters | In this field, specify parameters to be passed to the Python script. When specifying the script parameters, follow these rules:
|
Allow multiple instances | Select this option if you want to allow multiple instances of the configuration to run at the same time. If this option is disabled, attempting to re-run the configuration will terminate the active session. |
Environment | |
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 = 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 | Select this checkbox to emulate the terminal in the Run tool window. |
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 | Select one of the pre-configured Python interpreters. |
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.
You can use path variables in this field. |
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 Click to open the dialog and specify the following settings: | |
Options |
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:
|
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. | |
Click this button to edit the select log file entry. The button is available only when an entry is selected. |