Merge branch 'release'

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

diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index 841e808e33c6f22f4211be0f9cfa3b5a80e043c9..f4bc53e02c6d17574595e25972979af99ad6aa9d 100644 (file)
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -20,19 +20,33 @@ 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
 from notmuch.globals import (nmlib, STATUS, NotmuchError, NotInitializedError,
 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, NotInitializedError,

-     OutOfMemoryError, XapianError, Enum, _str)
+     NullPointerError, OutOfMemoryError, XapianError, Enum, _str)

 from notmuch.thread import Threads
 from notmuch.message import Messages, Message
 from notmuch.tag import Tags
 
 class Database(object):
 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)
-
-    .. note:: Do remember that as soon as we tear down this object,
-           all underlying derived objects such as queries, threads,
-           messages, tags etc will be freed by the underlying library
-           as well. Accessing these objects will lead to segfaults and
-           other unexpected behavior. See above for more details.
+    """The :class:`Database` is the highest-level object that notmuch
+    provides. It references a notmuch database, and can be opened in
+    read-only or read-write mode. A :class:`Query` can be derived from
+    or be applied to a specific database to find messages. Also adding
+    and removing messages to the database happens via this
+    object. Modifications to the database are not atmic by default (see
+    :meth:`begin_atomic`) and once a database has been modified, all
+    other database objects pointing to the same data-base will throw an
+    :exc:`XapianError` as the underlying database has been
+    modified. Close and reopen the database to continue working with it.
+
+    .. note:: Any function in this class can and will throw an
+           :exc:`NotInitializedError` if the database was not
+           intitialized properly.
+
+    .. note:: Do remember that as soon as we tear down (e.g. via `del
+           db`) this object, all underlying derived objects such as
+           queries, threads, messages, tags etc will be freed by the
+           underlying library as well. Accessing these objects will lead
+           to segfaults and other unexpected behavior. See above for
+           more details.

     """
     _std_db_path = None
     """Class attribute to cache user's default database"""
     """
     _std_db_path = None
     """Class attribute to cache user's default database"""


@@ -151,7 +165,7 @@ class Database(object):
         :type status:  :attr:`MODE`
         :returns: Nothing
         :exception: Raises :exc:`NotmuchError` in case
         :type status:  :attr:`MODE`
         :returns: Nothing
         :exception: Raises :exc:`NotmuchError` in case

-                    of any failure (after printing an error message on stderr).
+            of any failure (possibly after printing an error message on stderr).

         """
         res = Database._open(_str(path), mode)
 
         """
         res = Database._open(_str(path), mode)
 


@@ -160,9 +174,7 @@ class Database(object):
         self._db = res
 
     def get_path(self):
         self._db = res
 
     def get_path(self):

-        """Returns the file path of an open database
-
-        .. ..:: Wraps underlying `notmuch_database_get_path`"""
+        """Returns the file path of an open database"""

         self._assert_db_is_initialized()
         return Database._get_path(self._db).decode('utf-8')
 
         self._assert_db_is_initialized()
         return Database._get_path(self._db).decode('utf-8')
 


@@ -170,8 +182,6 @@ class Database(object):
         """Returns the database format version
 
         :returns: The database version as positive integer
         """Returns the database format version
 
         :returns: The database version as positive integer

-        :exception: :exc:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         return Database._get_version(self._db)
         """
         self._assert_db_is_initialized()
         return Database._get_version(self._db)


@@ -185,8 +195,6 @@ 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:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         return nmlib.notmuch_database_needs_upgrade(self._db)
         """
         self._assert_db_is_initialized()
         return nmlib.notmuch_database_needs_upgrade(self._db)


@@ -205,9 +213,6 @@ class Database(object):
         indicating the progress made so far in the upgrade process.
 
         :TODO: catch exceptions, document return values and etc...
         indicating the progress made so far in the upgrade process.
 
         :TODO: catch exceptions, document return values and etc...

-
-        :exception: :exc:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         status = Database._upgrade(self._db, None, None)
         """
         self._assert_db_is_initialized()
         status = Database._upgrade(self._db, None, None)


@@ -229,9 +234,6 @@ class Database(object):
             :attr:`STATUS`.XAPIAN_EXCEPTION
                 Xapian exception occurred; atomic section not entered.
 
             :attr:`STATUS`.XAPIAN_EXCEPTION
                 Xapian exception occurred; atomic section not entered.
 

-            :exc:`NotInitializedError` if
-                the database was not intitialized.
-

         *Added in notmuch 0.9*"""
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_begin_atomic(self._db)
         *Added in notmuch 0.9*"""
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_begin_atomic(self._db)


@@ -254,9 +256,6 @@ class Database(object):
                 :attr:`STATUS`.UNBALANCED_ATOMIC:
                     end_atomic has been called more times than begin_atomic.
 
                 :attr:`STATUS`.UNBALANCED_ATOMIC:
                     end_atomic has been called more times than begin_atomic.
 

-            :exc:`NotInitializedError` if
-                    the database was not intitialized.
-

         *Added in notmuch 0.9*"""
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_end_atomic(self._db)
         *Added in notmuch 0.9*"""
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_end_atomic(self._db)


@@ -280,9 +279,6 @@ class Database(object):
             :exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
                     If path is not relative database or absolute with initial
                     components same as database.
             :exc:`NotmuchError` with :attr:`STATUS`.FILE_ERROR
                     If path is not relative database or absolute with initial
                     components same as database.

-
-            :exc:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         # sanity checking if path is valid, and make path absolute
         """
         self._assert_db_is_initialized()
         # sanity checking if path is valid, and make path absolute


@@ -351,9 +347,6 @@ class Database(object):
               :attr:`STATUS`.READ_ONLY_DATABASE
                       Database was opened in read-only mode so no message can
                       be added.
               :attr:`STATUS`.READ_ONLY_DATABASE
                       Database was opened in read-only mode so no message can
                       be added.

-
-            :exc:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         msg_p = c_void_p()
         """
         self._assert_db_is_initialized()
         msg_p = c_void_p()


@@ -397,9 +390,6 @@ class Database(object):
              :attr:`STATUS`.READ_ONLY_DATABASE
                Database was opened in read-only mode so no message can be
                removed.
              :attr:`STATUS`.READ_ONLY_DATABASE
                Database was opened in read-only mode so no message can be
                removed.

-
-             :exc:`NotInitializedError` if
-                    the database was not intitialized.

         """
         self._assert_db_is_initialized()
         return nmlib.notmuch_database_remove_message(self._db,
         """
         self._assert_db_is_initialized()
         return nmlib.notmuch_database_remove_message(self._db,


@@ -422,8 +412,7 @@ class Database(object):
                   notmuch database has been modified by another program
                   in the meantime. In this case, you should close and
                   reopen the database and retry.
                   notmuch database has been modified by another program
                   in the meantime. In this case, you should close and
                   reopen the database and retry.

-
-             :exc:`NotInitializedError` if
+            :exc:`NotInitializedError` if

                     the database was not intitialized.
         """
         self._assert_db_is_initialized()
                     the database was not intitialized.
         """
         self._assert_db_is_initialized()


@@ -455,8 +444,7 @@ class Database(object):
                   notmuch database has been modified by another program
                   in the meantime. In this case, you should close and
                   reopen the database and retry.
                   notmuch database has been modified by another program
                   in the meantime. In this case, you should close and
                   reopen the database and retry.

-
-             :exc:`NotInitializedError` if
+            :exc:`NotInitializedError` if

                     the database was not intitialized.
 
         *Added in notmuch 0.9*"""
                     the database was not intitialized.
 
         *Added in notmuch 0.9*"""


@@ -498,7 +486,6 @@ 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.
         """

-        self._assert_db_is_initialized()

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


@@ -539,11 +526,12 @@ class Query(object):
     A query selects and filters a subset of messages from the notmuch
     database we derive from.
 
     A query selects and filters a subset of messages from the notmuch
     database we derive from.
 

-    Query() provides an instance attribute :attr:`sort`, which
+    :class:`Query` provides an instance attribute :attr:`sort`, which

     contains the sort order (if specified via :meth:`set_sort`) or
     `None`.
 
     contains the sort order (if specified via :meth:`set_sort`) or
     `None`.
 

-    Technically, it wraps the underlying *notmuch_query_t* struct.
+    Any function in this class may throw an :exc:`NotInitializedError`
+    in case the underlying query object was not set up correctly.

 
     .. note:: Do remember that as soon as we tear down this object,
            all underlying derived objects such as threads,
 
     .. note:: Do remember that as soon as we tear down this object,
            all underlying derived objects such as threads,


@@ -583,6 +571,11 @@ class Query(object):
         self.sort = None
         self.create(db, querystr)
 
         self.sort = None
         self.create(db, querystr)
 

+    def _assert_query_is_initialized(self):
+        """Raises :exc:`NotInitializedError` if self._query is `None`"""
+        if self._query is None:
+            raise NotInitializedError()
+

     def create(self, db, querystr):
         """Creates a new query derived from a Database
 
     def create(self, db, querystr):
         """Creates a new query derived from a Database
 


@@ -594,35 +587,27 @@ class Query(object):
         :param querystr: The query string
         :type querystr: utf-8 encoded str or unicode
         :returns: Nothing
         :param querystr: The query string
         :type querystr: utf-8 encoded str or unicode
         :returns: Nothing

-        :exception: :exc:`NotmuchError`
-
-                      * :attr:`STATUS`.NOT_INITIALIZED if db is not inited
-                      * :attr:`STATUS`.NULL_POINTER if the query creation failed
-                        (too little memory)
+        :exception:
+            :exc:`NullPointerError` if the query creation failed
+                (e.g. too little memory).
+            :exc:`NotInitializedError` if the underlying db was not
+                intitialized.

         """
         """

-        if db.db_p is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
+        db._assert_db_is_initialized()

         # create reference to parent db to keep it alive
         self._db = db
         # create query, return None if too little mem available
         query_p = Query._create(db.db_p, _str(querystr))
         if query_p is None:
         # create reference to parent db to keep it alive
         self._db = db
         # create query, return None if too little mem available
         query_p = Query._create(db.db_p, _str(querystr))
         if query_p is None:

-            raise NotmuchError(STATUS.NULL_POINTER)
+            raise NullPointerError

         self._query = query_p
 
     def set_sort(self, sort):
         """Set the sort order future results will be delivered in
 
         self._query = query_p
 
     def set_sort(self, sort):
         """Set the sort order future results will be delivered in
 

-        Wraps the underlying *notmuch_query_set_sort* function.
-

         :param sort: Sort order (see :attr:`Query.SORT`)
         :param sort: Sort order (see :attr:`Query.SORT`)

-        :returns: Nothing
-        :exception: :exc:`NotmuchError` :attr:`STATUS`.NOT_INITIALIZED if query has not
-                    been initialized.

         """
         """

-        if self._query is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+        self._assert_query_is_initialized()

         self.sort = sort
         nmlib.notmuch_query_set_sort(self._query, sort)
 
         self.sort = sort
         nmlib.notmuch_query_set_sort(self._query, sort)
 


@@ -637,46 +622,28 @@ class Query(object):
         match the query. The method :meth:`Message.get_flag` allows us
         to get the value of this flag.
 
         match the query. The method :meth:`Message.get_flag` allows us
         to get the value of this flag.
 

-        Technically, it wraps the underlying
-        *notmuch_query_search_threads* function.
-

         :returns: :class:`Threads`
         :returns: :class:`Threads`

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

         """
         """

-        if self._query is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+        self._assert_query_is_initialized()

         threads_p = Query._search_threads(self._query)
 
         if threads_p is None:
         threads_p = Query._search_threads(self._query)
 
         if threads_p is None:

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

         return Threads(threads_p, self)
 
     def search_messages(self):
         """Filter messages according to the query and return
         :class:`Messages` in the defined sort order
 
         return Threads(threads_p, self)
 
     def search_messages(self):
         """Filter messages according to the query and return
         :class:`Messages` in the defined sort order
 

-        Technically, it wraps the underlying
-        *notmuch_query_search_messages* function.
-

         :returns: :class:`Messages`
         :returns: :class:`Messages`

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

         """
         """

-        if self._query is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+        self._assert_query_is_initialized()

         msgs_p = Query._search_messages(self._query)
 
         if msgs_p is None:
         msgs_p = Query._search_messages(self._query)
 
         if msgs_p is None:

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

         return Messages(msgs_p, self)
 
     def count_messages(self):
         return Messages(msgs_p, self)
 
     def count_messages(self):


@@ -690,13 +657,8 @@ class Query(object):
         *notmuch_query_count_messages* function.
 
         :returns: :class:`Messages`
         *notmuch_query_count_messages* function.
 
         :returns: :class:`Messages`

-        :exception: :exc:`NotmuchError`
-
-                      * :attr:`STATUS`.NOT_INITIALIZED if query is not inited

         """
         """

-        if self._query is None:
-            raise NotmuchError(STATUS.NOT_INITIALIZED)
-
+        self._assert_query_is_initialized()

         return Query._count_messages(self._query)
 
     def __del__(self):
         return Query._count_messages(self._query)
 
     def __del__(self):