Run/Debug Configuration: pytest

pytest

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

Keywords

An expression to match on the test names. See examples on docs.pytest.org.

Parameters

You can specify which data sample of the parametrized test should be executed.

For example, set 2-2 in this field for the sample test:

import pytest


@pytest.mark.parametrize("foo,bar", [
    (1, 1),
    (2, 2),
    (3, 3),
])
def test_true(foo, bar):
    assert foo == bar

As the result, the test will be executed for the second data sample, similarly, as you run pytest test_sample.py::test_true[2-2] in the Terminal.

Additional Arguments

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

--some-argument=some-value

warning

This option is not recommended and should only be used by the experts, who want to launch something not supported by PyCharm.

Environment variable

Click the browse button, or press to 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.

Python Interpreter

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

note

When PyCharm stops supporting any of the outdated Python versions, the corresponding Python interpreter is marked as unsupported.

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

warning

This field only appears when a Docker-based remote interpreter is selected for a project..

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.