CLion 2017.1 Help

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

ItemDescription
ScriptIn this text box, specify the name of the Python script to be executed.
Script parametersIn this text box, 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\", \"platform\": \"unix\"}"
    .
Environment variableThis 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 /help/img/idea/2017.1/new.png, and type the desired name and value.
By default, the variable PYTHONUNBUFFERED is set to 1.
Emulate terminal in output nodeOn Linux and macOS systems, select this check box to emulate the terminal in the Run tool window.
On Windows system, this option is not visible!
Show command line afterwardsSelect this check box to leave the console opened after a project run or a debug session, saving its context.
Python InterpreterSelect one of the pre-configured Python interpreters from the drop-down list.
Interpreter optionsIn this field, specify the string to be passed to the interpreter. If necessary, click shift-enter-button.png, and type the string in the editor.
Working directorySpecify 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 on 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.
Add content roots to PYTHONPATHSelect this check box to add all content roots of your project to the environment variable PYTHONPATH;
Add source roots to PYTHONPATHSelect this check box to add all source roots of your project to the environment variable PYTHONPATH;
Docker container settings

Click /help/img/idea/2017.1/browseButton.png to open the dialog and specify the following settings:

  • Disable networking: select this check box 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 though 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.

    Refer to the Network settings documentation for details.

  • 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: If the check box is selected, all the container’s exposed ports are bound to a random host port.
    See e.g. EXPOSE (incoming ports) in Docker run reference. This corresponds to the option --publish-all.
  • Port bindings: Use this field to specify the Container port/protocol - Host IP address/port mappings.

    E.g. 8080 tcp 127.0.0.1 18080 would bind the TCP port 8080 inside the container to port 18080 on the localhost or 127.0.0.1 interface on the host machine.

    For more info, see e.g. Connect using network port mapping in Legacy container links.

  • Extra hosts: This corresponds to the --add-host option. Refer to the page Managing /etc/hosts for details.
  • 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.
    See Managing data in containers for details.
  • Environment variables: Use this field to specify the list of environment variables and their values. This corresponds to the -e option. Refer to the page ENV (environment variables) for details.

Click /help/img/idea/2017.1/arrow_down_hide_settings.png to expand the tables. Click /help/img/idea/2017.1/add.png, /help/img/idea/2017.1/delete.png or /help/img/idea/2017.1/edit1.png 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.

ItemDescription
Is ActiveSelect 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 EntryThe read-only fields in this column list the log files to show. The list can contain:
  • Full paths to specific files.
  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip ContentSelect this check box to have the previous content of the selected log skipped.
Save console output to fileSelect 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 streamSelect 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 streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.err.
/help/img/idea/2017.1/add.pngClick this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
/help/img/idea/2017.1/edit1.pngClick this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
/help/img/idea/2017.1/delete.pngClick this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry. The button is available only when an entry is selected.

See Also

Last modified: 19 July 2017