diff options
Diffstat (limited to 'bindings')
| -rw-r--r-- | bindings/python/docs/source/index.rst | 2 | ||||
| -rw-r--r-- | bindings/python/notmuch/query.py | 19 |
2 files changed, 21 insertions, 0 deletions
diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index f7d3d605..5405de8e 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -128,6 +128,8 @@ More information on specific topics can be found on the following pages: .. automethod:: count_messages + .. automethod:: count_threads + :class:`Messages` -- A bunch of messages ---------------------------------------- diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py index d4a93d5b..14c00cd5 100644 --- a/bindings/python/notmuch/query.py +++ b/bindings/python/notmuch/query.py @@ -182,6 +182,25 @@ class Query(object): self._assert_query_is_initialized() return Query._count_messages(self._query) + _count_threads = nmlib.notmuch_query_count_threads + _count_threads.argtypes = [NotmuchQueryP] + _count_threads.restype = c_uint + + def count_threads(self): + ''' + This function performs a search and returns the number of + unique thread IDs in the matching messages. This is the same + as number of threads matching a search. + + Note that this is a significantly heavier operation than + meth:`Query.count_messages`. + + :returns: the number of threads returned by this query + :rtype: int + ''' + self._assert_query_is_initialized() + return Query._count_threads(self._query) + _destroy = nmlib.notmuch_query_destroy _destroy.argtypes = [NotmuchQueryP] _destroy.restype = None |