Skip to main content
Version: 2.5 (deprecated)

pytest

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

Backend: ``

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"

timeouts​

--[no-]pytest-timeouts
PANTS_PYTEST_TIMEOUTS
pants.toml
[pytest]
timeouts = <bool>
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​

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.

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.

junit_family​

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

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

junit_xml_dir​

--pytest-junit-xml-dir=<DIR>
PANTS_PYTEST_JUNIT_XML_DIR
pants.toml
[pytest]
junit_xml_dir = <DIR>
default: None

Specifying a directory causes Junit XML result files to be emitted under that dir for each test run.

pytest_plugins​

--pytest-pytest-plugins="['<str>', '<str>', ...]"
PANTS_PYTEST_PYTEST_PLUGINS
pants.toml
[pytest]
pytest_plugins = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "pytest-cov>=2.10.1,<2.12"
]

Requirement strings for any plugins or additional requirements you'd like to use.

timeout_default​

--pytest-timeout-default=<int>
PANTS_PYTEST_TIMEOUT_DEFAULT
pants.toml
[pytest]
timeout_default = <int>
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
pants.toml
[pytest]
timeout_maximum = <int>
default: None

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

version​

--pytest-version=<str>
PANTS_PYTEST_VERSION
pants.toml
[pytest]
version = <str>
default: pytest>=6.0.1,<6.3

Requirement string for Pytest.

Deprecated options​

config​

--pytest-config=<file_option>
PANTS_PYTEST_CONFIG
pants.toml
[pytest]
config = <file_option>
default: None
Deprecated, will be removed in version: 2.6.0.dev0.
Pants now auto-discovers config files, so there is no need to set `[pytest].config` if `[pytest].config_discovery` is enabled (the default).

Path to pytest.ini or alternative Pytest config file.

None