python_tests
Generate a python_test target for each file in the sources field.
Backend: pants.backend.python
tags
field.type_hintArbitrary strings to describe a target.
For example, you may tag some test targets with 'integration_test' so that you could run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 --tag='integration_test' test :: to only run on targets with that tag.
description
field.type_hintA human-readable description of the target.
Use /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list --documented :: to see all targets with descriptions.
sources
field.type_hint('test_*.py', '*_test.py', 'tests.py')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.ext', 'test_*.ext', '!test_ignore.ext'].
overrides
field.type_hintOverride the field values for generated python_test targets.
Expects a dictionary of relative file paths and globs to a dictionary for the overrides. You may either use a string for a single path / glob, or a string tuple for multiple paths / globs. Each override is a dictionary of field names to the overridden value.
For example:
overrides={
"foo_test.py": {"timeout": 120]},
"bar_test.py": {"timeout": 200]},
("foo_test.py", "bar_test.py"): {"tags": ["slow_tests"]},
}
File paths and globs are relative to the BUILD file's directory. Every overridden file is validated to belong to this target's sources field.
If you'd like to override a field's value for every python_test target generated by this target, change the field directly on this target rather than using the overrides field.
You can specify the same file name in multiple keys, so long as you don't override the same field more than one time for the file.
skip_autoflake
field.type_hintFalsepants.backend.experimental.python.lint.autoflakeIf true, don't run Autoflake on this target's code.
skip_pyupgrade
field.type_hintFalsepants.backend.experimental.python.lint.pyupgradeIf true, don't run pyupgrade on this target's code.
skip_bandit
field.type_hintFalsepants.backend.python.lint.banditIf true, don't run Bandit on this target's code.
skip_black
field.type_hintFalsepants.backend.python.lint.blackIf true, don't run Black on this target's code.
skip_docformatter
field.type_hintFalsepants.backend.python.lint.docformatterIf true, don't run Docformatter on this target's code.
skip_flake8
field.type_hintFalsepants.backend.python.lint.flake8If true, don't run Flake8 on this target's code.
skip_isort
field.type_hintFalsepants.backend.python.lint.isortIf true, don't run isort on this target's code.
skip_pylint
field.type_hintFalsepants.backend.python.lint.pylintIf true, don't run Pylint on this target's code.
skip_yapf
field.type_hintFalsepants.backend.python.lint.yapfIf true, don't run yapf on this target's code.
skip_mypy
field.type_hintFalsepants.backend.python.typecheck.mypyIf true, don't run MyPy on this target's code.
dependencies
field.type_hintAddresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].
This augments any dependencies inferred by Pants, such as by analyzing your imports. Use /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 dependencies or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 peek on this target to get the final result.
See https://www.pantsbuild.org/v2.11/docs/targets#target-addresses and https://www.pantsbuild.org/v2.11/docs/targets#target-generation for more about how addresses are formed, including for generated targets. You can also run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list :: to find all addresses in your project, or /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 list dir: to find all addresses defined in that directory.
If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.
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.
resolve
field.type_hintThe resolve from [python].resolves to use.
If not defined, will default to [python].default_resolve.
All dependencies must share the same value for their resolve field.
timeout
field.type_hintA timeout (in seconds) used by each test file belonging to this target.
If unset, will default to [pytest].timeout_default; if that option is also unset, then the test will never time out. Will never exceed [pytest].timeout_maximum. Only applies if the option --pytest-timeouts is set to true (the default).
runtime_package_dependencies
field.type_hintAddresses to targets that can be built with the /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 package goal and whose resulting artifacts should be included in the test run.
Pants will build the artifacts as if you had run /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 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 /home/josh/work/scie-pants/dist/scie-pants-linux-x86_64 package, e.g. a pex_binary, python_awslambda, or an archive.
extra_env_vars
field.type_hintAdditional 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
field.type_hintThe 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].interpreter_constraints.
See https://www.pantsbuild.org/v2.11/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.
skip_tests
field.type_hintFalseIf true, don't run this target's tests.