Code Coverage

Code Coverage checks if a source code was used during execution. Usually, testcases are run by a testcase execution framework like pytest, which also offers to instrument the code for code coverage collection using the pytest-cov plugin. For Python, coverage collection is usually based on Coverage.py, which supports statement and branch coverage collection.

Quick Configuration

See the overview page on how to setup and enable the Sphinx extension in general.

Note

This is a quick and minimal configuration. See below detailed explanations.

  1. Configure one or more coverage analysis reports in conf.py by adding a new ‘section’ defining some configuration variables. Each analysis report is identified by an ID, which is later referred to by the report directive. Here, the ID is called src (dictionary key). Each analysis report needs 4 configuration entries:

    name

    Name of the Python package[#PkgNameVsPkgDir]_.

    json_report

    The code coverage report as JSON file as generated by Coverage.py.

    fail_below

    An integer value in range 0..100, for when a code coverage is considered FAILED.

    levels

    A dictionary of coverage limits, their description and CSS style classes.

    # ==============================================================================
# Sphinx-reports - CodeCov
# ==============================================================================
report_codecov_packages = {
   "src": {
      "name":        "myPackage",
      "json_report": "../report/coverage/coverage.json",
      "fail_below":  80,
      "levels": {
         30:      {"class": "report-cov-below30",  "desc": "almost unused"},
         50:      {"class": "report-cov-below50",  "desc": "poorly used"},
         80:      {"class": "report-cov-below80",  "desc": "medium used"},
         90:      {"class": "report-cov-below90",  "desc": "well well"},
         100:     {"class": "report-cov-below100", "desc": "excellent used"},
         "error": {"class": "report-cov-error",    "desc": "internal error"},
      },
   }
}

  2. Add the code-coverage directive into your Restructured Text (ReST) document.

    .. report:code-coverage::
   :packageid: src

Example Document

The following coverage/index document is an example on how this documentation uses the code-coverage directive. The first file consists of three parts: At first, a headline; at second second a short introduction paragraph and at third, the report generating directive. The second file shows how to integrate that document into the navigation bar.

coverage/index.rst

Code Coverage Report
####################

Code coverage generated by `Coverage.py <https://github.com/nedbat/coveragepy>`__.

.. report:code-coverage::
   :packageid: src

index.rst

.. toctree::
   :caption: References and Reports
   :hidden:

   sphinx_reports/sphinx_reports
   unittests/index
   coverage/index
   Doc. Coverage Report <DocCoverage>
   Static Type Check Report ➚ <typing/index>

.. toctree::
   :caption: Appendix
   :hidden:

Directives

.. code-coverage::

Add a table summarizing the code coverage per Python source code file (packages and/or modules).

:packageid:

An identifier referencing a dictionary entry in the configuration variable report_codecov_packages defined in conf.py.

:legend:

Describes if and where to add a legend. Possible values: no_legend, top, bottom, both.

Roles

There are no roles defined.

Footnotes