X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=bindings%2Fpython%2Fnotmuch%2Fquery.py;h=ddaf8e08f5651c68967096814a8c84436d8ebab6;hb=51e8e68649d97a2a4d672f9e8a1afd565589d682;hp=14c00cd53cd64f802f6bfe39b536649e544a99cc;hpb=ff8f864245c3ac54cc23aa47af09c95cde484abb;p=notmuch diff --git a/bindings/python/notmuch/query.py b/bindings/python/notmuch/query.py index 14c00cd5..ddaf8e08 100644 --- a/bindings/python/notmuch/query.py +++ b/bindings/python/notmuch/query.py @@ -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 @@ -134,7 +135,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 +154,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 +163,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)