python: annotate all calls into libnotmuch with types

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

diff --git a/bindings/python/notmuch/message.py b/bindings/python/notmuch/message.py
index 763d2c6827b6f6e3243c98a9af4ca25ee9aaf254..e0c7eda2b46d492cd37cc6a8712c6db6e5a88a03 100644 (file)
--- a/bindings/python/notmuch/message.py
+++ b/bindings/python/notmuch/message.py
@@ -18,10 +18,11 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
                Jesse Rosenthal <jrosenthal@jhu.edu>
 """
 
                Jesse Rosenthal <jrosenthal@jhu.edu>
 """
 

-        
+

 from ctypes import c_char_p, c_void_p, c_long, c_uint, c_int
 from datetime import date
 from ctypes import c_char_p, c_void_p, c_long, c_uint, c_int
 from datetime import date

-from notmuch.globals import nmlib, STATUS, NotmuchError, Enum
+from notmuch.globals import (nmlib, STATUS, NotmuchError, Enum, _str,
+    NotmuchTagsP, NotmuchMessagesP, NotmuchMessageP, NotmuchFilenamesP)

 from notmuch.tag import Tags
 from notmuch.filename import Filenames
 import sys
 from notmuch.tag import Tags
 from notmuch.filename import Filenames
 import sys


@@ -31,7 +32,8 @@ try:
     import simplejson as json
 except ImportError:
     import json
     import simplejson as json
 except ImportError:
     import json

-#------------------------------------------------------------------------------
+
+

 class Messages(object):
     """Represents a list of notmuch messages
 
 class Messages(object):
     """Represents a list of notmuch messages
 


@@ -63,8 +65,8 @@ class Messages(object):
       # However it will be kept alive until all retrieved Message()
       # objects are also deleted. If you do e.g. an explicit del(msgs)
       # here, the following lines would fail.
       # However it will be kept alive until all retrieved Message()
       # objects are also deleted. If you do e.g. an explicit del(msgs)
       # here, the following lines would fail.

-      
-      # You can reiterate over *msglist* however as often as you want. 
+
+      # You can reiterate over *msglist* however as often as you want.

       # It is simply a list with :class:`Message`s.
 
       print (msglist[0].get_filename())
       # It is simply a list with :class:`Message`s.
 
       print (msglist[0].get_filename())


@@ -91,10 +93,12 @@ class Messages(object):
 
     #notmuch_messages_get
     _get = nmlib.notmuch_messages_get
 
     #notmuch_messages_get
     _get = nmlib.notmuch_messages_get

-    _get.restype = c_void_p
+    _get.argtypes = [NotmuchMessagesP]
+    _get.restype = NotmuchMessageP

 
     _collect_tags = nmlib.notmuch_messages_collect_tags
 
     _collect_tags = nmlib.notmuch_messages_collect_tags

-    _collect_tags.restype = c_void_p
+    _collect_tags.argtypes = [NotmuchMessagesP]
+    _collect_tags.restype = NotmuchTagsP

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


@@ -110,11 +114,11 @@ class Messages(object):
              (ie :class:`Query`) these tags are derived from. It saves
              a reference to it, so we can automatically delete the db
              object once all derived objects are dead.
              (ie :class:`Query`) these tags are derived from. It saves
              a reference to it, so we can automatically delete the db
              object once all derived objects are dead.

-        :TODO: Make the iterator work more than once and cache the tags in 
+        :TODO: Make the iterator work more than once and cache the tags in

                the Python object.(?)
         """
         if msgs_p is None:
                the Python object.(?)
         """
         if msgs_p is None:

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

 
         self._msgs = msgs_p
         #store parent, so we keep them alive as long as self  is alive
 
         self._msgs = msgs_p
         #store parent, so we keep them alive as long as self  is alive


@@ -133,7 +137,7 @@ class Messages(object):
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         # collect all tags (returns NULL on error)
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         # collect all tags (returns NULL on error)

-        tags_p = Messages._collect_tags (self._msgs)
+        tags_p = Messages._collect_tags(self._msgs)

         #reset _msgs as we iterated over it and can do so only once
         self._msgs = None
 
         #reset _msgs as we iterated over it and can do so only once
         self._msgs = None
 


@@ -145,16 +149,24 @@ class Messages(object):
         """ Make Messages an iterator """
         return self
 
         """ Make Messages an iterator """
         return self
 

+    _valid = nmlib.notmuch_messages_valid
+    _valid.argtypes = [NotmuchMessagesP]
+    _valid.restype = bool
+
+    _move_to_next = nmlib.notmuch_messages_move_to_next
+    _move_to_next.argtypes = [NotmuchMessagesP]
+    _move_to_next.restype = None
+

     def next(self):
         if self._msgs is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
     def next(self):
         if self._msgs is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        if not nmlib.notmuch_messages_valid(self._msgs):
+        if not self._valid(self._msgs):

             self._msgs = None
             raise StopIteration
 
             self._msgs = None
             raise StopIteration
 

-        msg = Message(Messages._get (self._msgs), self)
-        nmlib.notmuch_messages_move_to_next(self._msgs)
+        msg = Message(Messages._get(self._msgs), self)
+        self._move_to_next(self._msgs)

         return msg
 
     def __nonzero__(self):
         return msg
 
     def __nonzero__(self):


@@ -162,19 +174,23 @@ class Messages(object):
         :return: True if there is at least one more thread in the
             Iterator, False if not."""
         return self._msgs is not None and \
         :return: True if there is at least one more thread in the
             Iterator, False if not."""
         return self._msgs is not None and \

-            nmlib.notmuch_messages_valid(self._msgs) > 0
+            self._valid(self._msgs) > 0
+
+    _destroy = nmlib.notmuch_messages_destroy
+    _destroy.argtypes = [NotmuchMessagesP]
+    _destroy.restype = None

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

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

 
     def print_messages(self, format, indent=0, entire_thread=False):
         """Outputs messages as needed for 'notmuch show' to sys.stdout
 
         :param format: A string of either 'text' or 'json'.
         :param indent: A number indicating the reply depth of these messages.
 
     def print_messages(self, format, indent=0, entire_thread=False):
         """Outputs messages as needed for 'notmuch show' to sys.stdout
 
         :param format: A string of either 'text' or 'json'.
         :param indent: A number indicating the reply depth of these messages.

-        :param entire_thread: A bool, indicating whether we want to output 
+        :param entire_thread: A bool, indicating whether we want to output

                        whole threads or only the matching messages.
         """
         if format.lower() == "text":
                        whole threads or only the matching messages.
         """
         if format.lower() == "text":


@@ -186,7 +202,7 @@ class Messages(object):
             set_end = "]"
             set_sep = ", "
         else:
             set_end = "]"
             set_sep = ", "
         else:

-            raise Exception
+            raise TypeError("format must be either 'text' or 'json'")

 
         first_set = True
 
 
         first_set = True
 


@@ -195,7 +211,7 @@ class Messages(object):
         # iterate through all toplevel messages in this thread
         for msg in self:
             # if not msg:
         # iterate through all toplevel messages in this thread
         for msg in self:
             # if not msg:

-            #     break 
+            #     break

             if not first_set:
                 sys.stdout.write(set_sep)
             first_set = False
             if not first_set:
                 sys.stdout.write(set_sep)
             first_set = False


@@ -207,10 +223,8 @@ class Messages(object):
             if (match or entire_thread):
                 if format.lower() == "text":
                     sys.stdout.write(msg.format_message_as_text(indent))
             if (match or entire_thread):
                 if format.lower() == "text":
                     sys.stdout.write(msg.format_message_as_text(indent))

-                elif format.lower() == "json":
-                    sys.stdout.write(msg.format_message_as_json(indent))

                 else:
                 else:

-                    raise NotmuchError
+                    sys.stdout.write(msg.format_message_as_json(indent))

                 next_indent = indent + 1
 
             # get replies and print them also out (if there are any)
                 next_indent = indent + 1
 
             # get replies and print them also out (if there are any)


@@ -222,7 +236,7 @@ class Messages(object):
             sys.stdout.write(set_end)
         sys.stdout.write(set_end)
 
             sys.stdout.write(set_end)
         sys.stdout.write(set_end)
 

-#------------------------------------------------------------------------------
+

 class Message(object):
     """Represents a single Email message
 
 class Message(object):
     """Represents a single Email message
 


@@ -236,44 +250,60 @@ class Message(object):
 
     """notmuch_message_get_filename (notmuch_message_t *message)"""
     _get_filename = nmlib.notmuch_message_get_filename
 
     """notmuch_message_get_filename (notmuch_message_t *message)"""
     _get_filename = nmlib.notmuch_message_get_filename

-    _get_filename.restype = c_char_p 
+    _get_filename.argtypes = [NotmuchMessageP]
+    _get_filename.restype = c_char_p

 
     """return all filenames for a message"""
     _get_filenames = nmlib.notmuch_message_get_filenames
 
     """return all filenames for a message"""
     _get_filenames = nmlib.notmuch_message_get_filenames

-    _get_filenames.restype = c_void_p
+    _get_filenames.argtypes = [NotmuchMessageP]
+    _get_filenames.restype = NotmuchFilenamesP

 
     """notmuch_message_get_flag"""
     _get_flag = nmlib.notmuch_message_get_flag
 
     """notmuch_message_get_flag"""
     _get_flag = nmlib.notmuch_message_get_flag

-    _get_flag.restype = c_uint
+    _get_flag.argtypes = [NotmuchMessageP, c_uint]
+    _get_flag.restype = bool
+
+    """notmuch_message_set_flag"""
+    _set_flag = nmlib.notmuch_message_set_flag
+    _set_flag.argtypes = [NotmuchMessageP, c_uint, c_int]
+    _set_flag.restype = None

 
     """notmuch_message_get_message_id (notmuch_message_t *message)"""
     _get_message_id = nmlib.notmuch_message_get_message_id
 
     """notmuch_message_get_message_id (notmuch_message_t *message)"""
     _get_message_id = nmlib.notmuch_message_get_message_id

-    _get_message_id.restype = c_char_p 
+    _get_message_id.argtypes = [NotmuchMessageP]
+    _get_message_id.restype = c_char_p

 
     """notmuch_message_get_thread_id"""
     _get_thread_id = nmlib.notmuch_message_get_thread_id
 
     """notmuch_message_get_thread_id"""
     _get_thread_id = nmlib.notmuch_message_get_thread_id

+    _get_thread_id.argtypes = [NotmuchMessageP]

     _get_thread_id.restype = c_char_p
 
     """notmuch_message_get_replies"""
     _get_replies = nmlib.notmuch_message_get_replies
     _get_thread_id.restype = c_char_p
 
     """notmuch_message_get_replies"""
     _get_replies = nmlib.notmuch_message_get_replies

-    _get_replies.restype = c_void_p
+    _get_replies.argtypes = [NotmuchMessageP]
+    _get_replies.restype = NotmuchMessagesP

 
     """notmuch_message_get_tags (notmuch_message_t *message)"""
     _get_tags = nmlib.notmuch_message_get_tags
 
     """notmuch_message_get_tags (notmuch_message_t *message)"""
     _get_tags = nmlib.notmuch_message_get_tags

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

 
     _get_date = nmlib.notmuch_message_get_date
 
     _get_date = nmlib.notmuch_message_get_date

+    _get_date.argtypes = [NotmuchMessageP]

     _get_date.restype = c_long
 
     _get_header = nmlib.notmuch_message_get_header
     _get_date.restype = c_long
 
     _get_header = nmlib.notmuch_message_get_header

+    _get_header.argtypes = [NotmuchMessageP, c_char_p]

     _get_header.restype = c_char_p
 
     """notmuch_status_t ..._maildir_flags_to_tags (notmuch_message_t *)"""
     _tags_to_maildir_flags = nmlib.notmuch_message_tags_to_maildir_flags
     _get_header.restype = c_char_p
 
     """notmuch_status_t ..._maildir_flags_to_tags (notmuch_message_t *)"""
     _tags_to_maildir_flags = nmlib.notmuch_message_tags_to_maildir_flags

+    _tags_to_maildir_flags.argtypes = [NotmuchMessageP]

     _tags_to_maildir_flags.restype = c_int
 
     """notmuch_status_t ..._tags_to_maildir_flags (notmuch_message_t *)"""
     _maildir_flags_to_tags = nmlib.notmuch_message_maildir_flags_to_tags
     _tags_to_maildir_flags.restype = c_int
 
     """notmuch_status_t ..._tags_to_maildir_flags (notmuch_message_t *)"""
     _maildir_flags_to_tags = nmlib.notmuch_message_maildir_flags_to_tags

+    _maildir_flags_to_tags.argtypes = [NotmuchMessageP]

     _maildir_flags_to_tags.restype = c_int
 
     #Constants: Flags that can be set/get with set_flag
     _maildir_flags_to_tags.restype = c_int
 
     #Constants: Flags that can be set/get with set_flag


@@ -291,17 +321,16 @@ class Message(object):
               objects are dead.
         """
         if msg_p is None:
               objects are dead.
         """
         if msg_p is None:

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

         self._msg = msg_p
         #keep reference to parent, so we keep it alive
         self._parent = parent
 
         self._msg = msg_p
         #keep reference to parent, so we keep it alive
         self._parent = parent
 

-

     def get_message_id(self):
         """Returns the message ID
     def get_message_id(self):
         """Returns the message ID

-        
+

         :returns: String with a message ID
         :returns: String with a message ID

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

                     is not initialized.
         """
         if self._msg is None:
                     is not initialized.
         """
         if self._msg is None:


@@ -311,23 +340,24 @@ class Message(object):
     def get_thread_id(self):
         """Returns the thread ID
 
     def get_thread_id(self):
         """Returns the thread ID
 

-        The returned string belongs to 'message' will only be valid for as 
+        The returned string belongs to 'message' will only be valid for as

         long as the message is valid.
 
         This function will not return `None` since Notmuch ensures that every
         message belongs to a single thread.
 
         :returns: String with a thread ID
         long as the message is valid.
 
         This function will not return `None` since Notmuch ensures that every
         message belongs to a single thread.
 
         :returns: String with a thread ID

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

                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        return Message._get_thread_id (self._msg);
+        return Message._get_thread_id(self._msg)

 
     def get_replies(self):
 
     def get_replies(self):

-        """Gets all direct replies to this message as :class:`Messages` iterator
+        """Gets all direct replies to this message as :class:`Messages`
+        iterator

 
         .. note:: This call only makes sense if 'message' was
           ultimately obtained from a :class:`Thread` object, (such as
 
         .. note:: This call only makes sense if 'message' was
           ultimately obtained from a :class:`Thread` object, (such as


@@ -338,20 +368,20 @@ class Message(object):
           to :meth:`Query.search_messages`), then this function will
           return `None`.
 
           to :meth:`Query.search_messages`), then this function will
           return `None`.
 

-        :returns: :class:`Messages` or `None` if there are no replies to 
+        :returns: :class:`Messages` or `None` if there are no replies to

             this message.
             this message.

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

                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
                     is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        msgs_p = Message._get_replies(self._msg);
+        msgs_p = Message._get_replies(self._msg)

 
         if msgs_p is None:
             return None
 
 
         if msgs_p is None:
             return None
 

-        return Messages(msgs_p,self)
+        return Messages(msgs_p, self)

 
     def get_date(self):
         """Returns time_t of the message date
 
     def get_date(self):
         """Returns time_t of the message date


@@ -362,7 +392,7 @@ class Message(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 
+        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if the message

                     is not initialized.
         """
         if self._msg is None:
                     is not initialized.
         """
         if self._msg is None:


@@ -370,37 +400,38 @@ class Message(object):
         return Message._get_date(self._msg)
 
     def get_header(self, header):
         return Message._get_date(self._msg)
 
     def get_header(self, header):

-        """Returns a message header
-        
-        This returns any message header that is stored in the notmuch database.
-        This is only a selected subset of headers, which is currently:
+        """Get the value of the specified header.
+
+        The value will be read from the actual message file, not from
+        the notmuch database. The header name is case insensitive.

 
 

-          TODO: add stored headers
+        Returns an empty string ("") if the message does not contain a
+        header line matching 'header'.

 
         :param header: The name of the header to be retrieved.
 
         :param header: The name of the header to be retrieved.

-                       It is not case-sensitive (TODO: confirm).
+                       It is not case-sensitive.

         :type header: str
         :returns: The header value as string
         :exception: :exc:`NotmuchError`
 
         :type header: str
         :returns: The header value as string
         :exception: :exc:`NotmuchError`
 

-                    * STATUS.NOT_INITIALIZED if the message 
+                    * STATUS.NOT_INITIALIZED if the message

                       is not initialized.
                       is not initialized.

-                    * STATUS.NULL_POINTER, if no header was found
+                    * STATUS.NULL_POINTER if any error occured.

         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         #Returns NULL if any error occurs.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         #Returns NULL if any error occurs.

-        header = Message._get_header (self._msg, header)
+        header = Message._get_header(self._msg, header)

         if header == None:
             raise NotmuchError(STATUS.NULL_POINTER)
         if header == None:
             raise NotmuchError(STATUS.NULL_POINTER)

-        return header
+        return header.decode('UTF-8')

 
     def get_filename(self):
         """Returns the file path of the message file
 
         :returns: Absolute file path & name of the message file
 
     def get_filename(self):
         """Returns the file path of the message file
 
         :returns: Absolute file path & name of the message file

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

               is not initialized.
         """
         if self._msg is None:
               is not initialized.
         """
         if self._msg is None:


@@ -415,7 +446,7 @@ class Message(object):
         not necessarily have identical content."""
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         not necessarily have identical content."""
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

-        
+

         files_p = Message._get_filenames(self._msg)
 
         return Filenames(files_p, self).as_generator()
         files_p = Message._get_filenames(self._msg)
 
         return Filenames(files_p, self).as_generator()


@@ -427,10 +458,10 @@ class Message(object):
         *Message.FLAG.MATCH* for those messages that match the
         query. This method allows us to get the value of this flag.
 
         *Message.FLAG.MATCH* for those messages that match the
         query. This method allows us to get the value of this flag.
 

-        :param flag: One of the :attr:`Message.FLAG` values (currently only 
+        :param flag: One of the :attr:`Message.FLAG` values (currently only

                      *Message.FLAG.MATCH*
         :returns: An unsigned int (0/1), indicating whether the flag is set.
                      *Message.FLAG.MATCH*
         :returns: An unsigned int (0/1), indicating whether the flag is set.

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

               is not initialized.
         """
         if self._msg is None:
               is not initialized.
         """
         if self._msg is None:


@@ -440,17 +471,17 @@ class Message(object):
     def set_flag(self, flag, value):
         """Sets/Unsets a specific flag for this message
 
     def set_flag(self, flag, value):
         """Sets/Unsets a specific flag for this message
 

-        :param flag: One of the :attr:`Message.FLAG` values (currently only 
+        :param flag: One of the :attr:`Message.FLAG` values (currently only

                      *Message.FLAG.MATCH*
         :param value: A bool indicating whether to set or unset the flag.
 
         :returns: Nothing
                      *Message.FLAG.MATCH*
         :param value: A bool indicating whether to set or unset the flag.
 
         :returns: Nothing

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

               is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
               is not initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

-        nmlib.notmuch_message_set_flag(self._msg, flag, value)
+        self._set_flag(self._msg, flag, value)

 
     def get_tags(self):
         """Returns the message tags
 
     def get_tags(self):
         """Returns the message tags


@@ -458,7 +489,7 @@ class Message(object):
         :returns: A :class:`Tags` iterator.
         :exception: :exc:`NotmuchError`
 
         :returns: A :class:`Tags` iterator.
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if the message 
+                      * STATUS.NOT_INITIALIZED if the message

                         is not initialized.
                       * STATUS.NULL_POINTER, on error
         """
                         is not initialized.
                       * STATUS.NULL_POINTER, on error
         """


@@ -470,6 +501,10 @@ class Message(object):
             raise NotmuchError(STATUS.NULL_POINTER)
         return Tags(tags_p, self)
 
             raise NotmuchError(STATUS.NULL_POINTER)
         return Tags(tags_p, self)
 

+    _add_tag = nmlib.notmuch_message_add_tag
+    _add_tag.argtypes = [NotmuchMessageP, c_char_p]
+    _add_tag.restype = c_uint
+

     def add_tag(self, tag, sync_maildir_flags=False):
         """Adds a tag to the given message
 
     def add_tag(self, tag, sync_maildir_flags=False):
         """Adds a tag to the given message
 


@@ -493,10 +528,10 @@ class Message(object):
                   STATUS.NULL_POINTER
                     The 'tag' argument is NULL
                   STATUS.TAG_TOO_LONG
                   STATUS.NULL_POINTER
                     The 'tag' argument is NULL
                   STATUS.TAG_TOO_LONG

-                    The length of 'tag' is too long 
+                    The length of 'tag' is too long

                     (exceeds Message.NOTMUCH_TAG_MAX)
                   STATUS.READ_ONLY_DATABASE
                     (exceeds Message.NOTMUCH_TAG_MAX)
                   STATUS.READ_ONLY_DATABASE

-                    Database was opened in read-only mode so message cannot be 
+                    Database was opened in read-only mode so message cannot be

                     modified.
                   STATUS.NOT_INITIALIZED
                      The message has not been initialized.
                     modified.
                   STATUS.NOT_INITIALIZED
                      The message has not been initialized.


@@ -504,7 +539,7 @@ class Message(object):
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        status = nmlib.notmuch_message_add_tag (self._msg, tag)
+        status = self._add_tag(self._msg, _str(tag))

 
         # bail out on failure
         if status != STATUS.SUCCESS:
 
         # bail out on failure
         if status != STATUS.SUCCESS:


@@ -514,6 +549,10 @@ class Message(object):
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 

+    _remove_tag = nmlib.notmuch_message_remove_tag
+    _remove_tag.argtypes = [NotmuchMessageP, c_char_p]
+    _remove_tag.restype = c_uint
+

     def remove_tag(self, tag, sync_maildir_flags=False):
         """Removes a tag from the given message
 
     def remove_tag(self, tag, sync_maildir_flags=False):
         """Removes a tag from the given message
 


@@ -529,7 +568,7 @@ class Message(object):
             that this will do nothing when a message is frozen, as tag
             changes will not be committed to the database yet.
 
             that this will do nothing when a message is frozen, as tag
             changes will not be committed to the database yet.
 

-        :returns: STATUS.SUCCESS if the tag was successfully removed or if 
+        :returns: STATUS.SUCCESS if the tag was successfully removed or if

                   the message had no such tag.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:
                   the message had no such tag.
                   Raises an exception otherwise.
         :exception: :exc:`NotmuchError`. They have the following meaning:


@@ -540,7 +579,7 @@ class Message(object):
                      The length of 'tag' is too long
                      (exceeds NOTMUCH_TAG_MAX)
                    STATUS.READ_ONLY_DATABASE
                      The length of 'tag' is too long
                      (exceeds NOTMUCH_TAG_MAX)
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.


@@ -548,7 +587,7 @@ class Message(object):
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 

-        status = nmlib.notmuch_message_remove_tag(self._msg, tag)
+        status = self._remove_tag(self._msg, _str(tag))

         # bail out on error
         if status != STATUS.SUCCESS:
             raise NotmuchError(status)
         # bail out on error
         if status != STATUS.SUCCESS:
             raise NotmuchError(status)


@@ -557,7 +596,9 @@ class Message(object):
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 

-
+    _remove_all_tags = nmlib.notmuch_message_remove_all_tags
+    _remove_all_tags.argtypes = [NotmuchMessageP]
+    _remove_all_tags.restype = c_uint

 
     def remove_all_tags(self, sync_maildir_flags=False):
         """Removes all tags from the given message.
 
     def remove_all_tags(self, sync_maildir_flags=False):
         """Removes all tags from the given message.


@@ -579,15 +620,15 @@ class Message(object):
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
-        status = nmlib.notmuch_message_remove_all_tags(self._msg)
+
+        status = self._remove_all_tags(self._msg)

 
         # bail out on error
         if status != STATUS.SUCCESS:
 
         # bail out on error
         if status != STATUS.SUCCESS:


@@ -597,11 +638,15 @@ class Message(object):
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 
             self.tags_to_maildir_flags()
         return STATUS.SUCCESS
 

+    _freeze = nmlib.notmuch_message_freeze
+    _freeze.argtypes = [NotmuchMessageP]
+    _freeze.restype = c_uint
+

     def freeze(self):
         """Freezes the current state of 'message' within the database
 
     def freeze(self):
         """Freezes the current state of 'message' within the database
 

-        This means that changes to the message state, (via :meth:`add_tag`, 
-        :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be 
+        This means that changes to the message state, (via :meth:`add_tag`,
+        :meth:`remove_tag`, and :meth:`remove_all_tags`), will not be

         committed to the database until the message is :meth:`thaw`ed.
 
         Multiple calls to freeze/thaw are valid and these calls will
         committed to the database until the message is :meth:`thaw`ed.
 
         Multiple calls to freeze/thaw are valid and these calls will


@@ -633,15 +678,15 @@ class Message(object):
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.READ_ONLY_DATABASE

-                     Database was opened in read-only mode so message cannot 
+                     Database was opened in read-only mode so message cannot

                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      be modified.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
-        status = nmlib.notmuch_message_freeze(self._msg)
+
+        status = self._freeze(self._msg)

 
         if STATUS.SUCCESS == status:
             # return on success
 
         if STATUS.SUCCESS == status:
             # return on success


@@ -649,10 +694,14 @@ class Message(object):
 
         raise NotmuchError(status)
 
 
         raise NotmuchError(status)
 

+    _thaw = nmlib.notmuch_message_thaw
+    _thaw.argtypes = [NotmuchMessageP]
+    _thaw.restype = c_uint
+

     def thaw(self):
         """Thaws the current 'message'
 
     def thaw(self):
         """Thaws the current 'message'
 

-        Thaw the current 'message', synchronizing any changes that may have 
+        Thaw the current 'message', synchronizing any changes that may have

         occurred while 'message' was frozen into the notmuch database.
 
         See :meth:`freeze` for an example of how to use this
         occurred while 'message' was frozen into the notmuch database.
 
         See :meth:`freeze` for an example of how to use this


@@ -667,16 +716,16 @@ class Message(object):
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.UNBALANCED_FREEZE_THAW
         :exception: :exc:`NotmuchError`. They have the following meaning:
 
                    STATUS.UNBALANCED_FREEZE_THAW

-                     An attempt was made to thaw an unfrozen message. 
-                     That is, there have been an unbalanced number of calls 
+                     An attempt was made to thaw an unfrozen message.
+                     That is, there have been an unbalanced number of calls

                      to :meth:`freeze` and :meth:`thaw`.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
                      to :meth:`freeze` and :meth:`thaw`.
                    STATUS.NOT_INITIALIZED
                      The message has not been initialized.
         """
         if self._msg is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)

- 
-        status = nmlib.notmuch_message_thaw(self._msg)
+
+        status = self._thaw(self._msg)

 
         if STATUS.SUCCESS == status:
             # return on success
 
         if STATUS.SUCCESS == status:
             # return on success


@@ -684,7 +733,6 @@ class Message(object):
 
         raise NotmuchError(status)
 
 
         raise NotmuchError(status)
 

-

     def is_match(self):
         """(Not implemented)"""
         return self.get_flag(Message.FLAG.MATCH)
     def is_match(self):
         """(Not implemented)"""
         return self.get_flag(Message.FLAG.MATCH)


@@ -697,10 +745,10 @@ class Message(object):
               'P' if the message has the "passed" tag
               'R' if the message has the "replied" tag
               'S' if the message does not have the "unread" tag
               'P' if the message has the "passed" tag
               'R' if the message has the "replied" tag
               'S' if the message does not have the "unread" tag

-            
+

         Any existing flags unmentioned in the list above will be
         preserved in the renaming.
         Any existing flags unmentioned in the list above will be
         preserved in the renaming.

-            
+

         Also, if this filename is in a directory named "new", rename it
         to be within the neighboring directory named "cur".
 
         Also, if this filename is in a directory named "new", rename it
         to be within the neighboring directory named "cur".
 


@@ -749,11 +797,10 @@ class Message(object):
         """A message() is represented by a 1-line summary"""
         msg = {}
         msg['from'] = self.get_header('from')
         """A message() is represented by a 1-line summary"""
         msg = {}
         msg['from'] = self.get_header('from')

-        msg['tags'] = str(self.get_tags())
+        msg['tags'] = self.get_tags()

         msg['date'] = date.fromtimestamp(self.get_date())
         return "%(from)s (%(date)s) (%(tags)s)" % (msg)
 
         msg['date'] = date.fromtimestamp(self.get_date())
         return "%(from)s (%(date)s) (%(tags)s)" % (msg)
 

-

     def get_message_parts(self):
         """Output like notmuch show"""
         fp = open(self.get_filename())
     def get_message_parts(self):
         """Output like notmuch show"""
         fp = open(self.get_filename())


@@ -802,7 +849,7 @@ class Message(object):
             part_dict["content-type"] = cont_type
             # NOTE:
             # Now we emulate the current behaviour, where it ignores
             part_dict["content-type"] = cont_type
             # NOTE:
             # Now we emulate the current behaviour, where it ignores

-            # the html if there's a text representation. 
+            # the html if there's a text representation.

             #
             # This is being worked on, but it will be easier to fix
             # here in the future than to end up with another
             #
             # This is being worked on, but it will be easier to fix
             # here in the future than to end up with another


@@ -813,7 +860,7 @@ class Message(object):
             else:
                 if cont_type.lower() == "text/plain":
                     part_dict["content"] = msg.get_payload()
             else:
                 if cont_type.lower() == "text/plain":
                     part_dict["content"] = msg.get_payload()

-                elif (cont_type.lower() == "text/html" and 
+                elif (cont_type.lower() == "text/html" and

                       i == 0):
                     part_dict["content"] = msg.get_payload()
             body.append(part_dict)
                       i == 0):
                     part_dict["content"] = msg.get_payload()
             body.append(part_dict)


@@ -858,18 +905,18 @@ class Message(object):
         parts = format["body"]
         parts.sort(key=lambda x: x['id'])
         for p in parts:
         parts = format["body"]
         parts.sort(key=lambda x: x['id'])
         for p in parts:

-            if not p.has_key("filename"):
+            if not "filename" in p:

                 output += "\n\fpart{ "
                 output += "\n\fpart{ "

-                output += "ID: %d, Content-type: %s\n" % (p["id"], 
-                                                         p["content-type"])
-                if p.has_key("content"):
+                output += "ID: %d, Content-type: %s\n" % (p["id"],
+                                                          p["content-type"])
+                if "content" in p:

                     output += "\n%s\n" % p["content"]
                 else:
                     output += "Non-text part: %s\n" % p["content-type"]
                     output += "\n%s\n" % p["content"]
                 else:
                     output += "Non-text part: %s\n" % p["content-type"]

-                    output += "\n\fpart}"                    
+                    output += "\n\fpart}"

             else:
                 output += "\n\fattachment{ "
             else:
                 output += "\n\fattachment{ "

-                output += "ID: %d, Content-type:%s\n" % (p["id"], 
+                output += "ID: %d, Content-type:%s\n" % (p["id"],

                                                          p["content-type"])
                 output += "Attachment: %s\n" % p["filename"]
                 output += "\n\fattachment}\n"
                                                          p["content-type"])
                 output += "Attachment: %s\n" % p["filename"]
                 output += "\n\fattachment}\n"


@@ -895,12 +942,16 @@ class Message(object):
         been added or removed, the same messages would not be considered
         equal (as they do not point to the same set of files
         any more)."""
         been added or removed, the same messages would not be considered
         equal (as they do not point to the same set of files
         any more)."""

-        res =  cmp(self.get_message_id(), other.get_message_id())
+        res = cmp(self.get_message_id(), other.get_message_id())

         if res:
             res = cmp(list(self.get_filenames()), list(other.get_filenames()))
         return res
 
         if res:
             res = cmp(list(self.get_filenames()), list(other.get_filenames()))
         return res
 

+    _destroy = nmlib.notmuch_message_destroy
+    _destroy.argtypes = [NotmuchMessageP]
+    _destroy.restype = None
+

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

-            nmlib.notmuch_message_destroy (self._msg)
+            self._destroy(self._msg)