debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-25 10:54:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: improve Query.count_messages docstring

Browse source 
Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2012-02-18 01:38:19 +01:00
parent ff8f864245
commit bf6039e34e
1 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
bindings/python/notmuch/query.py
View file

@ -162,23 +162,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)