git.notmuchmail.org Git - notmuch/blob - bindings/python-cffi/notmuch2/_errors.py

   1 from notmuch2 import _capi as capi
   2
   3
   4 class NotmuchError(Exception):
   5     """Base exception for errors originating from the notmuch library.
   6
   7     Usually this will have two attributes:
   8
   9     :status: This is a numeric status code corresponding to the error
  10        code in the notmuch library.  This is normally fairly
  11        meaningless, it can also often be ``None``.  This exists mostly
  12        to easily create new errors from notmuch status codes and
  13        should not normally be used by users.
  14
  15     :message: A user-facing message for the error.  This can
  16        occasionally also be ``None``.  Usually you'll want to call
  17        ``str()`` on the error object instead to get a sensible
  18        message.
  19     """
  20
  21     @classmethod
  22     def exc_type(cls, status):
  23         """Return correct exception type for notmuch status."""
  24         types = {
  25             capi.lib.NOTMUCH_STATUS_OUT_OF_MEMORY:
  26                 OutOfMemoryError,
  27             capi.lib.NOTMUCH_STATUS_READ_ONLY_DATABASE:
  28                 ReadOnlyDatabaseError,
  29             capi.lib.NOTMUCH_STATUS_XAPIAN_EXCEPTION:
  30                 XapianError,
  31             capi.lib.NOTMUCH_STATUS_FILE_ERROR:
  32                 FileError,
  33             capi.lib.NOTMUCH_STATUS_FILE_NOT_EMAIL:
  34                 FileNotEmailError,
  35             capi.lib.NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
  36                 DuplicateMessageIdError,
  37             capi.lib.NOTMUCH_STATUS_NULL_POINTER:
  38                 NullPointerError,
  39             capi.lib.NOTMUCH_STATUS_TAG_TOO_LONG:
  40                 TagTooLongError,
  41             capi.lib.NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
  42                 UnbalancedFreezeThawError,
  43             capi.lib.NOTMUCH_STATUS_UNBALANCED_ATOMIC:
  44                 UnbalancedAtomicError,
  45             capi.lib.NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
  46                 UnsupportedOperationError,
  47             capi.lib.NOTMUCH_STATUS_UPGRADE_REQUIRED:
  48                 UpgradeRequiredError,
  49             capi.lib.NOTMUCH_STATUS_PATH_ERROR:
  50                 PathError,
  51             capi.lib.NOTMUCH_STATUS_ILLEGAL_ARGUMENT:
  52                 IllegalArgumentError,
  53         }
  54         return types[status]
  55
  56     def __new__(cls, *args, **kwargs):
  57         """Return the correct subclass based on status."""
  58         # This is simplistic, but the actual __init__ will fail if the
  59         # signature is wrong anyway.
  60         if args:
  61             status = args[0]
  62         else:
  63             status = kwargs.get('status', None)
  64         if status and cls == NotmuchError:
  65             exc = cls.exc_type(status)
  66             return exc.__new__(exc, *args, **kwargs)
  67         else:
  68             return super().__new__(cls)
  69
  70     def __init__(self, status=None, message=None):
  71         self.status = status
  72         self.message = message
  73
  74     def __str__(self):
  75         if self.message:
  76             return self.message
  77         elif self.status:
  78             return capi.lib.notmuch_status_to_string(self.status)
  79         else:
  80             return 'Unknown error'
  81
  82
  83 class OutOfMemoryError(NotmuchError): pass
  84 class ReadOnlyDatabaseError(NotmuchError): pass
  85 class XapianError(NotmuchError): pass
  86 class FileError(NotmuchError): pass
  87 class FileNotEmailError(NotmuchError): pass
  88 class DuplicateMessageIdError(NotmuchError): pass
  89 class NullPointerError(NotmuchError): pass
  90 class TagTooLongError(NotmuchError): pass
  91 class UnbalancedFreezeThawError(NotmuchError): pass
  92 class UnbalancedAtomicError(NotmuchError): pass
  93 class UnsupportedOperationError(NotmuchError): pass
  94 class UpgradeRequiredError(NotmuchError): pass
  95 class PathError(NotmuchError): pass
  96 class IllegalArgumentError(NotmuchError): pass
  97
  98
  99 class ObjectDestroyedError(NotmuchError):
 100     """The object has already been destroyed and it's memory freed.
 101
 102     This occurs when :meth:`destroy` has been called on the object but
 103     you still happen to have access to the object.  This should not
 104     normally occur since you should never call :meth:`destroy` by
 105     hand.
 106     """
 107
 108     def __str__(self):
 109         if self.message:
 110             return self.message
 111         else:
 112             return 'Memory already freed'