Backends
How to enable specific functionality.
Most Pants functionality is opt-in by adding the relevant backend to the [GLOBAL].backend_packages
option in pants.toml
. For example:
[GLOBAL]
backend_packages = [
"pants.backend.shell",
"pants.backend.python",
"pants.backend.python.lint.black",
]
Available backends
Backend | What it does | Docs |
---|---|---|
| Enables generating an AWS Lambda zip file from Python code. | |
| Enables generating Python from Protocol Buffers. Includes gRPC support. | |
| Enables generating Python from Apache Thrift. | |
| Enables building, running, and publishing Docker images. | |
| Enables Hadolint, a Docker linter: https://github.com/hadolint/hadolint | |
| Enables Go support. | |
| Enables core Java support. | |
| Enables Google Java Format. | |
| Enables core Scala support. | |
| Enables the Scalafmt formatter. | |
| Enables Autoflake, which removes unused Python imports: https://pypi.org/project/autoflake/ | |
| Enables Pyupgrade, which upgrades to new Python syntax: https://pypi.org/project/pyupgrade/ | |
| Enables generating a Google Cloud Function from Python code. | |
| Core Python support. | |
| Adds the | |
| Enables Bandit, the Python security linter: https://bandit.readthedocs.io/en/latest/. | |
| Enables Black, the Python autoformatter: https://black.readthedocs.io/en/stable/. | |
| Enables Docformatter, the Python docstring autoformatter: https://github.com/myint/docformatter. | |
| Enables Flake8, the Python linter: https://flake8.pycqa.org/en/latest/. | |
| Enables isort, the Python import autoformatter: https://timothycrosley.github.io/isort/. | |
| Enables Pylint, the Python linter: https://www.pylint.org | |
| Enables Yapf, the Python formatter: https://pypi.org/project/yapf/ | |
| Enables MyPy, the Python type checker: https://mypy.readthedocs.io/en/stable/. | |
| Core Shell support, including shUnit2 test runner. | |
| Enables shfmt, a Shell autoformatter: https://github.com/mvdan/sh. | |
| Enables Shellcheck, a Shell linter: https://www.shellcheck.net/. |
Updated 6 months ago