python: harmonize the sphinx keyword for exceptions

[notmuch] / bindings / python / notmuch / thread.py

diff --git a/bindings/python/notmuch/thread.py b/bindings/python/notmuch/thread.py
index 83b4202deb38d4e54371d31be8988e1f582d4625..d1ba3e55be4d771ccb83614264deb01425cfc4f6 100644 (file)
--- a/bindings/python/notmuch/thread.py
+++ b/bindings/python/notmuch/thread.py
@@ -17,14 +17,23 @@ along with notmuch.  If not, see <http://www.gnu.org/licenses/>.
 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
 """
 
 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
 """
 

-from ctypes import c_char_p, c_void_p, c_long
-from notmuch.globals import nmlib, STATUS, NotmuchError
+from ctypes import c_char_p, c_long, c_int
+from notmuch.globals import (
+    nmlib,
+    Python3StringMixIn,
+    NullPointerError,
+    NotInitializedError,
+    NotmuchThreadP,
+    NotmuchThreadsP,
+    NotmuchMessagesP,
+    NotmuchTagsP,
+)

 from notmuch.message import Messages
 from notmuch.tag import Tags
 from datetime import date
 
 
 from notmuch.message import Messages
 from notmuch.tag import Tags
 from datetime import date
 
 

-class Threads(object):
+class Threads(Python3StringMixIn):

     """Represents a list of notmuch threads
 
     This object provides an iterator over a list of notmuch threads
     """Represents a list of notmuch threads
 
     This object provides an iterator over a list of notmuch threads


@@ -33,7 +42,7 @@ class Threads(object):
     library only provides a one-time iterator (it cannot reset the
     iterator to the start). Thus iterating over the function will
     "exhaust" the list of threads, and a subsequent iteration attempt
     library only provides a one-time iterator (it cannot reset the
     iterator to the start). Thus iterating over the function will
     "exhaust" the list of threads, and a subsequent iteration attempt

-    will raise a :exc:`NotmuchError` STATUS.NOT_INITIALIZED. Also
+    will raise a :exc:`NotInitializedError`. Also

     note, that any function that uses iteration will also
     exhaust the messages. So both::
 
     note, that any function that uses iteration will also
     exhaust the messages. So both::
 


@@ -75,7 +84,8 @@ class Threads(object):
 
     #notmuch_threads_get
     _get = nmlib.notmuch_threads_get
 
     #notmuch_threads_get
     _get = nmlib.notmuch_threads_get

-    _get.restype = c_void_p
+    _get.argtypes = [NotmuchThreadsP]
+    _get.restype = NotmuchThreadP

 
     def __init__(self, threads_p, parent=None):
         """
 
     def __init__(self, threads_p, parent=None):
         """


@@ -84,8 +94,8 @@ class Threads(object):
              will almost never instantiate a :class:`Threads` object
              herself. They are usually handed back as a result,
              e.g. in :meth:`Query.search_threads`.  *threads_p* must be
              will almost never instantiate a :class:`Threads` object
              herself. They are usually handed back as a result,
              e.g. in :meth:`Query.search_threads`.  *threads_p* must be

-             valid, we will raise an :exc:`NotmuchError`
-             (STATUS.NULL_POINTER) if it is `None`.
+             valid, we will raise an :exc:`NullPointerError` if it is
+             `None`.

         :type threads_p: :class:`ctypes.c_void_p`
         :param parent: The parent object
              (ie :class:`Query`) these tags are derived from. It saves
         :type threads_p: :class:`ctypes.c_void_p`
         :param parent: The parent object
              (ie :class:`Query`) these tags are derived from. It saves


@@ -94,8 +104,8 @@ class Threads(object):
         :TODO: Make the iterator work more than once and cache the tags in
                the Python object.(?)
         """
         :TODO: Make the iterator work more than once and cache the tags in
                the Python object.(?)
         """

-        if threads_p is None:
-            NotmuchError(STATUS.NULL_POINTER)
+        if not threads_p:
+            raise NullPointerError()

 
         self._threads = threads_p
         #store parent, so we keep them alive as long as self  is alive
 
         self._threads = threads_p
         #store parent, so we keep them alive as long as self  is alive


@@ -105,17 +115,26 @@ class Threads(object):
         """ Make Threads an iterator """
         return self
 
         """ Make Threads an iterator """
         return self
 

-    def next(self):
-        if self._threads is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+    _valid = nmlib.notmuch_threads_valid
+    _valid.argtypes = [NotmuchThreadsP]
+    _valid.restype = bool

 
 

-        if not nmlib.notmuch_threads_valid(self._threads):
+    _move_to_next = nmlib.notmuch_threads_move_to_next
+    _move_to_next.argtypes = [NotmuchThreadsP]
+    _move_to_next.restype = None
+
+    def __next__(self):
+        if not self._threads:
+            raise NotInitializedError()
+
+        if not self._valid(self._threads):

             self._threads = None
             raise StopIteration
 
         thread = Thread(Threads._get(self._threads), self)
             self._threads = None
             raise StopIteration
 
         thread = Thread(Threads._get(self._threads), self)

-        nmlib.notmuch_threads_move_to_next(self._threads)
+        self._move_to_next(self._threads)

         return thread
         return thread

+    next = __next__ # python2.x iterator protocol compatibility

 
     def __len__(self):
         """len(:class:`Threads`) returns the number of contained Threads
 
     def __len__(self):
         """len(:class:`Threads`) returns the number of contained Threads


@@ -126,16 +145,16 @@ class Threads(object):
                  #THIS FAILS
                  threads = Database().create_query('').search_threads()
                  if len(threads) > 0:              #this 'exhausts' threads
                  #THIS FAILS
                  threads = Database().create_query('').search_threads()
                  if len(threads) > 0:              #this 'exhausts' threads

-                     # next line raises NotmuchError(STATUS.NOT_INITIALIZED)!!!
+                     # next line raises :exc:`NotInitializedError`!!!

                      for thread in threads: print thread
         """
                      for thread in threads: print thread
         """

-        if self._threads is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._threads:
+            raise NotInitializedError()

 
         i = 0
         # returns 'bool'. On out-of-memory it returns None
 
         i = 0
         # returns 'bool'. On out-of-memory it returns None

-        while nmlib.notmuch_threads_valid(self._threads):
-            nmlib.notmuch_threads_move_to_next(self._threads)
+        while self._valid(self._threads):
+            self._move_to_next(self._threads)

             i += 1
         # reset self._threads to mark as "exhausted"
         self._threads = None
             i += 1
         # reset self._threads to mark as "exhausted"
         self._threads = None


@@ -153,12 +172,16 @@ class Threads(object):
            Iterator, False if not. None on a "Out-of-memory" error.
         """
         return self._threads is not None and \
            Iterator, False if not. None on a "Out-of-memory" error.
         """
         return self._threads is not None and \

-            nmlib.notmuch_threads_valid(self._threads) > 0
+            self._valid(self._threads) > 0
+
+    _destroy = nmlib.notmuch_threads_destroy
+    _destroy.argtypes = [NotmuchThreadsP]
+    _destroy.argtypes = None

 
     def __del__(self):
         """Close and free the notmuch Threads"""
         if self._threads is not None:
 
     def __del__(self):
         """Close and free the notmuch Threads"""
         if self._threads is not None:

-            nmlib.notmuch_messages_destroy(self._threads)
+            self._destroy(self._threads)

 
 
 class Thread(object):
 
 
 class Thread(object):


@@ -166,29 +189,36 @@ class Thread(object):
 
     """notmuch_thread_get_thread_id"""
     _get_thread_id = nmlib.notmuch_thread_get_thread_id
 
     """notmuch_thread_get_thread_id"""
     _get_thread_id = nmlib.notmuch_thread_get_thread_id

+    _get_thread_id.argtypes = [NotmuchThreadP]

     _get_thread_id.restype = c_char_p
 
     """notmuch_thread_get_authors"""
     _get_authors = nmlib.notmuch_thread_get_authors
     _get_thread_id.restype = c_char_p
 
     """notmuch_thread_get_authors"""
     _get_authors = nmlib.notmuch_thread_get_authors

+    _get_authors.argtypes = [NotmuchThreadP]

     _get_authors.restype = c_char_p
 
     """notmuch_thread_get_subject"""
     _get_subject = nmlib.notmuch_thread_get_subject
     _get_authors.restype = c_char_p
 
     """notmuch_thread_get_subject"""
     _get_subject = nmlib.notmuch_thread_get_subject

+    _get_subject.argtypes = [NotmuchThreadP]

     _get_subject.restype = c_char_p
 
     """notmuch_thread_get_toplevel_messages"""
     _get_toplevel_messages = nmlib.notmuch_thread_get_toplevel_messages
     _get_subject.restype = c_char_p
 
     """notmuch_thread_get_toplevel_messages"""
     _get_toplevel_messages = nmlib.notmuch_thread_get_toplevel_messages

-    _get_toplevel_messages.restype = c_void_p
+    _get_toplevel_messages.argtypes = [NotmuchThreadP]
+    _get_toplevel_messages.restype = NotmuchMessagesP

 
     _get_newest_date = nmlib.notmuch_thread_get_newest_date
 
     _get_newest_date = nmlib.notmuch_thread_get_newest_date

+    _get_newest_date.argtypes = [NotmuchThreadP]

     _get_newest_date.restype = c_long
 
     _get_oldest_date = nmlib.notmuch_thread_get_oldest_date
     _get_newest_date.restype = c_long
 
     _get_oldest_date = nmlib.notmuch_thread_get_oldest_date

+    _get_oldest_date.argtypes = [NotmuchThreadP]

     _get_oldest_date.restype = c_long
 
     """notmuch_thread_get_tags"""
     _get_tags = nmlib.notmuch_thread_get_tags
     _get_oldest_date.restype = c_long
 
     """notmuch_thread_get_tags"""
     _get_tags = nmlib.notmuch_thread_get_tags

-    _get_tags.restype = c_void_p
+    _get_tags.argtypes = [NotmuchThreadP]
+    _get_tags.restype = NotmuchTagsP

 
     def __init__(self, thread_p, parent=None):
         """
 
     def __init__(self, thread_p, parent=None):
         """


@@ -197,16 +227,16 @@ class Thread(object):
             will almost never instantiate a :class:`Thread` object
             herself. They are usually handed back as a result,
             e.g. when iterating through :class:`Threads`. *thread_p*
             will almost never instantiate a :class:`Thread` object
             herself. They are usually handed back as a result,
             e.g. when iterating through :class:`Threads`. *thread_p*

-            must be valid, we will raise an :exc:`NotmuchError`
-            (STATUS.NULL_POINTER) if it is `None`.
+            must be valid, we will raise an :exc:`NullPointerError`
+            if it is `None`.

 
         :param parent: A 'parent' object is passed which this message is
               derived from. We save a reference to it, so we can
               automatically delete the parent object once all derived
               objects are dead.
         """
 
         :param parent: A 'parent' object is passed which this message is
               derived from. We save a reference to it, so we can
               automatically delete the parent object once all derived
               objects are dead.
         """

-        if thread_p is None:
-            NotmuchError(STATUS.NULL_POINTER)
+        if not thread_p:
+            raise NullPointerError()

         self._thread = thread_p
         #keep reference to parent, so we keep it alive
         self._parent = parent
         self._thread = thread_p
         #keep reference to parent, so we keep it alive
         self._parent = parent


@@ -218,12 +248,16 @@ class Thread(object):
         for as long as the thread is valid.
 
         :returns: String with a message ID
         for as long as the thread is valid.
 
         :returns: String with a message ID

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
+        :raises: :exc:`NotInitializedError` if the thread

                     is not initialized.
         """
                     is not initialized.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-        return Thread._get_thread_id(self._thread)
+        if not self._thread:
+            raise NotInitializedError()
+        return Thread._get_thread_id(self._thread).decode('utf-8', 'ignore')
+
+    _get_total_messages = nmlib.notmuch_thread_get_total_messages
+    _get_total_messages.argtypes = [NotmuchThreadP]
+    _get_total_messages.restype = c_int

 
     def get_total_messages(self):
         """Get the total number of messages in 'thread'
 
     def get_total_messages(self):
         """Get the total number of messages in 'thread'


@@ -231,12 +265,12 @@ class Thread(object):
         :returns: The number of all messages in the database
                   belonging to this thread. Contrast with
                   :meth:`get_matched_messages`.
         :returns: The number of all messages in the database
                   belonging to this thread. Contrast with
                   :meth:`get_matched_messages`.

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
+        :raises: :exc:`NotInitializedError` if the thread

                     is not initialized.
         """
                     is not initialized.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-        return nmlib.notmuch_thread_get_total_messages(self._thread)
+        if not self._thread:
+            raise NotInitializedError()
+        return self._get_total_messages(self._thread)

 
     def get_toplevel_messages(self):
         """Returns a :class:`Messages` iterator for the top-level messages in
 
     def get_toplevel_messages(self):
         """Returns a :class:`Messages` iterator for the top-level messages in


@@ -252,33 +286,35 @@ class Thread(object):
            messages, etc.).
 
         :returns: :class:`Messages`
            messages, etc.).
 
         :returns: :class:`Messages`

-        :exception: :exc:`NotmuchError`
-
-                      * STATUS.NOT_INITIALIZED if query is not inited
-                      * STATUS.NULL_POINTER if search_messages failed
+        :raises: :exc:`NotInitializedError` if query is not initialized
+        :raises: :exc:`NullPointerError` if search_messages failed

         """
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

 
         msgs_p = Thread._get_toplevel_messages(self._thread)
 
 
         msgs_p = Thread._get_toplevel_messages(self._thread)
 

-        if msgs_p is None:
-            NotmuchError(STATUS.NULL_POINTER)
+        if not msgs_p:
+            raise NullPointerError()

 
         return Messages(msgs_p, self)
 
 
         return Messages(msgs_p, self)
 

+    _get_matched_messages = nmlib.notmuch_thread_get_matched_messages
+    _get_matched_messages.argtypes = [NotmuchThreadP]
+    _get_matched_messages.restype = c_int
+

     def get_matched_messages(self):
         """Returns the number of messages in 'thread' that matched the query
 
         :returns: The number of all messages belonging to this thread that
                   matched the :class:`Query`from which this thread was created.
                   Contrast with :meth:`get_total_messages`.
     def get_matched_messages(self):
         """Returns the number of messages in 'thread' that matched the query
 
         :returns: The number of all messages belonging to this thread that
                   matched the :class:`Query`from which this thread was created.
                   Contrast with :meth:`get_total_messages`.

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the thread
+        :raises: :exc:`NotInitializedError` if the thread

                     is not initialized.
         """
                     is not initialized.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-        return nmlib.notmuch_thread_get_matched_messages(self._thread)
+        if not self._thread:
+            raise NotInitializedError()
+        return self._get_matched_messages(self._thread)

 
     def get_authors(self):
         """Returns the authors of 'thread'
 
     def get_authors(self):
         """Returns the authors of 'thread'


@@ -290,12 +326,12 @@ class Thread(object):
         The returned string belongs to 'thread' and will only be valid for
         as long as this Thread() is not deleted.
         """
         The returned string belongs to 'thread' and will only be valid for
         as long as this Thread() is not deleted.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

         authors = Thread._get_authors(self._thread)
         authors = Thread._get_authors(self._thread)

-        if authors is None:
+        if not authors:

             return None
             return None

-        return authors.decode('UTF-8')
+        return authors.decode('UTF-8', 'ignore')

 
     def get_subject(self):
         """Returns the Subject of 'thread'
 
     def get_subject(self):
         """Returns the Subject of 'thread'


@@ -303,23 +339,23 @@ class Thread(object):
         The returned string belongs to 'thread' and will only be valid for
         as long as this Thread() is not deleted.
         """
         The returned string belongs to 'thread' and will only be valid for
         as long as this Thread() is not deleted.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

         subject = Thread._get_subject(self._thread)
         subject = Thread._get_subject(self._thread)

-        if subject is None:
+        if not subject:

             return None
             return None

-        return subject.decode('UTF-8')
+        return subject.decode('UTF-8', 'ignore')

 
     def get_newest_date(self):
         """Returns time_t of the newest message date
 
         :returns: A time_t timestamp.
         :rtype: c_unit64
 
     def get_newest_date(self):
         """Returns time_t of the newest message date
 
         :returns: A time_t timestamp.
         :rtype: c_unit64

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
+        :raises: :exc:`NotInitializedError` if the message

                     is not initialized.
         """
                     is not initialized.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

         return Thread._get_newest_date(self._thread)
 
     def get_oldest_date(self):
         return Thread._get_newest_date(self._thread)
 
     def get_oldest_date(self):


@@ -327,11 +363,11 @@ class Thread(object):
 
         :returns: A time_t timestamp.
         :rtype: c_unit64
 
         :returns: A time_t timestamp.
         :rtype: c_unit64

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message
+        :raises: :exc:`NotInitializedError` if the message

                     is not initialized.
         """
                     is not initialized.
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

         return Thread._get_oldest_date(self._thread)
 
     def get_tags(self):
         return Thread._get_oldest_date(self._thread)
 
     def get_tags(self):


@@ -347,47 +383,34 @@ class Thread(object):
         query from which it derived is explicitely deleted).
 
         :returns: A :class:`Tags` iterator.
         query from which it derived is explicitely deleted).
 
         :returns: A :class:`Tags` iterator.

-        :exception: :exc:`NotmuchError`
-
-                      * STATUS.NOT_INITIALIZED if the thread
-                        is not initialized.
-                      * STATUS.NULL_POINTER, on error
+        :raises: :exc:`NotInitializedError` if query is not initialized
+        :raises: :exc:`NullPointerError` if search_messages failed

         """
         """

-        if self._thread is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        if not self._thread:
+            raise NotInitializedError()

 
         tags_p = Thread._get_tags(self._thread)
         if tags_p == None:
 
         tags_p = Thread._get_tags(self._thread)
         if tags_p == None:

-            raise NotmuchError(STATUS.NULL_POINTER)
+            raise NullPointerError()

         return Tags(tags_p, self)
 
         return Tags(tags_p, self)
 

-    def __str__(self):
-        """A str(Thread()) is represented by a 1-line summary"""
-        thread = {}
-        thread['id'] = self.get_thread_id()
-
-        ###TODO: How do we find out the current sort order of Threads?
-        ###Add a "sort" attribute to the Threads() object?
-        #if (sort == NOTMUCH_SORT_OLDEST_FIRST)
-        #         date = notmuch_thread_get_oldest_date (thread);
-        #else
-        #         date = notmuch_thread_get_newest_date (thread);
-        thread['date'] = date.fromtimestamp(self.get_newest_date())
-        thread['matched'] = self.get_matched_messages()
-        thread['total'] = self.get_total_messages()
-        thread['authors'] = self.get_authors()
-        thread['subject'] = self.get_subject()
-        thread['tags'] = self.get_tags()
-
-        return "thread:%s %12s [%d/%d] %s; %s (%s)" % (thread['id'],
-                                                       thread['date'],
-                                                       thread['matched'],
-                                                       thread['total'],
-                                                       thread['authors'],
-                                                       thread['subject'],
-                                                       thread['tags'])
+    def __unicode__(self):
+        frm = "thread:%s %12s [%d/%d] %s; %s (%s)"
+
+        return frm % (self.get_thread_id(),
+                      date.fromtimestamp(self.get_newest_date()),
+                      self.get_matched_messages(),
+                      self.get_total_messages(),
+                      self.get_authors(),
+                      self.get_subject(),
+                      self.get_tags(),
+                     )
+
+    _destroy = nmlib.notmuch_thread_destroy
+    _destroy.argtypes = [NotmuchThreadP]
+    _destroy.restype = None

 
     def __del__(self):
         """Close and free the notmuch Thread"""
         if self._thread is not None:
 
     def __del__(self):
         """Close and free the notmuch Thread"""
         if self._thread is not None:

-            nmlib.notmuch_thread_destroy(self._thread)
+            self._destroy(self._thread)