coverage-py

---

Configuration for Python test coverage measurement.

This version of Pants uses coverage version 7.6.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.

Backend: pants.backend.python

Config section: [coverage-py]

Basic options

fail_under

--coverage-py-fail-under=<float>
PANTS_COVERAGE_PY_FAIL_UNDER

pants.toml

[coverage-py]
fail_under = <float>

default: None

Fail if the total combined coverage percentage for all tests is less than this number.

Use this instead of setting fail_under in a coverage.py config file, as the config will apply to each test separately, while you typically want this to apply to the combined coverage for all tests run.

Note that you must generate at least one (non-raw) coverage report for this check to trigger.

Note also that if you specify a non-integral value, you must also set [report] precision properly in the coverage.py config file to make use of the decimal places. See https://coverage.readthedocs.io/en/latest/config.html.

filter

--coverage-py-filter="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_FILTER

pants.toml

[coverage-py]
filter = [
    '<str>',
    '<str>',
    ...,
]

default: []

A list of Python modules or filesystem paths to use in the coverage report, e.g. ['helloworld_test', 'helloworld/util/dirutil'].

For including files without any test in coverage calculation pass paths instead of modules. Paths need to be relative to the pants.toml.

Both modules and directory paths are recursive: any submodules or child paths, respectively, 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.

global_report

--[no-]coverage-py-global-report
PANTS_COVERAGE_PY_GLOBAL_REPORT

pants.toml

[coverage-py]
global_report = <bool>

default: False

If true, Pants will generate a global coverage report.

The global report will include all Python source files in the workspace and not just those depended on by the tests that were run.

report

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

pants.toml

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

one of: console, xml, html, raw, json, lcov
default:

[
  "console"
]

Which coverage report type(s) to emit.

Advanced options

config

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

pants.toml

[coverage-py]
config = <file_option>

default: None

Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/latest/config.html).

Setting this option will disable [coverage-py].config_discovery. Use this option if the config is located in a non-standard location.

config_discovery

--[no-]coverage-py-config-discovery
PANTS_COVERAGE_PY_CONFIG_DISCOVERY

pants.toml

[coverage-py]
config_discovery = <bool>

default: True

If true, Pants will include any relevant config files during runs (.coveragerc, setup.cfg, tox.ini, and pyproject.toml).

Use [coverage-py].config instead if your config is in a non-standard location.

console_script

--coverage-py-console-script=<str>
PANTS_COVERAGE_PY_CONSOLE_SCRIPT

pants.toml

[coverage-py]
console_script = <str>

default: coverage

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.

entry_point

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

pants.toml

[coverage-py]
entry_point = <str>

default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.

install_from_resolve

--coverage-py-install-from-resolve=<str>
PANTS_COVERAGE_PY_INSTALL_FROM_RESOLVE

pants.toml

[coverage-py]
install_from_resolve = <str>

default: None

If specified, install the tool using the lockfile for this named resolve.

This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/2.24/docs/python/overview/lockfiles#lockfiles-for-tools.

The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.

If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants, which uses coverage version 7.6.1.

If unspecified, and the lockfile option is set, the tool will use the custom coverage-py "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

interpreter_constraints

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

pants.toml

[coverage-py]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]

default:

[
  "CPython>=3.8,<4"
]

Python interpreter constraints for this tool.

output_dir

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

pants.toml

[coverage-py]
output_dir = <str>

default: {distdir}/coverage/python

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

requirements

--coverage-py-requirements="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_REQUIREMENTS

pants.toml

[coverage-py]
requirements = [
    '<str>',
    '<str>',
    ...,
]

default: []

If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.

Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets). Make sure to use the // prefix to refer to targets using their full address from the root (e.g. //3rdparty/python:tool). This is necessary to distinguish address specs from local or VCS requirements.

The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.

If unspecified, install the entire lockfile.

Deprecated options

None

Related subsystems

None