Run/Debug Configuration: Python
On this page:
Before you start working with Python, make sure that Python plugin is installed and enabled. The plugin is not bundled with PyCharm.
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.
|Script||In this text box, specify the name of the Python script to be executed.|
|Script parameters||In this text box, specify parameters to be passed to the Python script. |
When specifying the script parameters, follow these rules:
|Project||Click this drop-down list to select one of the projects, opened in the same PyCharm window, where this run/debug configuration should be used. If there is only one open project, this field is not displayed.|
|Environment variable||This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons. |
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.
By default, the variable
|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.|
Note that you can select a remote interpreter, as well as the local one. If a remote interpreter is selected (in the Professional edition), you have to specify path mappings in the corresponding field that appears.
|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. |
|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 box, use / buttons to create new mappings, or delete the selected ones.
|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;|
|Docker container settings|
This field only appears when Docker-based remote interpreter has been selected for a project.
Click to open the dialog and specify the following settings:
Click to expand the tables. Click , or to make up the lists.
Speaking about the correspondence of settings with some options (
|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.|
|Alt+Insert||Click this button to add a new configuration to the list.|
|Alt+Delete||Click this button to remove the selected configuration from the list.|
|Ctrl+D||Click this button to create a copy of the selected configuration.|
|Edit defaults||Click this button to edit the default configuration templates. The defaults are used for newly created configurations.|
|or||Alt+Up or Alt+Down||Use these buttons to move the selected configuration or folder up and down in the list. |
The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.
|Move into new folder / Create new folder||Use this button to create a new folder. |
If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created.
Move run/debug configurations to a folder using drag-and-drop, or the buttons.
|Sort configurations||Click this button to sort configurations in alphabetical order.|
|Name||In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.|
|Defaults||This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.|
|Share|| Select this check box to make the run/debug configuration available to other team members. |
The shared run/debug configurations are kept in separate xml files under
This check box is not available when editing the run/debug configuration defaults.
|Single instance only||If this check box is selected, this run/debug configuration cannot be launched more than once. |
Every time a new run/debug configuration is launched, PyCharm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.
This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.
If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.
|Before launch||Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list. |