Skip to main content
Version: 2.2 (deprecated)

coverage-py

Configuration for Python test coverage measurement.

Backend: ``

Config section: [coverage-py]

Basic options​

filter​

--coverage-py-filter="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_FILTER
pants.toml
[coverage-py]
filter = [
    '<str>',
    '<str>',
    ...,
]
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.

report​

--coverage-py-report="[<CoverageReportType>, <CoverageReportType>, ...]"
PANTS_COVERAGE_PY_REPORT
pants.toml
[coverage-py]
report = [
    <CoverageReportType>,
    <CoverageReportType>,
    ...,
]
one of: console, xml, html, raw, json
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 .coveragerc or alternative coverage config file

entry_point​

--coverage-py-entry-point=<str>
PANTS_COVERAGE_PY_ENTRY_POINT
pants.toml
[coverage-py]
entry_point = <str>
default: coverage

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

extra_requirements​

--coverage-py-extra-requirements="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_EXTRA_REQUIREMENTS
pants.toml
[coverage-py]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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
pants.toml
[coverage-py]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.6"
]

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: dist/coverage/python

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

version​

--coverage-py-version=<str>
PANTS_COVERAGE_PY_VERSION
pants.toml
[coverage-py]
version = <str>
default: coverage>=5.0.3,<5.1

Requirement string for the tool.

Deprecated options​

None

None