diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2021-11-13 19:23:24 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2021-11-14 11:41:23 -0500 |
| commit | 1c29ef3e4b871508bb2defd6b47b9a745547b626 (patch) | |
| tree | 931fd2d7175321fd1549fd32e378cddcc99d2537 /doc | |
| parent | 342e7da2941ae5291f1a94b6ad66ce489f6985fe (diff) | |
| download | python-coveragepy-git-1c29ef3e4b871508bb2defd6b47b9a745547b626.tar.gz | |
refactor: specialize exceptions
CoverageException is fine as a base class, but not good to use for
raising (and catching sometimes). Introduce specialized exceptions that
allow third-party tools to integrate better.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.rst | 3 | ||||
| -rw-r--r-- | doc/api_exceptions.rst | 5 |
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/api.rst b/doc/api.rst index f5112165..7d04f03e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -26,6 +26,9 @@ interface. For example, a simple use would be:: cov.html_report() +Any of the methods can raise specialized exceptions described in +:ref:`api_exceptions`. + Coverage.py supports plugins that can change its behavior, to collect information from non-Python files, or to perform complex configuration. See :ref:`api_plugin` for details. diff --git a/doc/api_exceptions.rst b/doc/api_exceptions.rst index 38109657..e018a970 100644 --- a/doc/api_exceptions.rst +++ b/doc/api_exceptions.rst @@ -6,6 +6,11 @@ Coverage exceptions ------------------- +.. module:: coverage.exceptions + +.. autoclass:: CoverageException + .. automodule:: coverage.exceptions :noindex: :members: + :exclude-members: CoverageException |