diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2021-11-13 19:00:51 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2021-11-14 07:44:57 -0500 |
commit | 342e7da2941ae5291f1a94b6ad66ce489f6985fe (patch) | |
tree | 47dc5f4db2d314c4e0c8051e705222ae76899431 /coverage/exceptions.py | |
parent | b8eeb82bcc7350aade99844e8730e69120e9bed0 (diff) | |
download | python-coveragepy-git-342e7da2941ae5291f1a94b6ad66ce489f6985fe.tar.gz |
docs: document the exceptions
... and make some of them private.
Diffstat (limited to 'coverage/exceptions.py')
-rw-r--r-- | coverage/exceptions.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/coverage/exceptions.py b/coverage/exceptions.py index 6631e1ad..de2257a1 100644 --- a/coverage/exceptions.py +++ b/coverage/exceptions.py @@ -4,12 +4,12 @@ """Exceptions coverage.py can raise.""" -class BaseCoverageException(Exception): +class _BaseCoverageException(Exception): """The base of all Coverage exceptions.""" pass -class CoverageException(BaseCoverageException): +class CoverageException(_BaseCoverageException): """An exception raised by a coverage.py function.""" pass @@ -29,7 +29,7 @@ class NotPython(CoverageException): pass -class ExceptionDuringRun(CoverageException): +class _ExceptionDuringRun(CoverageException): """An exception happened while running customer code. Construct it with three arguments, the values from `sys.exc_info`. @@ -38,7 +38,7 @@ class ExceptionDuringRun(CoverageException): pass -class StopEverything(BaseCoverageException): +class _StopEverything(_BaseCoverageException): """An exception that means everything should stop. The CoverageTest class converts these to SkipTest, so that when running |