Configuration for Python test coverage measurement.
Config section: [coverage-py]
Basic options
--coverage-py-filter="['<str>', '<str>', ...]"PANTS_COVERAGE_PY_FILTERfilter
[]
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_REPORTreport
console, xml, html, raw, jsondefault:
[ "console" ]
Which coverage report type(s) to emit.
Advanced options
--coverage-py-version=<str>PANTS_COVERAGE_PY_VERSIONversion
coverage>=5.0.3,<5.1
Requirement string for the tool.
--coverage-py-extra-requirements="['<str>', '<str>', ...]"PANTS_COVERAGE_PY_EXTRA_REQUIREMENTSextra_requirements
[]
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_POINTentry_point
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_CONSTRAINTSinterpreter_constraints
[ "CPython>=3.6" ]
Python interpreter constraints for this tool.
--coverage-py-output-dir=<str>PANTS_COVERAGE_PY_OUTPUT_DIRoutput_dir
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_CONFIGconfig
None
Path to `.coveragerc` or alternative coverage config file
Deprecated options
None
Updated 2 months ago