sphinx_reports.Adapter.Coverage

A Sphinx extension providing code coverage details embedded in documentation pages.

Exceptions

• CodeCoverageError: Extension error.

Classes

• Analyzer: An analyzer to read and transform code coverage data from JSON format to a generic data model.

---

Exceptions

exception sphinx_reports.Adapter.Coverage.CodeCoverageError(message, orig_exc=None, modname=None)

Inheritance

Parameters:

• message (str)

• orig_exc (Exception | None)

• modname (str | None)

Return type:

None

---

Classes

class sphinx_reports.Adapter.Coverage.Analyzer(packageName, jsonCoverageFile)

An analyzer to read and transform code coverage data from JSON format to a generic data model.

Coverage.py can provide collected statement and branch coverage metrics as JSON data, which can be converted to a generic code coverage model.

Inheritance

Parameters:

• packageName (str)

• jsonCoverageFile (Path)

__init__(packageName, jsonCoverageFile)

Read a JSON file containing code coverage metrics generated by Coverage.py.

Parameters:

• packageName (str) – Name of the Python package that was analyzed.

• jsonCoverageFile (Path) – JSON file containing statement and/or branch coverage.

Raises:

CodeCoverageError – If JSON file doesn’t exist.

Return type:

None

property PackageName: str

Read-only property to access the analyzed package’s name.

Returns:

Name of the analyzed package.

property JSONCoverageFile: Path

Read-only property to access the parsed JSON file.

Returns:

Path to the parsed JSON file.