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

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>=6.0.1,<6.3

Requirement string for Pytest.


pytest_plugins

--pytest-pytest-plugins="['<str>', '<str>', ...]"
PANTS_PYTEST_PYTEST_PLUGINS
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
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_xml_dir

--pytest-junit-xml-dir=<DIR>
PANTS_PYTEST_JUNIT_XML_DIR
default: None

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


junit_family

--pytest-junit-family=<str>
PANTS_PYTEST_JUNIT_FAMILY
default: xunit2

The format of the generated XML file. 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

config

--pytest-config=<file_option>
PANTS_PYTEST_CONFIG
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.



Did this page help you?