X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Fglobals.py;h=54a49b2d3f16895a8a8ce0b9ffc459b58a7cadf2;hp=5fca3d9bd7fc1bc4c02e5b8ef2bc2d26dee04822;hb=4ed0362d41e62d5254be6cfb46e0c0c9fd9de0a0;hpb=b6a01735d238733ef78f941a8b7c4bad59db2734 diff --git a/bindings/python/notmuch/globals.py b/bindings/python/notmuch/globals.py index 5fca3d9b..54a49b2d 100644 --- a/bindings/python/notmuch/globals.py +++ b/bindings/python/notmuch/globals.py @@ -17,13 +17,12 @@ along with notmuch. If not, see . Copyright 2010 Sebastian Spaeth ' """ -from ctypes import CDLL, c_char_p, c_int -from ctypes.util import find_library +from ctypes import CDLL, c_char_p, c_int, Structure, POINTER #----------------------------------------------------------------------------- #package-global instance of the notmuch library try: - nmlib = CDLL("libnotmuch.so.1") + nmlib = CDLL("libnotmuch.so.2") except: raise ImportError("Could not find shared 'notmuch' library.") @@ -49,11 +48,11 @@ class Status(Enum): @classmethod def status2str(self, status): - """Get a string representation of a notmuch_status_t value.""" + """Get a (unicode) string representation of a notmuch_status_t value.""" # define strings for custom error messages if status == STATUS.NOT_INITIALIZED: - return "Operation on uninitialized object impossible." - return str(Status._status2str(status)) + return u"Operation on uninitialized object impossible." + return unicode(Status._status2str(status)) STATUS = Status(['SUCCESS', 'OUT_OF_MEMORY', @@ -89,6 +88,7 @@ Invoke the class method `notmuch.STATUS.status2str` with a status value as argument to receive a human readable string""" STATUS.__name__ = 'STATUS' + class NotmuchError(Exception): """Is initiated with a (notmuch.STATUS[, message=None]). It will not return an instance of the class NotmuchError, but a derived instance @@ -96,8 +96,9 @@ class NotmuchError(Exception): but SUCCESS has a corresponding subclassed Exception.""" @classmethod - def get_subclass_exc(cls, status, message=None): - """Returns a fine grained Exception() type,detailing the error status""" + def get_exc_subclass(cls, status): + """Returns a fine grained Exception() type, + detailing the error status""" subclasses = { STATUS.OUT_OF_MEMORY: OutOfMemoryError, STATUS.READ_ONLY_DATABASE: ReadOnlyDatabaseError, @@ -109,47 +110,89 @@ class NotmuchError(Exception): STATUS.TAG_TOO_LONG: TagTooLongError, STATUS.UNBALANCED_FREEZE_THAW: UnbalancedFreezeThawError, STATUS.UNBALANCED_ATOMIC: UnbalancedAtomicError, - STATUS.NOT_INITIALIZED: NotInitializedError + STATUS.NOT_INITIALIZED: NotInitializedError, } assert 0 < status <= len(subclasses) - return subclasses[status](status, message) - - def __init__(self, status, message=None): + return subclasses[status] + + def __new__(cls, *args, **kwargs): + """Return a correct subclass of NotmuchError if needed + + We return a NotmuchError instance if status is None (or 0) and a + subclass that inherits from NotmuchError depending on the + 'status' parameter otherwise.""" + # get 'status'. Passed in as arg or kwarg? + status = args[0] if len(args) else kwargs.get('status', None) + # no 'status' or cls is subclass already, return 'cls' instance + if not status or cls != NotmuchError: + return super(NotmuchError, cls).__new__(cls) + subclass = cls.get_exc_subclass(status) # which class to use? + return subclass.__new__(subclass, *args, **kwargs) + + def __init__(self, status=None, message=None): self.status = status self.message = message def __str__(self): + return unicode(self).encode('utf-8') + + def __unicode__(self): if self.message is not None: return self.message elif self.status is not None: return STATUS.status2str(self.status) else: - return 'Unknown error' + return u'Unknown error' + # List of Subclassed exceptions that correspond to STATUS values and are -# subclasses of NotmuchError: +# subclasses of NotmuchError. class OutOfMemoryError(NotmuchError): - pass + status = STATUS.OUT_OF_MEMORY + + class ReadOnlyDatabaseError(NotmuchError): - pass + status = STATUS.READ_ONLY_DATABASE + + class XapianError(NotmuchError): - pass + status = STATUS.XAPIAN_EXCEPTION + + class FileError(NotmuchError): - pass + status = STATUS.FILE_ERROR + + class FileNotEmailError(NotmuchError): - pass + status = STATUS.FILE_NOT_EMAIL + + class DuplicateMessageIdError(NotmuchError): - pass + status = STATUS.DUPLICATE_MESSAGE_ID + + class NullPointerError(NotmuchError): - pass + status = STATUS.NULL_POINTER + + class TagTooLongError(NotmuchError): - pass + status = STATUS.TAG_TOO_LONG + + class UnbalancedFreezeThawError(NotmuchError): - pass + status = STATUS.UNBALANCED_FREEZE_THAW + + class UnbalancedAtomicError(NotmuchError): - pass + status = STATUS.UNBALANCED_ATOMIC + + class NotInitializedError(NotmuchError): - pass + """Derived from NotmuchError, this occurs if the underlying data + structure (e.g. database is not initialized (yet) or an iterator has + been exhausted. You can test for NotmuchError with .status = + STATUS.NOT_INITIALIZED""" + status = STATUS.NOT_INITIALIZED def _str(value): @@ -163,3 +206,47 @@ def _str(value): return value.encode('UTF-8') return value + +class NotmuchDatabaseS(Structure): + pass +NotmuchDatabaseP = POINTER(NotmuchDatabaseS) + + +class NotmuchQueryS(Structure): + pass +NotmuchQueryP = POINTER(NotmuchQueryS) + + +class NotmuchThreadsS(Structure): + pass +NotmuchThreadsP = POINTER(NotmuchThreadsS) + + +class NotmuchThreadS(Structure): + pass +NotmuchThreadP = POINTER(NotmuchThreadS) + + +class NotmuchMessagesS(Structure): + pass +NotmuchMessagesP = POINTER(NotmuchMessagesS) + + +class NotmuchMessageS(Structure): + pass +NotmuchMessageP = POINTER(NotmuchMessageS) + + +class NotmuchTagsS(Structure): + pass +NotmuchTagsP = POINTER(NotmuchTagsS) + + +class NotmuchDirectoryS(Structure): + pass +NotmuchDirectoryP = POINTER(NotmuchDirectoryS) + + +class NotmuchFilenamesS(Structure): + pass +NotmuchFilenamesP = POINTER(NotmuchFilenamesS)