python_source
A single Python source file.
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 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 scie-pants-linux-x86_64 list --documented :: to see all targets with descriptions.
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.18/docs/python-interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.
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 scie-pants-linux-x86_64 dependencies or scie-pants-linux-x86_64 peek on this target to get the final result.
See https://www.pantsbuild.org/v2.18/docs/targets for more about how addresses are formed, including for generated targets. You can also run scie-pants-linux-x86_64 list :: to find all addresses in your project, or 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.
run_goal_use_sandbox
field.type_hintWhether to use a sandbox when running 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.
Note that this field only applies when running a target with the run goal. No other goals (such as test, if applicable) consult this field.
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.
source
field.type_hintA single file that belongs to this target.
Path is relative to the BUILD file's directory, e.g. source='example.ext'.
restartable
field.type_hintFalseIf true, runs of this target with the run goal may be interrupted and restarted when its input files change.
skip_pylint
field.type_hintFalsepants.backend.python.lint.pylintIf true, don't run Pylint on this target's code.
skip_pytype
field.type_hintFalsepants.backend.experimental.python.typecheck.pytypeIf true, don't run pytype on this target's code.
skip_autoflake
field.type_hintFalsepants.backend.python.lint.autoflakeIf true, don't run Autoflake 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_mypy
field.type_hintFalsepants.backend.python.typecheck.mypyIf true, don't run MyPy 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_pydocstyle
field.type_hintFalsepants.backend.python.lint.pydocstyleIf true, don't run pydocstyle 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_ruff
field.type_hintFalsepants.backend.experimental.python.lint.ruffIf true, don't run ruff 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_add_trailing_comma
field.type_hintFalsepants.backend.experimental.python.lint.add_trailing_commaIf true, don't run add-trailing-comma 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_pyupgrade
field.type_hintFalsepants.backend.python.lint.pyupgradeIf true, don't run pyupgrade on this target's code.
skip_black
field.type_hintFalsepants.backend.python.lint.blackIf true, don't run Black on this target's code.