python: move Messages class into its own file

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

diff --git a/bindings/python/notmuch/thread.py b/bindings/python/notmuch/thread.py
index 5058846d7ce89d4bbd0cbef5fb6bab06079e3047..c599bcbf647d4f625a10c71f0aeaa8b7ff2dc60b 100644 (file)
--- a/bindings/python/notmuch/thread.py
+++ b/bindings/python/notmuch/thread.py
@@ -18,15 +18,22 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
 """
 
 from ctypes import c_char_p, c_long, c_int
 """
 
 from ctypes import c_char_p, c_long, c_int

-from notmuch.globals import (nmlib, STATUS,
-    NotmuchError, NotmuchThreadP, NotmuchThreadsP, NotmuchMessagesP,
-    NotmuchTagsP,)
-from notmuch.message import Messages
+from notmuch.globals import (
+    nmlib,
+    Python3StringMixIn,
+    NullPointerError,
+    NotInitializedError,
+    NotmuchThreadP,
+    NotmuchThreadsP,
+    NotmuchMessagesP,
+    NotmuchTagsP,
+)
+from .messages import Messages

 from notmuch.tag import Tags
 from datetime import date
 
 
 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


@@ -35,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::
 


@@ -87,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


@@ -97,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:
-            raise 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


@@ -116,9 +123,9 @@ class Threads(object):
     _move_to_next.argtypes = [NotmuchThreadsP]
     _move_to_next.restype = None
 
     _move_to_next.argtypes = [NotmuchThreadsP]
     _move_to_next.restype = None
 

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

 
         if not self._valid(self._threads):
             self._threads = None
 
         if not self._valid(self._threads):
             self._threads = None


@@ -127,6 +134,7 @@ class Threads(object):
         thread = Thread(Threads._get(self._threads), self)
         self._move_to_next(self._threads)
         return thread
         thread = Thread(Threads._get(self._threads), self)
         self._move_to_next(self._threads)
         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


@@ -137,11 +145,11 @@ 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


@@ -219,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:
-            raise 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


@@ -240,12 +248,12 @@ 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 = nmlib.notmuch_thread_get_total_messages
     _get_total_messages.argtypes = [NotmuchThreadP]


@@ -257,11 +265,11 @@ 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)
+        if not self._thread:
+            raise NotInitializedError()

         return self._get_total_messages(self._thread)
 
     def get_toplevel_messages(self):
         return self._get_total_messages(self._thread)
 
     def get_toplevel_messages(self):


@@ -278,18 +286,16 @@ 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:
-            raise NotmuchError(STATUS.NULL_POINTER)
+        if not msgs_p:
+            raise NullPointerError()

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


@@ -303,11 +309,11 @@ class Thread(object):
         :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`.
         :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)
+        if not self._thread:
+            raise NotInitializedError()

         return self._get_matched_messages(self._thread)
 
     def get_authors(self):
         return self._get_matched_messages(self._thread)
 
     def get_authors(self):


@@ -320,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', errors='ignore')
+        return authors.decode('UTF-8', 'ignore')

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


@@ -333,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', errors='ignore')
+        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):


@@ -357,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):


@@ -377,23 +383,17 @@ 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):
-        return unicode(self).encode('utf-8')
-

     def __unicode__(self):
         frm = "thread:%s %12s [%d/%d] %s; %s (%s)"
 
     def __unicode__(self):
         frm = "thread:%s %12s [%d/%d] %s; %s (%s)"