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

coverage-py

Configuration for Python test coverage measurement.

Config section: [coverage-py]

Basic options

--coverage-py-filter="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_FILTER
filter
default: []
A list of Python modules to use in the coverage report, e.g. `['helloworld_test', 'helloworld.util.dirutil']. The modules are recursive: any submodules will be included. If you leave this off, the coverage report will include every file in the transitive closure of the address/file arguments; for example, `test ::` will include every Python file in your project, whereas `test project/app_test.py` will include `app_test.py` and any of its transitive dependencies.

--coverage-py-report="[<CoverageReportType>, <CoverageReportType>, ...]"
PANTS_COVERAGE_PY_REPORT
report
one of: console, xml, html, raw, json
default:
[
  "console"
]

Which coverage report type(s) to emit.

Advanced options

--coverage-py-version=<str>
PANTS_COVERAGE_PY_VERSION
version
default: coverage>=5.0.3,<5.1
Requirement string for the tool.

--coverage-py-extra-requirements="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_EXTRA_REQUIREMENTS
extra_requirements
default: []
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

--coverage-py-entry-point=<str>
PANTS_COVERAGE_PY_ENTRY_POINT
entry_point
default: coverage
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.

--coverage-py-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_INTERPRETER_CONSTRAINTS
interpreter_constraints
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.

--coverage-py-output-dir=<str>
PANTS_COVERAGE_PY_OUTPUT_DIR
output_dir
default: dist/coverage/python
Path to write the Pytest Coverage report to. Must be relative to build root.

--coverage-py-config=<file_option>
PANTS_COVERAGE_PY_CONFIG
config
default: None
Path to `.coveragerc` or alternative coverage config file

Deprecated options

None

Updated about a month ago


coverage-py


Suggested Edits are limited on API Reference Pages

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