Skip to main content
Version: 2.29

pytest

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

This version of Pants uses pytest version 8.4.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.

Backend: pants.backend.python

Config section: [pytest]

Basic options​

args​

--pytest-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_PYTEST_ARGS
pants.toml
[pytest]
args = [
  <shell_str>,
  <shell_str>,
  ...,
]
default: []

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

skip​

--[no-]pytest-skip
PANTS_PYTEST_SKIP
pants.toml
[pytest]
skip = <bool>
default: False

If true, don't use Pytest when running pants test.

xdist_enabled​

--[no-]pytest-xdist-enabled
PANTS_PYTEST_XDIST_ENABLED
pants.toml
[pytest]
xdist_enabled = <bool>
default: False

If true, Pants will use pytest-xdist (https://pytest-xdist.readthedocs.io/en/latest/) to parallelize tests within each python_test target.

NOTE: Enabling pytest-xdist can cause high-level scoped fixtures (for example session) to execute more than once. See the pytest-xdist docs for more info: https://pypi.org/project/pytest-xdist/#making-session-scoped-fixtures-execute-only-once

Advanced options​

config​

--pytest-config=<file_option>
PANTS_PYTEST_CONFIG
pants.toml
[pytest]
config = <file_option>
default: None

Path to a config file understood by Pytest (https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats). Setting this option will disable [pytest].config_discovery. Use this option if the config is located in a non-standard location.

config_discovery​

--[no-]pytest-config-discovery
PANTS_PYTEST_CONFIG_DISCOVERY
pants.toml
[pytest]
config_discovery = <bool>
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.

Use [pytest].config instead if your config is in a non-standard location.

console_script​

--pytest-console-script=<str>
PANTS_PYTEST_CONSOLE_SCRIPT
pants.toml
[pytest]
console_script = <str>
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
pants.toml
[pytest]
entry_point = <str>
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.

execution_slot_var​

--pytest-execution-slot-var=<str>
PANTS_PYTEST_EXECUTION_SLOT_VAR
pants.toml
[pytest]
execution_slot_var = <str>
default: None

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

install_from_resolve​

--pytest-install-from-resolve=<str>
PANTS_PYTEST_INSTALL_FROM_RESOLVE
pants.toml
[pytest]
install_from_resolve = <str>
default: None

If specified, install the tool using the lockfile for this named resolve.

This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/2.29/docs/python/overview/lockfiles#lockfiles-for-tools.

The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.

If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants, which uses pytest version 8.4.1.

If unspecified, and the lockfile option is set, the tool will use the custom pytest "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

junit_family​

--pytest-junit-family=<str>
PANTS_PYTEST_JUNIT_FAMILY
pants.toml
[pytest]
junit_family = <str>
default: xunit2

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

requirements​

--pytest-requirements="['<str>', '<str>', ...]"
PANTS_PYTEST_REQUIREMENTS
pants.toml
[pytest]
requirements = [
  '<str>',
  '<str>',
  ...,
]
default: []

If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.

Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets). Make sure to use the // prefix to refer to targets using their full address from the root (e.g. //3rdparty/python:tool). This is necessary to distinguish address specs from local or VCS requirements.

The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.

If unspecified, install the entire lockfile.

Deprecated options​

None

None