PyCharm 2023.3 Help

Run/debug configurations

PyCharm uses run/debug configurations to run, debug, and test your code. Each configuration is a named set of startup properties that define what to execute and what parameters and environment should be used.

With different startup properties, you can define different ways that PyCharm uses to execute your script. For example, you can execute the same code with different Python interpreters, providing various sets of environment variables, and getting input values from alternative files.

There are two types of run/debug configurations:

  • Temporary — created every time you run or debug functions or tests.

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

The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added. If necessary, you can increase this limit in Settings | Advanced Settings | Run/Debug | Temporary configurations limit.

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, click App client actions more / App client general chevron right, and select 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 and enabled plugins.

Create a run/debug configuration from a template

  1. Go to Run | Edit Configurations. Alternatively, click App general link drop triangle in the Run widget and select Edit Configurations from the drop-down menu.

    Run/Debug Configurations popup
  2. In the Run/Debug Configuration dialog, click App expui general add on the toolbar or press Alt+Insert. The list shows the run/debug configuration templates. Select Python.

    Selecting a new run/debug configuration template
  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.

    creating a new run/debug configuration
  4. Configure the run/debug configuration parameters. The list of mandatory and optional parameters may vary depending on the selected run/debug configuration type.

    Some optional parameters are hidden. To view and enable them, click the Modify options link.

    Enabling optional parameters for a Python run configuration

    For the detailed description of the Python template, see Run/Debug configuration parameters.

  5. You can either run the configuration right away, or save the configuration to run it later.

    • Click OK to save the run configuration for later and close the dialog.

    • To run the configuration right away, click Run.

Add a macro to a Python run/debug configuration

  1. Go to Run | Edit Configurations. Alternatively, click App general link drop triangle in the Run widget and select Edit Configurations from the drop-down menu.

    Run/Debug Configurations popup
  2. In the Run/Debug Configurations dialog, select the target configuration from the list of the Python run/debug configurations.

  3. Click App client expui general list files Insert Macros in one of the following fields:

    • Script path

    • Parameters

    • Working directory

  4. Select a macro from the list of the available macros.

    Adding macros to Python run configuration
  5. Click Insert to add the selected macro.

    See Pass parameters to the running script for an example of using a macro in a run/debug configuration.

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. Go to Run | Edit Configurations. Alternatively, click App general link drop triangle in the Run widget and select Edit Configurations from the drop-down menu.

    Run/Debug Configurations popup
  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

All run/debug configurations are based on templates, which implement the startup logic, define the list of parameters and their default values. The list of available templates is predefined in the installation and can only be extended via plugins. However, you can edit default parameter values in each template to streamline the setup of new run/debug configurations.

Configure the default values for a template

  1. Go to Run | Edit Configurations. Alternatively, click App general link drop triangle in the Run widget and select Edit Configurations from the drop-down menu.

    Run/Debug Configurations popup
  2. In the left-hand pane of the run/debug configuration dialog, click Edit configuration templates….

    Run/Debug 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.

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. Go to Run | Edit Configurations. Alternatively, click App general link drop triangle in the Run widget and select Edit Configurations from the drop-down menu.

    Run/Debug Configurations popup
  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.

    Adding a configuration folder
  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.

Run/Debug configuration parameters

Item

Description

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

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 App expui inline browse Choose ".env" file. In the Environment Files dialog that opens, use App expui general add Add and App expui general remove Remove to add and remove files.

You can also use App expui general move up and App expui general move down 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 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 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 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 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. 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 App expui general move down to expand the tables. Click App expui general add, App expui general remove, or App expui general edit to make up the lists.

Docker Compose

Commands and options

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

Commands

Supported options

up: Builds, creates, starts, and attaches to containers for a service.

  • --abort-on-container-exit

  • --build

  • --exit-code-from SERVICE

  • --scale SERVICE=NUM...

  • --timeout TIMEOUT

run: Runs a one-time command against a service.

  • --entrypoint CMD

  • -l, --label KEY=VAL

  • --name NAME

  • -p, --publish=[]

  • --rm

  • --service-ports

  • --use-aliases

  • -u, --user=""

  • -v, --volume=[]

exec: Runs arbitrary commands in your services.

  • --index=index

  • --privileged

  • -u, --user USER

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:

docker compose -f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml -f <override configuration file> up --build exec --user jetbrains
Last modified: 09 January 2024