python_source
A single Python source file.
Backend: pants.backend.python
source
str
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
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 /home/josh/work/scie-pants/dist/pants dependencies
or /home/josh/work/scie-pants/dist/pants peek
on this target to get the final result.
See https://www.pantsbuild.org/v2.15/docs/targets for more about how addresses are formed, including for generated targets. You can also run /home/josh/work/scie-pants/dist/pants list ::
to find all addresses in your project, or /home/josh/work/scie-pants/dist/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
str | None
None
A human-readable description of the target.
Use /home/josh/work/scie-pants/dist/pants list --documented ::
to see all targets with descriptions.
interpreter_constraints
Iterable[str] | None
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.15/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.
resolve
str | None
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.
run_goal_use_sandbox
bool | None
None
Whether to use a sandbox when run
ning this target. Defaults to [python].run_goal_use_sandbox
.
If true, runs of this target with the run
goal will copy the needed first-party sources into a temporary sandbox and run from there.
If false, runs of this target with the run
goal will use the in-repo sources directly.
The former mode is more hermetic, and is closer to building and running the source as it were packaged in a pex_binary
. Additionally, it may be necessary if your sources depend transitively on "generated" files which will be materialized in the sandbox in a source root, but are not in-repo.
The latter mode is similar to creating, activating, and using a virtual environment when running your files. It may also be necessary if the source being run writes files into the repo and computes their location relative to the executed files. Django's makemigrations command is an example of such a process.
skip_add_trailing_comma
bool
False
pants.backend.experimental.python.lint.add_trailing_comma
If true, don't run add-trailing-comma on this target's code.
skip_autoflake
bool
False
pants.backend.experimental.python.lint.autoflake
If true, don't run Autoflake on this target's code.
skip_bandit
bool
False
pants.backend.python.lint.bandit
If true, don't run Bandit on this target's code.
skip_black
bool
False
pants.backend.python.lint.black
If true, don't run Black on this target's code.
skip_docformatter
bool
False
pants.backend.python.lint.docformatter
If true, don't run Docformatter on this target's code.
skip_flake8
bool
False
pants.backend.python.lint.flake8
If true, don't run Flake8 on this target's code.
skip_isort
bool
False
pants.backend.python.lint.isort
If true, don't run isort on this target's code.
skip_mypy
bool
False
pants.backend.python.typecheck.mypy
If true, don't run MyPy on this target's code.
skip_pylint
bool
False
pants.backend.python.lint.pylint
If true, don't run Pylint on this target's code.
skip_pyupgrade
bool
False
pants.backend.experimental.python.lint.pyupgrade
If true, don't run pyupgrade on this target's code.
skip_yapf
bool
False
pants.backend.python.lint.yapf
If true, don't run yapf on this target's code.
tags
Iterable[str] | None
None
Arbitrary 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/pants --tag='integration_test' test ::
to only run on targets with that tag.