bindings/python-cffi: handle NOTMUCH_STATUS_OPERATION_INVALIDATED

Raise it as a newly added OperationInvalidatedError exception.

diff --git a/bindings/python-cffi/notmuch2/_base.py b/bindings/python-cffi/notmuch2/_base.py
index 1b0b5b7e1e1f0d0e350e97ee6e9cbed0a1595494..1748c3728ef92dac9326189ab6e0487fcf2da199 100644 (file)
--- a/bindings/python-cffi/notmuch2/_base.py
+++ b/bindings/python-cffi/notmuch2/_base.py
@@ -176,17 +176,25 @@ class NotmuchIter(NotmuchObject, collections.abc.Iterator):
     :type iter_p: cffi.cdata
     :param fn_destroy: The CFFI notmuch_*_destroy function.
     :param fn_valid: The CFFI notmuch_*_valid function.
     :type iter_p: cffi.cdata
     :param fn_destroy: The CFFI notmuch_*_destroy function.
     :param fn_valid: The CFFI notmuch_*_valid function.

+    :param fn_status: The CFFI notmuch_*_status function. Exactly one of
+       fn_valid or fn_status must be provided, the other one must be None.

     :param fn_get: The CFFI notmuch_*_get function.
     :param fn_next: The CFFI notmuch_*_move_to_next function.
     """
     _iter_p = MemoryPointer()
 
     def __init__(self, parent, iter_p,
     :param fn_get: The CFFI notmuch_*_get function.
     :param fn_next: The CFFI notmuch_*_move_to_next function.
     """
     _iter_p = MemoryPointer()
 
     def __init__(self, parent, iter_p,

-                 *, fn_destroy, fn_valid, fn_get, fn_next):
+                 *, fn_destroy, fn_valid, fn_get, fn_next,
+                 fn_status = None):
+        # exactly one of those must be provided
+        assert((fn_valid  and not fn_status) or
+               (fn_status and not fn_valid))
+

         self._parent = parent
         self._iter_p = iter_p
         self._fn_destroy = fn_destroy
         self._fn_valid = fn_valid
         self._parent = parent
         self._iter_p = iter_p
         self._fn_destroy = fn_destroy
         self._fn_valid = fn_valid

+        self._fn_status = fn_status

         self._fn_get = fn_get
         self._fn_next = fn_next
 
         self._fn_get = fn_get
         self._fn_next = fn_next
 


@@ -212,6 +220,18 @@ class NotmuchIter(NotmuchObject, collections.abc.Iterator):
                 pass
         self._iter_p = None
 
                 pass
         self._iter_p = None
 

+    def _check_status(self):
+        if self._fn_valid:
+            # fall back on fn_valid for iterators that do not implement fn_status
+            if not self._fn_valid(self._iter_p):
+                raise StopIteration
+        else:
+            status = self._fn_status(self._iter_p)
+            if status == capi.lib.NOTMUCH_STATUS_ITERATOR_EXHAUSTED:
+                raise StopIteration
+            elif status != capi.lib.NOTMUCH_STATUS_SUCCESS:
+                raise errors.NotmuchError(status)
+

     def __iter__(self):
         """Return the iterator itself.
 
     def __iter__(self):
         """Return the iterator itself.
 


@@ -222,9 +242,11 @@ class NotmuchIter(NotmuchObject, collections.abc.Iterator):
         return self
 
     def __next__(self):
         return self
 
     def __next__(self):

-        if not self._fn_valid(self._iter_p):
-            raise StopIteration()
+        self._check_status()

         obj_p = self._fn_get(self._iter_p)
         obj_p = self._fn_get(self._iter_p)

+        if obj_p == capi.ffi.NULL:
+            self._check_status()
+            raise StopIteration

         self._fn_next(self._iter_p)
         return obj_p
 
         self._fn_next(self._iter_p)
         return obj_p
 

diff --git a/bindings/python-cffi/notmuch2/_build.py b/bindings/python-cffi/notmuch2/_build.py
index 0429691a1453059ab478d0b897877e76a71a0f76..2f3152c69702709ee48fdc9c8b328aa7823370cc 100644 (file)
--- a/bindings/python-cffi/notmuch2/_build.py
+++ b/bindings/python-cffi/notmuch2/_build.py
@@ -56,6 +56,8 @@ ffibuilder.cdef(
         NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
         NOTMUCH_STATUS_NO_MAIL_ROOT,
         NOTMUCH_STATUS_CLOSED_DATABASE,
         NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
         NOTMUCH_STATUS_NO_MAIL_ROOT,
         NOTMUCH_STATUS_CLOSED_DATABASE,

+        NOTMUCH_STATUS_ITERATOR_EXHAUSTED,
+        NOTMUCH_STATUS_OPERATION_INVALIDATED,

         NOTMUCH_STATUS_LAST_STATUS
     } notmuch_status_t;
     typedef enum {
         NOTMUCH_STATUS_LAST_STATUS
     } notmuch_status_t;
     typedef enum {


@@ -187,6 +189,8 @@ ffibuilder.cdef(
 
     notmuch_bool_t
     notmuch_threads_valid (notmuch_threads_t *threads);
 
     notmuch_bool_t
     notmuch_threads_valid (notmuch_threads_t *threads);

+    notmuch_status_t
+    notmuch_threads_status (notmuch_threads_t *threads);

     notmuch_thread_t *
     notmuch_threads_get (notmuch_threads_t *threads);
     void
     notmuch_thread_t *
     notmuch_threads_get (notmuch_threads_t *threads);
     void


@@ -221,6 +225,8 @@ ffibuilder.cdef(
 
     notmuch_bool_t
     notmuch_messages_valid (notmuch_messages_t *messages);
 
     notmuch_bool_t
     notmuch_messages_valid (notmuch_messages_t *messages);

+    notmuch_status_t
+    notmuch_messages_status (notmuch_messages_t *messages);

     notmuch_message_t *
     notmuch_messages_get (notmuch_messages_t *messages);
     void
     notmuch_message_t *
     notmuch_messages_get (notmuch_messages_t *messages);
     void

diff --git a/bindings/python-cffi/notmuch2/_errors.py b/bindings/python-cffi/notmuch2/_errors.py
index 17c3ad9cc39af7cf565f66aae9570bcba22a8f9c..483e794b4df203b697ca6706b8ac66140a7649fe 100644 (file)
--- a/bindings/python-cffi/notmuch2/_errors.py
+++ b/bindings/python-cffi/notmuch2/_errors.py
@@ -28,6 +28,8 @@ class NotmuchError(Exception):
                 ReadOnlyDatabaseError,
             capi.lib.NOTMUCH_STATUS_XAPIAN_EXCEPTION:
                 XapianError,
                 ReadOnlyDatabaseError,
             capi.lib.NOTMUCH_STATUS_XAPIAN_EXCEPTION:
                 XapianError,

+            capi.lib.NOTMUCH_STATUS_OPERATION_INVALIDATED:
+                OperationInvalidatedError,

             capi.lib.NOTMUCH_STATUS_FILE_ERROR:
                 FileError,
             capi.lib.NOTMUCH_STATUS_FILE_NOT_EMAIL:
             capi.lib.NOTMUCH_STATUS_FILE_ERROR:
                 FileError,
             capi.lib.NOTMUCH_STATUS_FILE_NOT_EMAIL:


@@ -92,6 +94,7 @@ class NotmuchError(Exception):
 class OutOfMemoryError(NotmuchError): pass
 class ReadOnlyDatabaseError(NotmuchError): pass
 class XapianError(NotmuchError): pass
 class OutOfMemoryError(NotmuchError): pass
 class ReadOnlyDatabaseError(NotmuchError): pass
 class XapianError(NotmuchError): pass

+class OperationInvalidatedError(XapianError): pass

 class FileError(NotmuchError): pass
 class FileNotEmailError(NotmuchError): pass
 class DuplicateMessageIdError(NotmuchError): pass
 class FileError(NotmuchError): pass
 class FileNotEmailError(NotmuchError): pass
 class DuplicateMessageIdError(NotmuchError): pass

diff --git a/bindings/python-cffi/notmuch2/_message.py b/bindings/python-cffi/notmuch2/_message.py
index 794852389fe70262e9502fe735733db41725fc6c..e31e0c3c1bbe66c8d9581a38e1e527a709dc10c5 100644 (file)
--- a/bindings/python-cffi/notmuch2/_message.py
+++ b/bindings/python-cffi/notmuch2/_message.py
@@ -707,7 +707,8 @@ class MessageIter(base.NotmuchIter):
         self._msg_cls = msg_cls
         super().__init__(parent, msgs_p,
                          fn_destroy=capi.lib.notmuch_messages_destroy,
         self._msg_cls = msg_cls
         super().__init__(parent, msgs_p,
                          fn_destroy=capi.lib.notmuch_messages_destroy,

-                         fn_valid=capi.lib.notmuch_messages_valid,
+                         fn_valid=None,
+                         fn_status=capi.lib.notmuch_messages_status,

                          fn_get=capi.lib.notmuch_messages_get,
                          fn_next=capi.lib.notmuch_messages_move_to_next)
 
                          fn_get=capi.lib.notmuch_messages_get,
                          fn_next=capi.lib.notmuch_messages_move_to_next)
 

diff --git a/bindings/python-cffi/notmuch2/_thread.py b/bindings/python-cffi/notmuch2/_thread.py
index e883f3082b8b9bc5fb086c180e3e910e4e72ccf6..af49d2bf5c444f0cc707324f02aba7dab2534b29 100644 (file)
--- a/bindings/python-cffi/notmuch2/_thread.py
+++ b/bindings/python-cffi/notmuch2/_thread.py
@@ -185,7 +185,8 @@ class ThreadIter(base.NotmuchIter):
         self._db = db
         super().__init__(parent, threads_p,
                          fn_destroy=capi.lib.notmuch_threads_destroy,
         self._db = db
         super().__init__(parent, threads_p,
                          fn_destroy=capi.lib.notmuch_threads_destroy,

-                         fn_valid=capi.lib.notmuch_threads_valid,
+                         fn_valid=None,
+                         fn_status=capi.lib.notmuch_threads_status,

                          fn_get=capi.lib.notmuch_threads_get,
                          fn_next=capi.lib.notmuch_threads_move_to_next)
 
                          fn_get=capi.lib.notmuch_threads_get,
                          fn_next=capi.lib.notmuch_threads_move_to_next)
 

diff --git a/bindings/python-cffi/tests/test_database.py b/bindings/python-cffi/tests/test_database.py
index 1143cf33bc3cd27b2c08f99ab03c23c3a453c450..ece838ee6c84cd6a602737ed0594adf422b2aeb4 100644 (file)
--- a/bindings/python-cffi/tests/test_database.py
+++ b/bindings/python-cffi/tests/test_database.py
@@ -322,6 +322,41 @@ class TestQuery:
         with dbmod.Database(maildir.path, 'rw', config=notmuch2.Database.CONFIG.EMPTY) as db:
             yield db
 
         with dbmod.Database(maildir.path, 'rw', config=notmuch2.Database.CONFIG.EMPTY) as db:
             yield db
 

+    def _db_modified(self, maildir, notmuch, ret_prepare=None):
+        # populate the database for the initial query
+        with dbmod.Database.create(maildir.path, config=notmuch2.Database.CONFIG.EMPTY) as db:
+            for i in range(32):
+                pathname = maildir.deliver(body = str(i))[1]
+                msg = db.add(str(pathname))[0]
+                msg.tags.add(str(i))
+
+        with dbmod.Database(maildir.path, 'ro', config=notmuch2.Database.CONFIG.EMPTY) as db:
+            # prepare value to be returned to caller
+            ret = ret_prepare(db) if ret_prepare else db
+
+            # modify the database sufficiently to trigger DatabaseModifiedException
+            for i in range(16):
+                with dbmod.Database(maildir.path, 'rw', config=notmuch2.Database.CONFIG.EMPTY) as db_rw:
+                    pathname = maildir.deliver(body = str(i))[1]
+                    db_rw.add(str(pathname))
+
+            yield ret
+
+    @pytest.fixture
+    def db_modified(self, maildir, notmuch):
+        "A db triggering DatabaseModifiedException."
+        yield from self._db_modified(maildir, notmuch)
+
+    @pytest.fixture
+    def db_modified_messages(self, maildir, notmuch):
+        "A tuple of (db, messages) triggering DatabaseModifiedException."
+        yield from self._db_modified(maildir, notmuch, lambda db: (db, db.messages('*')))
+
+    @pytest.fixture
+    def db_modified_threads(self, maildir, notmuch):
+        "A tuple of (db, threads) triggering DatabaseModifiedException."
+        yield from self._db_modified(maildir, notmuch, lambda db: (db, db.threads('*')))
+

     def test_count_messages(self, db):
         assert db.count_messages('*') == 3
 
     def test_count_messages(self, db):
         assert db.count_messages('*') == 3
 


@@ -397,3 +432,52 @@ class TestQuery:
             assert isinstance(msg, notmuch2.Message)
             assert msg.alive
             del msg
             assert isinstance(msg, notmuch2.Message)
             assert msg.alive
             del msg

+
+    def test_operation_invalidated_query(self, db_modified):
+        # Test OperationInvalidatedError raised by instantiating the query.
+        for attempt in 1, 2:
+            try:
+                for msg in db_modified.messages('*'):
+                    pass
+                break
+            except notmuch2.OperationInvalidatedError:
+                if attempt == 1:
+                    db_modified.reopen()
+                    continue
+
+                raise
+
+    def test_operation_invalidated_messages(self, db_modified_messages):
+        # Test OperationInvalidatedError raised by iterating over query results;
+        # the query itself is created while the database is still usable.
+        db, messages = db_modified_messages
+
+        for attempt in 1, 2:
+            try:
+                for msg in messages:
+                    pass
+                break
+            except notmuch2.OperationInvalidatedError:
+                if attempt == 1:
+                    db.reopen()
+                    messages = db.messages('*')
+                    continue
+
+                raise
+
+    def test_operation_invalidated_threads(self, db_modified_threads):
+        db, threads = db_modified_threads
+
+        for attempt in 1, 2:
+            try:
+                for t in threads:
+                    for msg in t:
+                        pass
+                break
+            except notmuch2.OperationInvalidatedError:
+                if attempt == 1:
+                    db.reopen()
+                    threads = db.threads('*')
+                    continue
+
+                raise