PyCharm 2021.1 Help

Run/debug configurations

PyCharm uses run/debug configurations to run, debug, and test your code. Each configuration is a named set of run/debug startup properties.

If the Navigation bar is visible (View | Appearance | Navigation Bar ), you can access all available run/debug configurations from the selector on the toolbar.

Choosing PyCharm run/debug configurations

Run/debug configurations can be created as:

  • Temporary – created every time you run or debug functions or tests.
    The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added.

  • Permanent – created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.

So whenever you run/debug or test your code, PyCharm either uses an existing permanent run/debug configuration or creates a new temporary one.

Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent.

Create permanent run/debug configurations

PyCharm provides the following ways to create a permanent run/debug configuration:

Save a temporary configuration as permanent

  • Select a temporary configuration in the run/debug configuration switcher and then click Save Configuration.

    Once you save a temporary configuration, it becomes permanent and it is recorded in a separate XML file in the <project directory>/.idea/ directory. For example, MyProject/.idea/Car.xml.

  • Alternatively, select a temporary configuration in the Run/debug configurations dialog and click Save on the toolbar.

PyCharm provides run/debug configuration templates for different languages, tools, and frameworks. The list of available templates varies depending on the installed/bundled plugins.

Create a run/debug configuration from a template

  1. Open the Run/Debug Configuration dialog in one of the following ways:

    • Select Run | Edit Configurations from the main menu.

    • With the Navigation bar visible (View | Appearance | Navigation Bar ), choose Edit Configurations from the run/debug configuration selector.

    • Press Alt+Shift+F10, then press 0 or select the configuration from the popup and press F4.

  2. In the Run/Debug Configuration dialog, click Icons general add on the toolbar or press Alt+Insert. The list shows the run/debug configuration templates.

    Select the desired template. If you are not sure which template to choose, refer to Run/debug configurations dialog for more information on particular templates.

    creating a new run/debug configuration
  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. Select Allow parallel run 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.

  5. Set the run/debug configuration parameters:
    ItemDescription
    Script path/Module nameClick 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.
    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\", \"platform\": \"unix\"}"
      .

    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.

    Environment
    Environment variablesThis 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 the Add button, 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
    Just copy the list of variables from the text file and click Paste (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 Copy, and paste them into a text file.
    Python Interpreter

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

    Interpreter optionsIn this field, specify the command-line options to be passed to the interpreter. If necessary, click Expand the field, 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.

    Add content roots to PYTHONPATHSelect this checkbox to add all content roots of your project to the environment variable PYTHONPATH;
    Add source roots to PYTHONPATHSelect this checkbox to add all source roots of your project to the environment variable PYTHONPATH;
    Execution
    Emulate terminal in output consoleEnables 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 consoleEnables running your script or module with the Python console.
    Redirect input fromEnables 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 the Browse button 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.
      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.

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

    Click Icons actions move down to expand the tables. Click Icons general add, Icons general remove, or Icons actions edit to make up the lists.

    Docker Compose
    Commands and options

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

    CommandsSupported Options
    up— Builds, creates, starts, and attaches to containers for a service.--build, --abort-on-container-exit, --timeout TIMEOUT, --exit-code-from SERVICE, --scale SERVICE=NUM..., SERVICE...
    run— Runs a one-time command against a service. See the reference docs.--name NAME, --entrypoint CMD, -l, --label KEY=VAL, -u, --user="", --rm, -p, --publish=[], --service-ports, --use-aliases, -v, --volume=[].
    exec— Runs arbitrary commands in your services.--privileged, -u, --user USER, --index=index.
    Command Preview

    You can expand this field to preview the complete command string.

    Example: if you enter the following combination in the Commands and options field:

    up --build exec --user jetbrains

    the preview output should looks as follows:

    docker-compose -f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml -f <override configuration file> up --build exec --user jetbrains
  6. In the Before launch section, define whether you want to perform any specific actions before launching the application, for example, execute some tools or scripts prior to launching the run/debug configuration.

    For information on particular Before launch activities, refer to Before Launch

  7. Apply the changes and close the dialog.

Share run/debug configurations

If you are working in a team, you might want to share your run/debug configurations so that your teammates could run the application using the same configuration or enable them to remotely attach to the process you are running.

For these purposes, PyCharm provides a mechanism to store your run/debug configurations as project files and share them through VCS. The same mechanism can also be used when you want to send your configuration as a file to someone else. This saves a lot of time as run/debug configurations sometimes get sophisticated, and keeping them in sync manually would be tedious and error-prone.

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. Select the run/debug configuration you want to share, enable the Store as project file option, and specify the location where the configuration file will be stored.

    If compatibility with PyCharm 2019.3 and earlier is required, store the file in the default location.

  3. (Optional) If the .idea directory is added to VCS ignored files, the .idea/runConfigurations subfolder will be ignored, too. If you use Git for your project, you can share .idea/runConfigurations only and leave .idea ignored by modifying .gitignore as follows:

    /.idea/* !/.idea/runConfigurations

Run/debug configuration templates

Each type of run/debug configuration is a template that you can edit, so the next time you create a new configuration of that type, its parameters already have the desired values.

Configure the default values for a template

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the left-hand pane of the run/debug configuration dialog, click Edit configuration templates.

  3. In the Run/Debug Configuration Templates dialog that opens, select a configuration type.

    Run/Debug templates
  4. Specify the desired default parameters and click OK to save the template.

Compound run/debug configurations

Suppose you would like to launch multiple run/debug configurations simultaneously. For example, you may want to run several configurations of different types or a sequence of several test configurations. You can configure this behavior with a compound run/debug configuration.

When you run or debug your code using a compound configuration, you actually launch a sequence of configurations in the order they are listed.

Create a compound run/debug configuration

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the Run/Debug Configurations dialog, click the Add button or press Alt+Insert, then select Compound.

  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. Select Store as project file to make this run/debug configuration available to other team members.

  5. To include a new run/debug configuration into the compound configuration, click Add the Add button and select the desired one from the list.

  6. Apply the changes.

Run/debug configuration folders

When there are many run/debug configurations of the same type, you can group them in folders so they become easier to distinguish visually.

Once grouped, the run/debug configurations appear in the list under the corresponding folders.

Grouped run configurations

Create a folder for run/debug configurations

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the Run/Debug Configurations dialog, select a configuration type and click the New Folder icon on the toolbar. A new empty folder for the selected type is created.

  3. Specify the folder name in the text field to the right or accept the default name.

  4. Select the desired run/debug configurations and move them under the target folder.

  5. Apply the changes. If a folder is empty, it will not be saved.

When you no longer need a folder, you can delete it Delete. The run/debug configurations grouped under this folder will be moved under the root of the corresponding run/debug configuration type.

Run/Debug configurations in the Services tool window

You can manage multiple run/debug configurations in the Services tool window. For example, you can start, pause, and stop several applications, track their status, and examine application-specific details.

Add Run/Debug configurations to the Services window

  1. Select View | Tool Windows | Services from the main menu or press Alt+8.

  2. In the Services tool window, click Add service, then select Run Configuration Type.

    Services tool window: Add run configuration
  3. Select a run/debug configuration type from the list to add all configurations of this type to the window.

    Note that the tool window will only display the configuration types for which you have created one or more configurations.

Last modified: 30 April 2021