coverage-py

---

Configuration for Python test coverage measurement.

Backend: pants.core

Config section: [coverage-py]

Basic options

filter

--coverage-py-filter="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_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, whereastest project/app_test.pywill includeapp_test.py` and any of its transitive dependencies.

report

--coverage-py-report="[<CoverageReportType>, <CoverageReportType>, ...]"
PANTS_COVERAGE_PY_REPORT

one of: console, xml, html, raw, json
default: ["console"]

Which coverage report type(s) to emit.

Advanced options

version

--coverage-py-version=<str>
PANTS_COVERAGE_PY_VERSION

default: coverage>=5.0.3,<5.1

Requirement string for the tool.

extra_requirements

--coverage-py-extra-requirements="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_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.

entry_point

--coverage-py-entry-point=<str>
PANTS_COVERAGE_PY_ENTRY_POINT

default: coverage

The main module for the tool. Usually, you will not want to change this from the default.

interpreter_constraints

--coverage-py-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_INTERPRETER_CONSTRAINTS

default: ["CPython>=3.6"]

Python interpreter constraints for this tool.

output_dir

--coverage-py-output-dir=<str>
PANTS_COVERAGE_PY_OUTPUT_DIR

default: dist/coverage/python

Path to write the Pytest Coverage report to. Must be relative to build root.

config

--coverage-py-config=<file_option>
PANTS_COVERAGE_PY_CONFIG

default: None

Path to .coveragerc or alternative coverage config file

Deprecated options

None