X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Fquery.py;h=94773ac508e37c6cfcd7fd68293fd637e08d3199;hb=243d7e30dcd80041760307d8d0d2a1839f36eca2;hp=14c00cd53cd64f802f6bfe39b536649e544a99cc;hpb=ff8f864245c3ac54cc23aa47af09c95cde484abb;p=notmuch

diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py
index 14c00cd5..94773ac5 100644
--- a/bindings/python/notmuch/query.py
+++ b/bindings/python/notmuch/query.py
@@ -14,11 +14,11 @@ for more details.
 You should have received a copy of the GNU General Public License
 along with notmuch.  If not, see <http://www.gnu.org/licenses/>.
 
-Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>'
+Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
 """
 
 from ctypes import c_char_p, c_uint
-from notmuch.globals import (
+from .globals import (
     nmlib,
     Enum,
     _str,
@@ -26,11 +26,13 @@ from notmuch.globals import (
     NotmuchThreadsP,
     NotmuchDatabaseP,
     NotmuchMessagesP,
+)
+from .errors import (
     NullPointerError,
     NotInitializedError,
 )
-from notmuch.thread import Threads
-from notmuch.message import Messages
+from .threads import Threads
+from .messages import Messages
 
 
 class Query(object):
@@ -70,7 +72,7 @@ class Query(object):
 
     def _assert_query_is_initialized(self):
         """Raises :exc:`NotInitializedError` if self._query is `None`"""
-        if self._query is None:
+        if not self._query:
             raise NotInitializedError()
 
     """notmuch_query_create"""
@@ -88,8 +90,7 @@ class Query(object):
         :type db: :class:`Database`
         :param querystr: The query string
         :type querystr: utf-8 encoded str or unicode
-        :returns: Nothing
-        :exception:
+        :raises:
             :exc:`NullPointerError` if the query creation failed
                 (e.g. too little memory).
             :exc:`NotInitializedError` if the underlying db was not
@@ -99,7 +100,7 @@ class Query(object):
         # 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))
+        query_p = Query._create(db._db, _str(querystr))
         if not query_p:
             raise NullPointerError
         self._query = query_p
@@ -117,6 +118,21 @@ class Query(object):
         self.sort = sort
         self._set_sort(self._query, sort)
 
+    _exclude_tag = nmlib.notmuch_query_add_tag_exclude
+    _exclude_tag.argtypes = [NotmuchQueryP, c_char_p]
+    _exclude_tag.resttype = None
+
+    def exclude_tag(self, tagname):
+        """Add a tag that will be excluded from the query results by default.
+
+        This exclusion will be overridden if this tag appears explicitly in the
+        query.
+
+        :param tagname: Name of the tag to be excluded
+        """
+        self._assert_query_is_initialized()
+        self._exclude_tag(self._query, _str(tagname))
+
     """notmuch_query_search_threads"""
     _search_threads = nmlib.notmuch_query_search_threads
     _search_threads.argtypes = [NotmuchQueryP]
@@ -134,7 +150,7 @@ class Query(object):
         to get the value of this flag.
 
         :returns: :class:`Threads`
-        :exception: :exc:`NullPointerError` if search_threads failed
+        :raises: :exc:`NullPointerError` if search_threads failed
         """
         self._assert_query_is_initialized()
         threads_p = Query._search_threads(self._query)
@@ -153,7 +169,7 @@ class Query(object):
         :class:`Messages` in the defined sort order
 
         :returns: :class:`Messages`
-        :exception: :exc:`NullPointerError` if search_messages failed
+        :raises: :exc:`NullPointerError` if search_messages failed
         """
         self._assert_query_is_initialized()
         msgs_p = Query._search_messages(self._query)
@@ -162,23 +178,18 @@ class Query(object):
             raise NullPointerError
         return Messages(msgs_p, self)
 
-    """notmuch_query_count_messages"""
     _count_messages = nmlib.notmuch_query_count_messages
     _count_messages.argtypes = [NotmuchQueryP]
     _count_messages.restype = c_uint
 
     def count_messages(self):
-        """Estimate the number of messages matching the query
-
+        '''
         This function performs a search and returns Xapian's best
-        guess as to the number of matching messages. It is much faster
-        than performing :meth:`search_messages` and counting the
-        result with `len()` (although it always returned the same
-        result in my tests). Technically, it wraps the underlying
-        *notmuch_query_count_messages* function.
+        guess as to the number of matching messages.
 
-        :returns: :class:`Messages`
-        """
+        :returns: the estimated number of messages matching this query
+        :rtype:   int
+        '''
         self._assert_query_is_initialized()
         return Query._count_messages(self._query)
 
@@ -207,5 +218,5 @@ class Query(object):
 
     def __del__(self):
         """Close and free the Query"""
-        if self._query is not None:
+        if self._query:
             self._destroy(self._query)