The pytest Python test framework (https://docs.pytest.org/).
--pytest-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
Arguments to pass directly to Pytest, e.g.
--pytest-args='-k test_foo --quiet'.
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.
If true, export a virtual environment with Pytest when running
This can be useful, for example, with IDE integrations to point your editor to the tool's binary.
Requirement string for the tool.
--pytest-extra-requirements="['<str>', '<str>', ...]"
[ "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.
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
--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.12.1/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.
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.
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.
The default timeout (in seconds) for a test target if the
timeout field is not set on the target.
The maximum timeout (in seconds) that may be used on a
The format of generated junit XML files. See https://docs.pytest.org/en/latest/reference.html#confval-junit_family.
If a non-empty string, the process execution slot id (an integer) will be exposed to tests under this environment variable name.
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.
Updated 9 months ago