]> git.notmuchmail.org Git - notmuch/blobdiff - bindings/python/notmuch/query.py
lib: replace deprecated n_q_count_threads with status returning version
[notmuch] / bindings / python / notmuch / query.py
index 4abba5bdcd165fa277e60c5fc6593c2a2bc84d91..06c7b11bb8648de7488092c6c2d63efed3e13bf0 100644 (file)
@@ -12,12 +12,12 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 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/>.
+along with notmuch.  If not, see <https://www.gnu.org/licenses/>.
 
 Copyright 2010 Sebastian Spaeth <Sebastian@SSpaeth.de>
 """
 
-from ctypes import c_char_p, c_uint
+from ctypes import c_char_p, c_uint, POINTER, byref
 from .globals import (
     nmlib,
     Enum,
@@ -28,6 +28,7 @@ from .globals import (
     NotmuchMessagesP,
 )
 from .errors import (
+    NotmuchError,
     NullPointerError,
     NotInitializedError,
 )
@@ -100,7 +101,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
@@ -118,10 +119,25 @@ 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]
-    _search_threads.restype = NotmuchThreadsP
+    _search_threads.argtypes = [NotmuchQueryP, POINTER(NotmuchThreadsP)]
+    _search_threads.restype = c_uint
 
     def search_threads(self):
         """Execute a query for threads
@@ -138,16 +154,19 @@ class Query(object):
         :raises: :exc:`NullPointerError` if search_threads failed
         """
         self._assert_query_is_initialized()
-        threads_p = Query._search_threads(self._query)
+        threads_p = NotmuchThreadsP() # == NULL
+        status = Query._search_threads(self._query, byref(threads_p))
+        if status != 0:
+            raise NotmuchError(status)
 
         if not threads_p:
             raise NullPointerError
         return Threads(threads_p, self)
 
-    """notmuch_query_search_messages"""
+    """notmuch_query_search_messages_st"""
     _search_messages = nmlib.notmuch_query_search_messages
-    _search_messages.argtypes = [NotmuchQueryP]
-    _search_messages.restype = NotmuchMessagesP
+    _search_messages.argtypes = [NotmuchQueryP, POINTER(NotmuchMessagesP)]
+    _search_messages.restype = c_uint
 
     def search_messages(self):
         """Filter messages according to the query and return
@@ -157,14 +176,17 @@ class Query(object):
         :raises: :exc:`NullPointerError` if search_messages failed
         """
         self._assert_query_is_initialized()
-        msgs_p = Query._search_messages(self._query)
+        msgs_p = NotmuchMessagesP() # == NULL
+        status = Query._search_messages(self._query, byref(msgs_p))
+        if status != 0:
+            raise NotmuchError(status)
 
         if not msgs_p:
             raise NullPointerError
         return Messages(msgs_p, self)
 
     _count_messages = nmlib.notmuch_query_count_messages
-    _count_messages.argtypes = [NotmuchQueryP]
+    _count_messages.argtypes = [NotmuchQueryP, POINTER(c_uint)]
     _count_messages.restype = c_uint
 
     def count_messages(self):
@@ -176,10 +198,14 @@ class Query(object):
         :rtype:   int
         '''
         self._assert_query_is_initialized()
-        return Query._count_messages(self._query)
+        count = c_uint(0)
+        status = Query._count_messages(self._query, byref(count))
+        if status != 0:
+            raise NotmuchError(status)
+        return count.value
 
     _count_threads = nmlib.notmuch_query_count_threads
-    _count_threads.argtypes = [NotmuchQueryP]
+    _count_threads.argtypes = [NotmuchQueryP, POINTER(c_uint)]
     _count_threads.restype = c_uint
 
     def count_threads(self):
@@ -195,7 +221,11 @@ class Query(object):
         :rtype:   int
         '''
         self._assert_query_is_initialized()
-        return Query._count_threads(self._query)
+        count = c_uint(0)
+        status = Query._count_threads(self._query, byref(count))
+        if status != 0:
+            raise NotmuchError(status)
+        return count.value
 
     _destroy = nmlib.notmuch_query_destroy
     _destroy.argtypes = [NotmuchQueryP]