coverage-py

Configuration for Python test coverage measurement.

Config section: [coverage-py]

Basic options

filter

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

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

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.


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.


global_report

--[no-]coverage-py-global-report
PANTS_COVERAGE_PY_GLOBAL_REPORT
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.


fail_under

--coverage-py-fail-under=<float>
PANTS_COVERAGE_PY_FAIL_UNDER
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 .


Advanced options

version

--coverage-py-version=<str>
PANTS_COVERAGE_PY_VERSION
default: coverage[toml]>=5.5,<5.6

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.


interpreter_constraints

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

Python interpreter constraints for this tool.


lockfile

--coverage-py-lockfile=<str>
PANTS_COVERAGE_PY_LOCKFILE
default: <default>

Path to a lockfile used for installing the tool.

Set to the string <default> to use a lockfile provided by Pants, so long as you have not changed the --version and --extra-requirements options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by [python-setup].invalid_lockfile_behavior). See https://github.com/pantsbuild/pants/blob/release_2.8.0.dev2/src/python/pants/backend/python/subsystems/coverage_py_lockfile.txt for the default lockfile contents.

Set to the string <none> to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.

To use a custom lockfile, set this option to a file path relative to the build root, then run ./pants generate-lockfiles --resolve=coverage-py.

Lockfile generation currently does not wire up the [python-repos] options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or pip freeze. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set [python-setup].invalid_lockfile_behavior = 'ignore'.


console_script

--coverage-py-console-script=<str>
PANTS_COVERAGE_PY_CONSOLE_SCRIPT
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
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.


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 an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/stable/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
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.


Deprecated options

None


Did this page help you?