Run/Debug Configuration: Python
On this page:
Prerequisites
Before you start working with Python, make sure that Python plugin is installed and enabled. The plugin is not bundled with CLion.
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 box 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 text box, specify the path to the Python script or the module name to be executed. |
Parameters | In this text box, specify parameters to be passed to the Python script. When specifying the script parameters, follow these rules:
|
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 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 box. 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 |
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. |
Python Interpreter | Select one of the pre-configured Python interpreters from the drop-down list. |
Interpreter options | In this field, specify the string 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.
|
Add content roots to PYTHONPATH | Select this check box to add all content roots of your project to the environment variable PYTHONPATH; |
Add source roots to PYTHONPATH | Select this check box to add all source roots of your project to the environment variable PYTHONPATH; |
Emulate terminal in output console | Enables running your script or module in the output console with the emulated terminal mode. This mode can be helpful for the tasks that cannot be implemented with the standard output console, for example, when your script performs caret return actions (print(i, flush=True , end='\r' ). Note that emulating terminal in the output console differs from running the Terminal that is a separate tool window used for running system shell commands. |
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. |
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 check boxes 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 check box to have the previous content of the selected log skipped. |
Save console output to file | Select this check box 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 check box 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 check box 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. |