Skip to content

Commit

Permalink
Document show_contexts (#473)
Browse files Browse the repository at this point in the history
  • Loading branch information
bhrutledge committed Jun 1, 2021
1 parent 297965e commit edc60bb
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/contexts.rst
Expand Up @@ -2,10 +2,12 @@
Contexts
========

Coverage.py 5.0 can record separate coverage data for different contexts during
Coverage.py 5.0 can record separate coverage data for `different contexts`_ during
one run of a test suite. Pytest-cov can use this feature to record coverage
data for each test individually, with the ``--cov-context=test`` option.

.. _`different_contexts`: https://coverage.readthedocs.io/en/stable/contexts.html

The context name recorded in the coverage.py database is the pytest test id,
and the phase of execution, one of "setup", "run", or "teardown". These two
are separated with a pipe symbol. You might see contexts like::
Expand All @@ -16,3 +18,12 @@ are separated with a pipe symbol. You might see contexts like::

Note that parameterized tests include the values of the parameters in the test
id, and each set of parameter values is recorded as a separate test.

To view contexts when using ``--cov-report=html``, add this to your ``.coveragerc``::

[html]
show_contexts = True
The HTML report will include an annotation on each covered line, indicating the
number of contexts that executed the line. Clicking the annotation displays a
list of the contexts.

0 comments on commit edc60bb

Please sign in to comment.