2 This file is part of notmuch.
4 Notmuch is free software: you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation, either version 3 of the License, or (at your
7 option) any later version.
9 Notmuch is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with notmuch. If not, see <http://www.gnu.org/licenses/>.
17 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
20 from ctypes import CDLL, c_char_p, c_int
21 from ctypes.util import find_library
23 #-----------------------------------------------------------------------------
24 #package-global instance of the notmuch library
26 nmlib = CDLL("libnotmuch.so.1")
28 raise ImportError("Could not find shared 'notmuch' library.")
30 #-----------------------------------------------------------------------------
32 """Provides ENUMS as "code=Enum(['a','b','c'])" where code.a=0 etc..."""
33 def __init__(self, names):
34 for number, name in enumerate(names):
35 setattr(self, name, number)
37 #-----------------------------------------------------------------------------
39 """Enum with a string representation of a notmuch_status_t value."""
40 _status2str = nmlib.notmuch_status_to_string
41 _status2str.restype = c_char_p
42 _status2str.argtypes = [c_int]
44 def __init__(self, statuslist):
45 """It is initialized with a list of strings that are available as
46 Status().string1 - Status().stringn attributes.
48 super(Status, self).__init__(statuslist)
51 def status2str(self, status):
52 """Get a string representation of a notmuch_status_t value."""
53 # define strings for custom error messages
54 if status == STATUS.NOT_INITIALIZED:
55 return "Operation on uninitialized object impossible."
56 return str(Status._status2str(status))
58 STATUS = Status(['SUCCESS',
64 'DUPLICATE_MESSAGE_ID',
67 'UNBALANCED_FREEZE_THAW',
69 """STATUS is a class, whose attributes provide constants that serve as return indicators for notmuch functions. Currently the following ones are defined. For possible return values and specific meaning for each method, see the method description.
77 * DUPLICATE_MESSAGE_ID
80 * UNBALANCED_FREEZE_THAW
83 Invoke the class method `notmuch.STATUS.status2str` with a status value as argument to receive a human readable string"""
84 STATUS.__name__ = 'STATUS'
86 class NotmuchError(Exception):
87 def __init__(self, status=None, message=None):
88 """Is initiated with a (notmuch.STATUS[,message=None])"""
89 super(NotmuchError, self).__init__(message, status)
92 if self.args[0] is not None: return self.args[0]
93 else: return STATUS.status2str(self.args[1])