python_tests

---

Python tests, written in either Pytest style or unittest style.

All test util code, other than conftest.py, should go into a dedicated python_library() target and then be included in the dependencies field.

See https://www.pantsbuild.org/v2.2/docs/python-test-goal.

Backend: ``

---

dependencies

Iterable[str] | None

default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description

str | None

default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

interpreter_constraints

Iterable[str] | None

default: None

The Python interpreters this code is compatible with.

Each element should be written in pip-style format, e.g. 'CPython==2.7.*' or 'CPython>=3.6,<4'. You can leave off CPython as a shorthand, e.g. '>=2.7' will be expanded to 'CPython>=2.7'.

Specify more than one element to OR the constraints, e.g. ['PyPy==3.7.*', 'CPython==3.7.*'] means either PyPy 3.7 or CPython 3.7.

If the field is not set, it will default to the option [python-setup].interpreter_constraints.

See https://www.pantsbuild.org/v2.2/docs/python-interpreter-compatibility.

runtime_package_dependencies

Iterable[str] | None

default: None

Addresses to targets that can be built with the ./pants package goal and whose resulting artifacts should be included in the test run.

Pants will build the artifacts as if you had run ./pants package. It will include the results in your test's chroot, using the same name they would normally have, but without the --distdir prefix (e.g. dist/).

You can include anything that can be built by ./pants package, e.g. a pex_binary, python_awslambda, or an archive.

sources

Iterable[str] | None

default: ('test_*.py', '*_test.py', 'tests.py', 'conftest.py', 'test_*.pyi', '*_test.pyi', 'tests.pyi')

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['example.py', 'test_*.py', '!test_ignore.py'].

tags

Iterable[str] | None

default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tags='integration_test' test :: to only run on targets with that tag.

timeout

int | None

default: None

A timeout (in seconds) which covers the total runtime of all tests in this target.

This only applies if the option --pytest-timeouts is set to True.