Pants v2: Fast, consistent builds for Python and more

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started
./pants lint [args]

Run all linters and/or formatters in check mode.

Config section: [lint]

Basic options

None

Advanced options

--[no-]lint-per-file-caching
PANTS_LINT_PER_FILE_CACHING
per_file_caching
default: False

Rather than linting all files in a single batch, lint each file as a separate process.

Why do this? You'll get many more cache hits. Why not do this? Linters both have substantial startup overhead and are cheap to add one additional file to the run. On a cold cache, it is much faster to use --no-per-file-caching.

We only recommend using --per-file-caching if you are using a remote cache or if you have benchmarked that this option will be faster than --no-per-file-caching for your use case.


--lint-reports-dir=<DIR>
PANTS_LINT_REPORTS_DIR
reports_dir
default: None

Specifying a directory causes linters that support writing report files to write into this directory.


Deprecated options

None

Related subsystems

bandit, black, docformatter, download-pex-bin, flake8, grpc_python_plugin, isort, lint, pex, protoc, pylint, python-infer, python-native-code, python-protobuf, python-repos, python-setup, source, subprocess-environment

Updated 2 months ago


lint


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.