Skip to main content
Version: 2.8 (deprecated)

python_test

A single Python test file, written in either Pytest style or unittest style.

All test util code, including conftest.py, should go into a dedicated python_source target and then be included in the dependencies field.

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

Backend: ``

source​

str
required

A single file that belongs to this target.

Path is relative to the BUILD file's directory, e.g. source='example.ext'.

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.

experimental_resolve​

str | None
default: None

The resolve from [python].experimental_resolves_to_lockfiles to use, if any.

This field is highly experimental and may change without the normal deprecation policy.

extra_env_vars​

Iterable[str] | None
default: None

Additional 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] | 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].interpreter_constraints.

See https://www.pantsbuild.org/v2.8/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.

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.

skip_autoflake​

bool
default: False

If true, don't run Autoflake on this target's code.

skip_bandit​

bool
default: False

If true, don't run Bandit on this target's code.

skip_black​

bool
default: False

If true, don't run Black on this target's code.

skip_docformatter​

bool
default: False

If true, don't run Docformatter on this target's code.

skip_flake8​

bool
default: False

If true, don't run Flake8 on this target's code.

skip_isort​

bool
default: False

If true, don't run isort on this target's code.

skip_mypy​

bool
default: False

If true, don't run MyPy on this target's code.

skip_pylint​

bool
default: False

If true, don't run Pylint on this target's code.

skip_pyupgrade​

bool
default: False

If true, don't run pyupgrade on this target's code.

skip_tests​

bool
default: False

If true, don't run this target's tests.

skip_yapf​

bool
default: False

If true, don't run yapf on this target's code.

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 --tag='integration_test' test :: to only run on targets with that tag.

timeout​

int | None
default: None

A timeout (in seconds) used by each test file belonging to this target.

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