new: raise_on_document_error param for collection.update_many (#273)

Author: aMahanna

arango/collection.py

@@ -1590,6 +1590,7 @@ def update_many(
         sync: Optional[bool] = None,
         silent: bool = False,
         refill_index_caches: Optional[bool] = None,
+        raise_on_document_error: bool = False,
     ) -> Result[Union[bool, List[Union[Json, ArangoServerError]]]]:
         """Update multiple documents.
 
@@ -1599,7 +1600,8 @@ def update_many(
             returned as an object in the result list. It is up to you to
             inspect the list to determine which documents were updated
             successfully (returns document metadata) and which were not
-            (returns exception object).
+            (returns exception object). Alternatively, you can rely on
+            setting **raise_on_document_error** to True (defaults to False).
 
         .. note::
 
@@ -1636,6 +1638,11 @@ def update_many(
             index caches if document operations affect the edge index or
             cache-enabled persistent indexes.
         :type refill_index_caches: bool | None
+        :param raise_on_document_error: Whether to raise if a DocumentRevisionError
+            or a DocumentUpdateError is encountered on an individual document,
+            as opposed to returning the error as an object in the result list.
+            Defaults to False.
+        :type raise_on_document_error: bool
         :return: List of document metadata (e.g. document keys, revisions) and
             any exceptions, or True if parameter **silent** was set to True.
         :rtype: [dict | ArangoError] | bool
@@ -1689,6 +1696,9 @@ def response_handler(
                     else:  # pragma: no cover
                         error = DocumentUpdateError(sub_resp, request)
 
+                    if raise_on_document_error:
+                        raise error
+
                     results.append(error)
 
             return results

tests/test_document.py

@@ -631,6 +631,17 @@ def test_document_update_many(col, bad_col, docs):
         bad_col.update_many([{}])
     assert str(err.value) == 'field "_key" or "_id" required'
 
+    # Test update_many with raise on document error (revision)
+    with assert_raises(DocumentRevisionError) as err:
+        # Raises: [HTTP 202][ERR 1200] conflict, _rev values do not match
+        col.update_many(docs, raise_on_document_error=True)
+
+    # Test update_many with raise on document error (update)
+    with assert_raises(DocumentUpdateError) as err:
+        # Raises: [HTTP 202][ERR 1202] document not found
+        bad_docs = [{"_key": "unknown_doc", "foo": "bar"}]
+        col.update_many(bad_docs, raise_on_document_error=True)
+
 
 def test_document_update_match(col, bad_col, docs):
     # Set up test documents