Configuration for Python test coverage measurement.
A list of Python modules or filesystem paths to use in the coverage report, e.g.
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.
--coverage-py-report="[<CoverageReportType>, <CoverageReportType>, ...]"
console, xml, html, raw, json, lcov
[ "console" ]
Which coverage report type(s) to emit.
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 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.
If specified, install the tool using the lockfile for this named resolve.
This resolve must be defined in
[python].resolves, as described in Third-party dependencies.
The resolve's entire lockfile will be installed, unless specific requirements are listed via the
requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.
If unspecified, and the
lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants.
If unspecified, and the
lockfile option is set, the tool will use the custom
coverage-py "tool lockfile" generated from the
extra_requirements options. But note that this mechanism is deprecated.
install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.
Values can be pip-style requirements (e.g.,
tool>=1.2.3), or addresses of
python_requirement targets (or targets that generate or depend on
The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.
If unspecified, install the entire lockfile.
--coverage-py-interpreter-constraints="['<str>', '<str>', ...]"
[ "CPython>=3.7,<4" ]
Python interpreter constraints for this tool.
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.
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.
Path to write the Pytest Coverage report to. Must be relative to the build root.
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.
If true, Pants will include any relevant config files during runs (
[coverage-py].config instead if your config is in a non-standard location.
Updated 2 days ago