Run/Debug Configuration: Python Unit Test

Unittests

Target: Module name/Script path/Custom

Click one of the radio-buttons to choose the possible target:

• Module name: by using a Python module name and a test class instance.

• Script path: by using a path to a Python file.

• Custom: by using an arbitrary combination of paths, modules, and test class instances.

Depending on the selected Target type, you can specify the following values:

• Path to the test file, for example, /Users/jetbrains/Car/my_tests/test_car.py. You can type in the path or click the button to locate the file in the project structure.

• Name of the module in your project, for example, my_tests. You can type in the module name, search the target module by its name, or locate it in the project structure.

• Custom combination of modules, scripts, classes, and methods, for example, my_tests.test_car.TestCar.test_brake, where:

  • my_tests: the package name

  • test_car: the module name

  • TestCar: the class instance in test_car

  • test_brake: the method in the TestCar class

Pattern

In this text field, specify the pattern that describes all the tests in the required location.

This parameter corresponds to the -p, --pattern argument of the unittest discover command. Its default value is test*.py. If you want any Python file to represent a test file, put *.py in this field.

Additional Arguments

In this text field, specify the additional framework-specific arguments to be passed to the test as-is, for example:

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.

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;

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.