git.notmuchmail.org Git - notmuch/blob - bindings/python/notmuch/globals.py

   1 """
   2 This file is part of notmuch.
   3
   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.
   8
   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
  12 for more details.
  13
  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/>.
  16
  17 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
  18 """
  19
  20 from ctypes import CDLL, c_char_p, c_int
  21 from ctypes.util import find_library
  22
  23 #-----------------------------------------------------------------------------
  24 #package-global instance of the notmuch library
  25 try:
  26     nmlib = CDLL("libnotmuch.so.1")
  27 except:
  28     raise ImportError("Could not find shared 'notmuch' library.")
  29
  30 #-----------------------------------------------------------------------------
  31 class Enum(object):
  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)
  36
  37 #-----------------------------------------------------------------------------
  38 class Status(Enum):
  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]
  43
  44     def __init__(self, statuslist):
  45         """It is initialized with a list of strings that are available as
  46         Status().string1 - Status().stringn attributes.
  47         """
  48         super(Status, self).__init__(statuslist)
  49
  50     @classmethod
  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))
  57
  58 STATUS = Status(['SUCCESS',
  59   'OUT_OF_MEMORY',
  60   'READ_ONLY_DATABASE',
  61   'XAPIAN_EXCEPTION',
  62   'FILE_ERROR',
  63   'FILE_NOT_EMAIL',
  64   'DUPLICATE_MESSAGE_ID',
  65   'NULL_POINTER',
  66   'TAG_TOO_LONG',
  67   'UNBALANCED_FREEZE_THAW',
  68   'NOT_INITIALIZED'])
  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.
  70
  71   * SUCCESS
  72   * OUT_OF_MEMORY
  73   * READ_ONLY_DATABASE
  74   * XAPIAN_EXCEPTION
  75   * FILE_ERROR
  76   * FILE_NOT_EMAIL
  77   * DUPLICATE_MESSAGE_ID
  78   * NULL_POINTER
  79   * TAG_TOO_LONG
  80   * UNBALANCED_FREEZE_THAW
  81   * NOT_INITIALIZED
  82
  83   Invoke the class method `notmuch.STATUS.status2str` with a status value as argument to receive a human readable string"""
  84 STATUS.__name__ = 'STATUS'
  85
  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)
  90
  91     def __str__(self):
  92         if self.args[0] is not None: return self.args[0]
  93         else: return STATUS.status2str(self.args[1])
  94