Run/debug configurations

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:

• 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\"}"

In this field you can add a macros to pass various project- or context-specific values when running a run/debug configuration. Click + and select one of the available macros from the list. See Adding macros to run/debug configuration for more details.

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

Project

Click this 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 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:

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.

Paths to ".env" files

This field shows paths to .env files with environment variables. If there are several files, the paths to them are delimited with semicolons.

To manage the list of .env files, click Choose ".env" file. In the Environment Files dialog that opens, use Add and Remove to add and remove files.

You can also use and to change the order in which .env files are loaded.

Python Interpreter

Select one of the pre-configured Python interpreters from the list.

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 PyCharm installation will be used.

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

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.

Redirect input from

Enables redirecting data from a text file to standard input. Use this option if your script requires some input and you want to automatically submit the values instead of typing them in the Run console. To enable redirecting, select the checkbox and specify the path to the target text file.

Docker container settings

Click to open the dialog and specify the following settings:

Options

• 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.

• 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. For more information, refer to Managing data in containers.

• Environment variables: Use this field to specify the list of environment variables and their values. This corresponds to the -e option. For more information, refer to ENV (environment variables).

• Run options: Use this field to specify the Docker command-line options.

Click to expand the tables. Click , , or to make up the lists.

Docker Compose

Commands and options

You can use the following commands of the Docker Compose Command-Line Interface:

Command preview

Use this field to preview the complete command string.

For example, the up --build exec --user jetbrains combination in the Commands and options field produces the following output in the preview: