Run/Debug Configuration: Python

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.

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

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.

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.

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 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 Control+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 CLion 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

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

• Disable networking: select this checkbox to have the networking disabled. This corresponds to --net="none", which means that inside a container the external network resources are not available.

• Network mode: corresponds to the other values of the option --net.

  • bridge is the default value. An IP address will be allocated for container on the bridge’s network and traffic will be routed through this bridge to the container.

    Containers can communicate via their IP addresses by default. To communicate by name, they must be linked.

  • host: use the host's network stack inside the container.

  • container:<name|id>: use the network stack of another container, specified via its name or id.

  For more information, refer to the Network settings documentation.

• Links: Use this section to link the container to be created with the other containers. This is applicable to Network mode = bridge and corresponds to the --link option.

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

• Extra hosts: This corresponds to the --add-host option. For more information, refer to Managing /etc/hosts.

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

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