pytest

The pytest Python test framework (https://docs.pytest.org/).

Backend: pants.backend.python
Config section: [pytest]

Basic options

`args`

--pytest-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_PYTEST_ARGS

default: []

Arguments to pass directly to Pytest, e.g. --pytest-args='-k test_foo --quiet'.

`timeouts`

--[no-]pytest-timeouts
PANTS_PYTEST_TIMEOUTS

default: True

Enable test target timeouts. If timeouts are enabled then test targets with a timeout= parameter set on their target will time out after the given number of seconds if not completed. If no timeout is set, then either the default timeout is used or no timeout is configured.

Advanced options

`version`

--pytest-version=<str>
PANTS_PYTEST_VERSION

default: pytest==7.0.1

Requirement string for the tool.

`extra_requirements`

--pytest-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYTEST_EXTRA_REQUIREMENTS

default:

[
  "pytest-cov>=2.12,!=2.12.1,<3.1"
]

Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

`lockfile`

--pytest-lockfile=<str>
PANTS_PYTEST_LOCKFILE

default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.11.1rc2/src/python/pants/backend/python/subsystems/pytest.lock for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.

To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=pytest.

As explained at Third-party dependencies, lockfile generation via generate-lockfiles does not always work and you may want to manually generate the lockfile. You will want to set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.

`console_script`

--pytest-console-script=<str>
PANTS_PYTEST_CONSOLE_SCRIPT

default: pytest

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.

`entry_point`

--pytest-entry-point=<str>
PANTS_PYTEST_ENTRY_POINT

default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.

`timeout_default`

--pytest-timeout-default=<int>
PANTS_PYTEST_TIMEOUT_DEFAULT

default: None

The default timeout (in seconds) for a test target if the timeout field is not set on the target.

`timeout_maximum`

--pytest-timeout-maximum=<int>
PANTS_PYTEST_TIMEOUT_MAXIMUM

default: None

The maximum timeout (in seconds) that may be used on a python_tests target.

`junit_family`

--pytest-junit-family=<str>
PANTS_PYTEST_JUNIT_FAMILY

default: xunit2

The format of generated junit XML files. See https://docs.pytest.org/en/latest/reference.html#confval-junit_family.

`execution_slot_var`

--pytest-execution-slot-var=<str>
PANTS_PYTEST_EXECUTION_SLOT_VAR

default: None

If a non-empty string, the process execution slot id (an integer) will be exposed to tests under this environment variable name.

`config_discovery`

--[no-]pytest-config-discovery
PANTS_PYTEST_CONFIG_DISCOVERY

default: True

If true, Pants will include all relevant Pytest config files (e.g. pytest.ini) during runs. See https://docs.pytest.org/en/stable/customize.html#finding-the-rootdir for where config files should be located for Pytest to discover them.

Deprecated options

None