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
[coverage-py]
filter = [
'<str>',
'<str>',
...,
]
[]
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.
global_report
--[no-]coverage-py-global-report
PANTS_COVERAGE_PY_GLOBAL_REPORT
[coverage-py]
global_report = <bool>
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
[coverage-py]
report = [
<CoverageReportType>,
<CoverageReportType>,
...,
]
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
[coverage-py]
config = <file_option>
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.
To use a TOML config file, you should add the toml
library to [pytest].pytest_plugins
.
config_discovery
--[no-]coverage-py-config-discovery
PANTS_COVERAGE_PY_CONFIG_DISCOVERY
[coverage-py]
config_discovery = <bool>
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
[coverage-py]
console_script = <str>
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
[coverage-py]
entry_point = <str>
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.
extra_requirements
--coverage-py-extra-requirements="['<str>', '<str>', ...]"
PANTS_COVERAGE_PY_EXTRA_REQUIREMENTS
[coverage-py]
extra_requirements = [
'<str>',
'<str>',
...,
]
[]
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
[coverage-py]
interpreter_constraints = [
'<str>',
'<str>',
...,
]
[ "CPython>=3.6" ]
Python interpreter constraints for this tool.
output_dir
--coverage-py-output-dir=<str>
PANTS_COVERAGE_PY_OUTPUT_DIR
[coverage-py]
output_dir = <str>
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
[coverage-py]
version = <str>
coverage[toml]>=5.0.3,<5.1
Requirement string for the tool.
Deprecated options
None
Related subsystems
None