python_source

A single Python source file.

Backend: pants.backend.python

dependencies

type: Iterable[str] | None
default: None

Addresses 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 ./pants dependencies or ./pants peek on this target to get the final result.

See Targets and BUILD files#target-addresses and Targets and BUILD files#target-generation for more about how addresses are formed, including for generated targets. You can also run ./pants list :: to find all addresses in your project, or ./pants 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.

description

type: str | None
default: None

A human-readable description of the target.

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

interpreter_constraints

type: 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 Interpreter compatibility for how these interpreter constraints are merged with the constraints of dependencies.

resolve

type: str | None
default: None

The 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.

skip_autoflake

type: bool
default: False
backend: pants.backend.experimental.python.lint.autoflake

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

skip_bandit

type: bool
default: False
backend: pants.backend.python.lint.bandit

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

skip_black

type: bool
default: False
backend: pants.backend.python.lint.black

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

skip_docformatter

type: bool
default: False
backend: pants.backend.python.lint.docformatter

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

skip_flake8

type: bool
default: False
backend: pants.backend.python.lint.flake8

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

skip_isort

type: bool
default: False
backend: pants.backend.python.lint.isort

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

skip_mypy

type: bool
default: False
backend: pants.backend.python.typecheck.mypy

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

skip_pylint

type: bool
default: False
backend: pants.backend.python.lint.pylint

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

skip_pyupgrade

type: bool
default: False
backend: pants.backend.experimental.python.lint.pyupgrade

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

skip_yapf

type: bool
default: False
backend: pants.backend.python.lint.yapf

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

source

type: str
required

A single file that belongs to this target.

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

tags

type: 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.