Hey! These docs are for version 2.0, which is no longer officially supported. Click here for the latest version, 2.7!

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. Usually, you will not want to change this from the default.

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

Python interpreter constraints for this tool.

--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


Did this page help you?