aboutsummaryrefslogtreecommitdiff
path: root/bindings/python/docs/source/status_and_errors.rst
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2025-02-15 15:30:43 -0400
committerDavid Bremner <david@tethera.net>2025-02-22 07:01:47 -0400
commitd526797ad198e394bb8b4909f43976b76fb347f1 (patch)
treeb924eefb8a1278afb988387a67e9fe413738003e /bindings/python/docs/source/status_and_errors.rst
parent9782c8651192c1496541bd8949b7991c41528b3f (diff)
python: move legacy python bindings to contrib.
This forces us to verify the build and test suite completes without the legacy python bindings. As of this commit the legacy python bindings are unsupported by notmuch. They are provided in contrib/ for now, but will most likely eventually be removed from there as well. We recommend that downstream/distro packagers phase out their packages for the legacy python bindings.
Diffstat (limited to 'bindings/python/docs/source/status_and_errors.rst')
-rw-r--r--bindings/python/docs/source/status_and_errors.rst57
1 files changed, 0 insertions, 57 deletions
diff --git a/bindings/python/docs/source/status_and_errors.rst b/bindings/python/docs/source/status_and_errors.rst
deleted file mode 100644
index 68913f16..00000000
--- a/bindings/python/docs/source/status_and_errors.rst
+++ /dev/null
@@ -1,57 +0,0 @@
-.. currentmodule:: notmuch
-
-Status and Errors
-=================
-
-Some methods return a status, indicating if an operation was successful and what the error was. Most of these status codes are expressed as a specific value, the :class:`notmuch.STATUS`.
-
-.. note::
-
- Prior to version 0.12 the exception classes and the enumeration
- :class:`notmuch.STATUS` were defined in `notmuch.globals`. They
- have since then been moved into `notmuch.errors`.
-
-:class:`STATUS` -- Notmuch operation return value
---------------------------------------------------
-
-.. autoclass:: notmuch.STATUS
- :inherited-members:
-
-.. automethod:: notmuch.STATUS.status2str
-
-:exc:`NotmuchError` -- A Notmuch execution error
-------------------------------------------------
-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
-
-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:: UnsupportedOperationError(message=None)
- :members:
-.. autoexception:: UpgradeRequiredError(message=None)
- :members:
-.. autoexception:: PathError(message=None)
- :members:
-.. autoexception:: NotInitializedError(message=None)
- :members: