debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-25 10:54:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: Add the new exception types in the API documentation

Browse source 
as they should be documented...

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
This commit is contained in:
Sebastian Spaeth 2011-10-05 16:58:13 +02:00
parent 05926adf73
commit 2b43a65c1c
1 changed files with 25 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
bindings/python/docs/source/status_and_errors.rst
View file

@ -15,9 +15,31 @@ Some methods return a status, indicating if an operation was successful and what
:exc:`NotmuchError` -- A Notmuch execution error
------------------------------------------------
Whenever an error occurs, we throw a special Exception:
Whenever an error occurs, we throw a special Exception :exc:`NotmuchError`, or a more fine grained Exception which is derived from it. This means it is always safe to check for NotmuchErrors if you want to catch all errors. If you are interested in more fine grained exceptions, you can use those below.
.. autoexception:: NotmuchError
:members:
This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
The following exceptions are all directly derived from NotmuchError. Each of them corresponds to a specific :class:`notmuch.STATUS` value. You can either check the :attr:`status` attribute of a NotmuchError to see if a specific error has occurred, or you can directly check for the following Exception types:
.. autoexception:: OutOfMemoryError(message=None)
:members:
.. autoexception:: ReadOnlyDatabaseError(message=None)
:members:
.. autoexception:: XapianError(message=None)
:members:
.. autoexception:: FileError(message=None)
:members:
.. autoexception:: FileNotEmailError(message=None)
:members:
.. autoexception:: DuplicateMessageIdError(message=None)
:members:
.. autoexception:: NullPointerError(message=None)
:members:
.. autoexception:: TagTooLongError(message=None)
:members:
.. autoexception:: UnbalancedFreezeThawError(message=None)
:members:
.. autoexception:: UnbalancedAtomicError(message=None)
:members:
.. autoexception:: NotInitializedError(message=None)
:members: