git.notmuchmail.org Git - notmuch/blob - bindings/python/docs/source/status_and_errors.rst

   1 .. currentmodule:: notmuch
   2
   3 Status and Errors
   4 =================
   5
   6 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`.
   7
   8 :class:`STATUS` -- Notmuch operation return value
   9 --------------------------------------------------
  10
  11 .. autoclass:: notmuch.STATUS
  12    :inherited-members:
  13
  14 .. automethod:: notmuch.STATUS.status2str
  15
  16 :exc:`NotmuchError` -- A Notmuch execution error
  17 ------------------------------------------------
  18 Whenever an error occurs, we throw a special Exception:
  19
  20 .. autoexception:: NotmuchError
  21    :members:
  22
  23    This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.