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.6/docs/python-test-goal.
Backend: ``
dependencies
Iterable[str] | NoneNoneAddresses 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 | NoneNoneA human-readable description of the target.
Use ./pants list --documented :: to see all targets with descriptions.
extra_env_vars
Iterable[str] | NoneNoneAdditional environment variables to include in test processes. Entries are strings in the form ENV_VAR=value to use explicitly; or just ENV_VAR to copy the value of a variable in Pants's own environment. This will be merged with and override values from [test].extra_env_vars.
interpreter_constraints
Iterable[str] | NoneNoneThe 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.6/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.
runtime_package_dependencies
Iterable[str] | NoneNoneAddresses 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.
skip_bandit
boolFalseIf true, don't run Bandit on this target's code.
skip_black
boolFalseIf true, don't run Black on this target's code.
skip_docformatter
boolFalseIf true, don't run Docformatter on this target's code.
skip_flake8
boolFalseIf true, don't run Flake8 on this target's code.
skip_isort
boolFalseIf true, don't run isort on this target's code.
skip_mypy
boolFalseIf true, don't run MyPy on this target's code.
skip_pylint
boolFalseIf true, don't run Pylint on this target's code.
skip_tests
boolFalseIf true, don't run this target's tests.
sources
Iterable[str] | None('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] | NoneNoneArbitrary strings to describe a target.
For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.
timeout
int | NoneNoneA timeout (in seconds) used by each test file belonging to this target.
This only applies if the option --pytest-timeouts is set to True.