python: Add new functions in API documentation

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

diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index c607011172845c95d18d941d363ce22e3fba95e5..1e6d33753ec725c123a55ed893c31675353a4368 100644 (file)
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -19,12 +19,11 @@ Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
 
 import os
 from ctypes import c_int, c_char_p, c_void_p, c_uint, c_long, byref
 
 import os
 from ctypes import c_int, c_char_p, c_void_p, c_uint, c_long, byref

-from notmuch.globals import nmlib, STATUS, NotmuchError, Enum
+from notmuch.globals import nmlib, STATUS, NotmuchError, Enum, _str

 from notmuch.thread import Threads
 from notmuch.message import Messages, Message
 from notmuch.tag import Tags
 
 from notmuch.thread import Threads
 from notmuch.message import Messages, Message
 from notmuch.tag import Tags
 

-

 class Database(object):
     """Represents a notmuch database (wraps notmuch_database_t)
 
 class Database(object):
     """Represents a notmuch database (wraps notmuch_database_t)
 


@@ -64,6 +63,10 @@ class Database(object):
     _find_message = nmlib.notmuch_database_find_message
     _find_message.restype = c_void_p
 
     _find_message = nmlib.notmuch_database_find_message
     _find_message.restype = c_void_p
 

+    """notmuch_database_find_message_by_filename"""
+    _find_message_by_filename = nmlib.notmuch_database_find_message_by_filename
+    _find_message_by_filename.restype = c_void_p
+

     """notmuch_database_get_all_tags"""
     _get_all_tags = nmlib.notmuch_database_get_all_tags
     _get_all_tags.restype = c_void_p
     """notmuch_database_get_all_tags"""
     _get_all_tags = nmlib.notmuch_database_get_all_tags
     _get_all_tags.restype = c_void_p


@@ -101,13 +104,12 @@ class Database(object):
                 Database._std_db_path = self._get_user_default_db()
             path = Database._std_db_path
 
                 Database._std_db_path = self._get_user_default_db()
             path = Database._std_db_path
 

-        assert isinstance(path, basestring), 'Path must be a string or None.'

         if create == False:
             self.open(path, mode)
         else:
             self.create(path)
 
         if create == False:
             self.open(path, mode)
         else:
             self.create(path)
 

-    def _verify_initialized_db(self):
+    def _assert_db_is_initialized(self):

         """Raises a NotmuchError in case self._db is still None"""
         if self._db is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         """Raises a NotmuchError in case self._db is still None"""
         if self._db is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)


@@ -132,7 +134,7 @@ class Database(object):
             raise NotmuchError(message="Cannot create db, this Database() "
                                        "already has an open one.")
 
             raise NotmuchError(message="Cannot create db, this Database() "
                                        "already has an open one.")
 

-        res = Database._create(path, Database.MODE.READ_WRITE)
+        res = Database._create(_str(path), Database.MODE.READ_WRITE)

 
         if res is None:
             raise NotmuchError(
 
         if res is None:
             raise NotmuchError(


@@ -152,8 +154,7 @@ class Database(object):
         :exception: Raises :exc:`NotmuchError` in case
                     of any failure (after printing an error message on stderr).
         """
         :exception: Raises :exc:`NotmuchError` in case
                     of any failure (after printing an error message on stderr).
         """

-
-        res = Database._open(path, mode)
+        res = Database._open(_str(path), mode)

 
         if res is None:
             raise NotmuchError(
 
         if res is None:
             raise NotmuchError(


@@ -163,22 +164,18 @@ class Database(object):
     def get_path(self):
         """Returns the file path of an open database
 
     def get_path(self):
         """Returns the file path of an open database
 

-        Wraps *notmuch_database_get_path*."""
-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
-        return Database._get_path(self._db)
+        .. ..:: Wraps underlying `notmuch_database_get_path`"""
+        self._assert_db_is_initialized()
+        return Database._get_path(self._db).decode('utf-8')

 
     def get_version(self):
         """Returns the database format version
 
         :returns: The database version as positive integer
 
     def get_version(self):
         """Returns the database format version
 
         :returns: The database version as positive integer

-        :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+        :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if

                     the database was not intitialized.
         """
                     the database was not intitialized.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         return Database._get_version(self._db)
 
     def needs_upgrade(self):
         return Database._get_version(self._db)
 
     def needs_upgrade(self):


@@ -190,12 +187,10 @@ class Database(object):
         etc.) will work unless :meth:`upgrade` is called successfully first.
 
         :returns: `True` or `False`
         etc.) will work unless :meth:`upgrade` is called successfully first.
 
         :returns: `True` or `False`

-        :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+        :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if

                     the database was not intitialized.
         """
                     the database was not intitialized.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         return nmlib.notmuch_database_needs_upgrade(self._db)
 
     def upgrade(self):
         return nmlib.notmuch_database_needs_upgrade(self._db)
 
     def upgrade(self):


@@ -213,38 +208,78 @@ class Database(object):
 
         :TODO: catch exceptions, document return values and etc...
         """
 
         :TODO: catch exceptions, document return values and etc...
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         status = Database._upgrade(self._db, None, None)
         #TODO: catch exceptions, document return values and etc
         return status
 
         status = Database._upgrade(self._db, None, None)
         #TODO: catch exceptions, document return values and etc
         return status
 

+    def begin_atomic(self):
+        """Begin an atomic database operation
+
+        Any modifications performed between a successful
+        :meth:`begin_atomic` and a :meth:`end_atomic` will be applied to
+        the database atomically.  Note that, unlike a typical database
+        transaction, this only ensures atomicity, not durability;
+        neither begin nor end necessarily flush modifications to disk.
+
+        :returns: :attr:`STATUS`.SUCCESS or raises
+
+        :exception: :exc:`NotmuchError`:
+            :attr:`STATUS`.XAPIAN_EXCEPTION
+                Xapian exception occurred; atomic section not entered.
+
+        *Added in notmuch 0.9*"""
+        self._assert_db_is_initialized()
+        status = nmlib.notmuch_database_begin_atomic(self._db)
+        if status != STATUS.SUCCESS:
+            raise NotmuchError(status)
+        return status
+
+    def end_atomic(self):
+        """Indicate the end of an atomic database operation
+
+        See :meth:`begin_atomic` for details.
+
+        :returns: :attr:`STATUS`.SUCCESS or raises
+
+        :exception:
+            :exc:`NotmuchError`:
+                :attr:`STATUS`.XAPIAN_EXCEPTION
+                    A Xapian exception occurred; atomic section not
+                    ended.
+                :attr:`STATUS`.UNBALANCED_ATOMIC:
+                    end_atomic has been called more times than begin_atomic.
+
+        *Added in notmuch 0.9*"""
+        self._assert_db_is_initialized()
+        status = nmlib.notmuch_database_end_atomic(self._db)
+        if status != STATUS.SUCCESS:
+            raise NotmuchError(status)
+        return status
+

     def get_directory(self, path):
         """Returns a :class:`Directory` of path,
         (creating it if it does not exist(?))
 
         .. warning:: This call needs a writeable database in
     def get_directory(self, path):
         """Returns a :class:`Directory` of path,
         (creating it if it does not exist(?))
 
         .. warning:: This call needs a writeable database in

-           Database.MODE.READ_WRITE mode. The underlying library will exit the
+           :attr:`Database.MODE`.READ_WRITE mode. The underlying library will exit the

            program if this method is used on a read-only database!
 
            program if this method is used on a read-only database!
 

-        :param path: A str containing the path relative to the path of database
-              (see :meth:`get_path`), or else should be an absolute path
+        :param path: An unicode string containing the path relative to the path
+              of database (see :meth:`get_path`), or else should be an absolute path

               with initial components that match the path of 'database'.
         :returns: :class:`Directory` or raises an exception.
         :exception: :exc:`NotmuchError`
 
               with initial components that match the path of 'database'.
         :returns: :class:`Directory` or raises an exception.
         :exception: :exc:`NotmuchError`
 

-                  STATUS.NOT_INITIALIZED
+                  :attr:`STATUS`.NOT_INITIALIZED

                     If the database was not intitialized.
 
                     If the database was not intitialized.
 

-                  STATUS.FILE_ERROR
+                  :attr:`STATUS`.FILE_ERROR

                     If path is not relative database or absolute with initial
                     components same as database.
 
         """
                     If path is not relative database or absolute with initial
                     components same as database.
 
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         # sanity checking if path is valid, and make path absolute
         if path[0] == os.sep:
             # we got an absolute path
         # sanity checking if path is valid, and make path absolute
         if path[0] == os.sep:
             # we got an absolute path


@@ -258,23 +293,24 @@ class Database(object):
             #we got a relative path, make it absolute
             abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path))
 
             #we got a relative path, make it absolute
             abs_dirpath = os.path.abspath(os.path.join(self.get_path(), path))
 

-        dir_p = Database._get_directory(self._db, path)
+        dir_p = Database._get_directory(self._db, _str(path))

 
         # return the Directory, init it with the absolute path
 
         # return the Directory, init it with the absolute path

-        return Directory(abs_dirpath, dir_p, self)
+        return Directory(_str(abs_dirpath), dir_p, self)

 
     def add_message(self, filename, sync_maildir_flags=False):
         """Adds a new message to the database
 
 
     def add_message(self, filename, sync_maildir_flags=False):
         """Adds a new message to the database
 

-        :param filename: should be a path relative to the path of the open
-        database (see :meth:`get_path`), or else should be an absolute
-        filename with initial components that match the path of the
-        database.
+        :param filename: should be a path relative to the path of the
+            open database (see :meth:`get_path`), or else should be an
+            absolute filename with initial components that match the
+            path of the database.

 
 

-        The file should be a single mail message (not a multi-message mbox)
-        that is expected to remain at its current location, since the
-        notmuch database will reference the filename, and will not copy the
-        entire contents of the file.
+            The file should be a single mail message (not a
+            multi-message mbox) that is expected to remain at its
+            current location, since the notmuch database will reference
+            the filename, and will not copy the entire contents of the
+            file.

 
         :param sync_maildir_flags: If the message contains Maildir
             flags, we will -depending on the notmuch configuration- sync
 
         :param sync_maildir_flags: If the message contains Maildir
             flags, we will -depending on the notmuch configuration- sync


@@ -287,38 +323,36 @@ class Database(object):
 
            1) a :class:`Message` object that can be used for things
               such as adding tags to the just-added message.
 
            1) a :class:`Message` object that can be used for things
               such as adding tags to the just-added message.

-           2) one of the following STATUS values:
+           2) one of the following :attr:`STATUS` values:

 
 

-              STATUS.SUCCESS
+              :attr:`STATUS`.SUCCESS

                   Message successfully added to database.
                   Message successfully added to database.

-              STATUS.DUPLICATE_MESSAGE_ID
+              :attr:`STATUS`.DUPLICATE_MESSAGE_ID

                   Message has the same message ID as another message already
                   in the database. The new filename was successfully added
                   Message has the same message ID as another message already
                   in the database. The new filename was successfully added

-                  to the message in the database.
+                  to the list of the filenames for the existing message.

 
 

-        :rtype:   2-tuple(:class:`Message`, STATUS)
+        :rtype:   2-tuple(:class:`Message`, :attr:`STATUS`)

 
         :exception: Raises a :exc:`NotmuchError` with the following meaning.
               If such an exception occurs, nothing was added to the database.
 
 
         :exception: Raises a :exc:`NotmuchError` with the following meaning.
               If such an exception occurs, nothing was added to the database.
 

-              STATUS.FILE_ERROR
+              :attr:`STATUS`.FILE_ERROR

                       An error occurred trying to open the file, (such as
                       permission denied, or file not found, etc.).
                       An error occurred trying to open the file, (such as
                       permission denied, or file not found, etc.).

-              STATUS.FILE_NOT_EMAIL
+              :attr:`STATUS`.FILE_NOT_EMAIL

                       The contents of filename don't look like an email
                       message.
                       The contents of filename don't look like an email
                       message.

-              STATUS.READ_ONLY_DATABASE
+              :attr:`STATUS`.READ_ONLY_DATABASE

                       Database was opened in read-only mode so no message can
                       be added.
                       Database was opened in read-only mode so no message can
                       be added.

-              STATUS.NOT_INITIALIZED
+              :attr:`STATUS`.NOT_INITIALIZED

                       The database has not been initialized.
         """
                       The database has not been initialized.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         msg_p = c_void_p()
         status = nmlib.notmuch_database_add_message(self._db,
         msg_p = c_void_p()
         status = nmlib.notmuch_database_add_message(self._db,

-                                                  filename,
+                                                  _str(filename),

                                                   byref(msg_p))
 
         if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]:
                                                   byref(msg_p))
 
         if not status in [STATUS.SUCCESS, STATUS.DUPLICATE_MESSAGE_ID]:


@@ -332,7 +366,7 @@ class Database(object):
         return (msg, status)
 
     def remove_message(self, filename):
         return (msg, status)
 
     def remove_message(self, filename):

-        """Removes a message from the given notmuch database
+        """Removes a message (filename) from the given notmuch database

 
         Note that only this particular filename association is removed from
         the database. If the same message (as determined by the message ID)
 
         Note that only this particular filename association is removed from
         the database. If the same message (as determined by the message ID)


@@ -341,12 +375,12 @@ class Database(object):
         is removed for a particular message, the database content for that
         message will be entirely removed.
 
         is removed for a particular message, the database content for that
         message will be entirely removed.
 

-        :returns: A STATUS value with the following meaning:
+        :returns: A :attr:`STATUS` value with the following meaning:

 
 

-             STATUS.SUCCESS
+             :attr:`STATUS`.SUCCESS

                The last filename was removed and the message was removed
                from the database.
                The last filename was removed and the message was removed
                from the database.

-             STATUS.DUPLICATE_MESSAGE_ID
+             :attr:`STATUS`.DUPLICATE_MESSAGE_ID

                This filename was removed but the message persists in the
                database with at least one other filename.
 
                This filename was removed but the message persists in the
                database with at least one other filename.
 


@@ -354,15 +388,13 @@ class Database(object):
              If such an exception occurs, nothing was removed from the
              database.
 
              If such an exception occurs, nothing was removed from the
              database.
 

-             STATUS.READ_ONLY_DATABASE
+             :attr:`STATUS`.READ_ONLY_DATABASE

                Database was opened in read-only mode so no message can be
                removed.
                Database was opened in read-only mode so no message can be
                removed.

-             STATUS.NOT_INITIALIZED
+             :attr:`STATUS`.NOT_INITIALIZED

                The database has not been initialized.
         """
                The database has not been initialized.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         return nmlib.notmuch_database_remove_message(self._db,
                                                        filename)
 
         return nmlib.notmuch_database_remove_message(self._db,
                                                        filename)
 


@@ -381,26 +413,41 @@ class Database(object):
                   another program in the meantime. A return value of
                   `None` is therefore no guarantee that the message
                   does not exist.
                   another program in the meantime. A return value of
                   `None` is therefore no guarantee that the message
                   does not exist.

-        :exception: :exc:`NotmuchError` with STATUS.NOT_INITIALIZED if
+        :exception: :exc:`NotmuchError` with :attr:`STATUS`.NOT_INITIALIZED if

                   the database was not intitialized.
         """
                   the database was not intitialized.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
+        self._assert_db_is_initialized()
+        msg_p = Database._find_message(self._db, _str(msgid))
+        return msg_p and Message(msg_p, self) or None
+
+    def find_message_by_filename(self, filename):
+        """Find a message with the given filename
+
+        .. warning:: This call needs a writeable database in
+           :attr:`Database.MODE`.READ_WRITE mode. The underlying library will
+           exit the program if this method is used on a read-only
+           database!
+
+        :returns: If the database contains a message with the given
+            filename, then a class:`Message:` is returned.  This
+            function returns None in the following situations:

 
 

-        msg_p = Database._find_message(self._db, msgid)
-        if msg_p is None:
-            return None
-        return Message(msg_p, self)
+                * No message is found with the given filename
+                * An out-of-memory situation occurs
+                * A Xapian exception occurs
+
+        *Added in notmuch 0.9*"""
+        self._assert_db_is_initialized()
+        msg_p = Database._find_message_by_filename(self._db, _str(filename))
+        return msg_p and Message(msg_p, self) or None

 
     def get_all_tags(self):
         """Returns :class:`Tags` with a list of all tags found in the database
 
         :returns: :class:`Tags`
 
     def get_all_tags(self):
         """Returns :class:`Tags` with a list of all tags found in the database
 
         :returns: :class:`Tags`

-        :execption: :exc:`NotmuchError` with STATUS.NULL_POINTER on error
+        :execption: :exc:`NotmuchError` with :attr:`STATUS`.NULL_POINTER on error

         """
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         tags_p = Database._get_all_tags(self._db)
         if tags_p == None:
             raise NotmuchError(STATUS.NULL_POINTER)
         tags_p = Database._get_all_tags(self._db)
         if tags_p == None:
             raise NotmuchError(STATUS.NULL_POINTER)


@@ -424,9 +471,7 @@ class Database(object):
 
         This function is a python extension and not in the underlying C API.
         """
 
         This function is a python extension and not in the underlying C API.
         """

-        # Raise a NotmuchError if not initialized
-        self._verify_initialized_db()
-
+        self._assert_db_is_initialized()

         return Query(self, querystring)
 
     def __repr__(self):
         return Query(self, querystring)
 
     def __repr__(self):


@@ -449,7 +494,7 @@ class Database(object):
         if not config.has_option('database', 'path'):
             raise NotmuchError(message="No DB path specified"
                                        " and no user default found")
         if not config.has_option('database', 'path'):
             raise NotmuchError(message="No DB path specified"
                                        " and no user default found")

-        return config.get('database', 'path')
+        return config.get('database', 'path').decode('utf-8')

 
     @property
     def db_p(self):
 
     @property
     def db_p(self):


@@ -524,21 +569,18 @@ class Query(object):
         :returns: Nothing
         :exception: :exc:`NotmuchError`
 
         :returns: Nothing
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if db is not inited
-                      * STATUS.NULL_POINTER if the query creation failed
+                      * :attr:`STATUS`.NOT_INITIALIZED if db is not inited
+                      * :attr:`STATUS`.NULL_POINTER if the query creation failed

                         (too little memory)
         """
         if db.db_p is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         # create reference to parent db to keep it alive
         self._db = db
                         (too little memory)
         """
         if db.db_p is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         # create reference to parent db to keep it alive
         self._db = db

-        if isinstance(querystr, unicode):
-            # xapian takes utf-8 encoded byte arrays
-            querystr = querystr.encode('utf-8')

         # create query, return None if too little mem available
         # create query, return None if too little mem available

-        query_p = Query._create(db.db_p, querystr)
+        query_p = Query._create(db.db_p, _str(querystr))

         if query_p is None:
         if query_p is None:

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

         self._query = query_p
 
     def set_sort(self, sort):
         self._query = query_p
 
     def set_sort(self, sort):


@@ -548,7 +590,7 @@ class Query(object):
 
         :param sort: Sort order (see :attr:`Query.SORT`)
         :returns: Nothing
 
         :param sort: Sort order (see :attr:`Query.SORT`)
         :returns: Nothing

-        :exception: :exc:`NotmuchError` STATUS.NOT_INITIALIZED if query has not
+        :exception: :exc:`NotmuchError` :attr:`STATUS`.NOT_INITIALIZED if query has not

                     been initialized.
         """
         if self._query is None:
                     been initialized.
         """
         if self._query is None:


@@ -574,8 +616,8 @@ class Query(object):
         :returns: :class:`Threads`
         :exception: :exc:`NotmuchError`
 
         :returns: :class:`Threads`
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if query is not inited
-                      * STATUS.NULL_POINTER if search_threads failed
+                      * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
+                      * :attr:`STATUS`.NULL_POINTER if search_threads failed

         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)


@@ -597,8 +639,8 @@ class Query(object):
         :returns: :class:`Messages`
         :exception: :exc:`NotmuchError`
 
         :returns: :class:`Messages`
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if query is not inited
-                      * STATUS.NULL_POINTER if search_messages failed
+                      * :attr:`STATUS`.NOT_INITIALIZED if query is not inited
+                      * :attr:`STATUS`.NULL_POINTER if search_messages failed

         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)


@@ -606,7 +648,7 @@ class Query(object):
         msgs_p = Query._search_messages(self._query)
 
         if msgs_p is None:
         msgs_p = Query._search_messages(self._query)
 
         if msgs_p is None:

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

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


@@ -623,7 +665,7 @@ class Query(object):
         :returns: :class:`Messages`
         :exception: :exc:`NotmuchError`
 
         :returns: :class:`Messages`
         :exception: :exc:`NotmuchError`
 

-                      * STATUS.NOT_INITIALIZED if query is not inited
+                      * :attr:`STATUS`.NOT_INITIALIZED if query is not inited

         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
         """
         if self._query is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)


@@ -666,14 +708,14 @@ class Directory(object):
     _get_child_directories = nmlib.notmuch_directory_get_child_directories
     _get_child_directories.restype = c_void_p
 
     _get_child_directories = nmlib.notmuch_directory_get_child_directories
     _get_child_directories.restype = c_void_p
 

-    def _verify_dir_initialized(self):
-        """Raises a NotmuchError(STATUS.NOT_INITIALIZED) if dir_p is None"""
+    def _assert_dir_is_initialized(self):
+        """Raises a NotmuchError(:attr:`STATUS`.NOT_INITIALIZED) if dir_p is None"""

         if self._dir_p is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
     def __init__(self, path, dir_p, parent):
         """
         if self._dir_p is None:
             raise NotmuchError(STATUS.NOT_INITIALIZED)
 
     def __init__(self, path, dir_p, parent):
         """

-        :param path:   The absolute path of the directory object.
+        :param path:   The absolute path of the directory object as unicode.

         :param dir_p:  The pointer to an internal notmuch_directory_t object.
         :param parent: The object this Directory is derived from
                        (usually a :class:`Database`). We do not directly use
         :param dir_p:  The pointer to an internal notmuch_directory_t object.
         :param parent: The object this Directory is derived from
                        (usually a :class:`Database`). We do not directly use


@@ -681,6 +723,7 @@ class Directory(object):
                        this Directory object lives. This keeps the
                        parent object alive.
         """
                        this Directory object lives. This keeps the
                        parent object alive.
         """

+        assert isinstance(path, unicode), "Path needs to be an UNICODE object"

         self._path = path
         self._dir_p = dir_p
         self._parent = parent
         self._path = path
         self._dir_p = dir_p
         self._parent = parent


@@ -712,17 +755,15 @@ class Directory(object):
           :returns: Nothing on success, raising an exception on failure.
           :exception: :exc:`NotmuchError`:
 
           :returns: Nothing on success, raising an exception on failure.
           :exception: :exc:`NotmuchError`:
 

-                        STATUS.XAPIAN_EXCEPTION
+                        :attr:`STATUS`.XAPIAN_EXCEPTION

                           A Xapian exception occurred, mtime not stored.
                           A Xapian exception occurred, mtime not stored.

-                        STATUS.READ_ONLY_DATABASE
+                        :attr:`STATUS`.READ_ONLY_DATABASE

                           Database was opened in read-only mode so directory
                           mtime cannot be modified.
                           Database was opened in read-only mode so directory
                           mtime cannot be modified.

-                        STATUS.NOT_INITIALIZED
+                        :attr:`STATUS`.NOT_INITIALIZED

                           The directory has not been initialized
         """
                           The directory has not been initialized
         """

-        #Raise a NotmuchError(STATUS.NOT_INITIALIZED) if the dir_p is None
-        self._verify_dir_initialized()
-
+        self._assert_dir_is_initialized()

         #TODO: make sure, we convert the mtime parameter to a 'c_long'
         status = Directory._set_mtime(self._dir_p, mtime)
 
         #TODO: make sure, we convert the mtime parameter to a 'c_long'
         status = Directory._set_mtime(self._dir_p, mtime)
 


@@ -741,12 +782,10 @@ class Directory(object):
         :returns: Nothing on success, raising an exception on failure.
         :exception: :exc:`NotmuchError`:
 
         :returns: Nothing on success, raising an exception on failure.
         :exception: :exc:`NotmuchError`:
 

-                        STATUS.NOT_INITIALIZED
+                        :attr:`STATUS`.NOT_INITIALIZED

                           The directory has not been initialized
         """
                           The directory has not been initialized
         """

-        #Raise a NotmuchError(STATUS.NOT_INITIALIZED) if self.dir_p is None
-        self._verify_dir_initialized()
-
+        self._assert_dir_is_initialized()

         return Directory._get_mtime(self._dir_p)
 
     # Make mtime attribute a property of Directory()
         return Directory._get_mtime(self._dir_p)
 
     # Make mtime attribute a property of Directory()


@@ -763,9 +802,7 @@ class Directory(object):
         The returned filenames will be the basename-entries only (not
         complete paths.
         """
         The returned filenames will be the basename-entries only (not
         complete paths.
         """

-        #Raise a NotmuchError(STATUS.NOT_INITIALIZED) if self._dir_p is None
-        self._verify_dir_initialized()
-
+        self._assert_dir_is_initialized()

         files_p = Directory._get_child_files(self._dir_p)
         return Filenames(files_p, self)
 
         files_p = Directory._get_child_files(self._dir_p)
         return Filenames(files_p, self)
 


@@ -776,9 +813,7 @@ class Directory(object):
         The returned filenames will be the basename-entries only (not
         complete paths.
         """
         The returned filenames will be the basename-entries only (not
         complete paths.
         """

-        #Raise a NotmuchError(STATUS.NOT_INITIALIZED) if self._dir_p is None
-        self._verify_dir_initialized()
-
+        self._assert_dir_is_initialized()

         files_p = Directory._get_child_directories(self._dir_p)
         return Filenames(files_p, self)
 
         files_p = Directory._get_child_directories(self._dir_p)
         return Filenames(files_p, self)
 


@@ -841,7 +876,7 @@ class Filenames(object):
                  #THIS FAILS
                  files = Database().get_directory('').get_child_files()
                  if len(files) > 0:              #this 'exhausts' msgs
                  #THIS FAILS
                  files = Database().get_directory('').get_child_files()
                  if len(files) > 0:              #this 'exhausts' msgs

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

                      for file in files: print file
         """
         if self._files_p is None:
                      for file in files: print file
         """
         if self._files_p is None: