diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2019-04-28 15:48:11 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-04-28 15:48:11 -0400 |
commit | 5d589558c585686e051fc34df52803873e560907 (patch) | |
tree | c1478b63723c850cd16ea504089e53ce8917b1a1 /doc | |
parent | 50ebf93932abac7b163ae98a724ec20c327ba588 (diff) | |
download | python-coveragepy-git-5d589558c585686e051fc34df52803873e560907.tar.gz |
Docs for new dynamic context techniques
Diffstat (limited to 'doc')
-rw-r--r-- | doc/contexts.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/contexts.rst b/doc/contexts.rst index 121bd491..e3974ea2 100644 --- a/doc/contexts.rst +++ b/doc/contexts.rst @@ -11,6 +11,8 @@ Measurement contexts .. versionadded:: 5.0 +.. module:: coverage + Coverage.py measures whether code was run, but it can also record the context in which it was run. This can provide more information to help you understand the behavior of your tests. @@ -19,6 +21,7 @@ There are two kinds of context: static and dynamic. Static contexts are fixed for an entire run, and are set explicitly with an option. Dynamic contexts change over the course of a single run. +.. _static_contexts: Static contexts --------------- @@ -36,6 +39,8 @@ A static context is specified with the ``--context=CONTEXT`` option to the configuration file. +.. _dynamic_contexts: + Dynamic contexts ---------------- @@ -45,12 +50,15 @@ context tracking. As execution proceeds, the dynamic context changes to record the context of execution. Separate data is recorded for each context, so that it can be analyzed later. -There are two ways to enable dynamic contexts: +There are three ways to enable dynamic contexts: * you can set the ``[run] dynamic_context`` option in your .coveragerc file, or * you can enable a :ref:`dynamic context switcher <dynamic_context_plugins>` - plugin. + plugin, or + +* another tool (such as a test runner) can call the + :meth:`Coverage.switch_context` method to set the context explicitly. The ``[run] dynamic_context`` setting has only one option now. Set it to ``test_function`` to start a new dynamic context for every test function:: |