BulkResponse: Be more strict on empty records or results

Author: amotl

src/crate/client/result.py

@@ -20,8 +20,12 @@ class BulkResponse:
 
     def __init__(
             self,
-            records: t.Union[t.Iterable[t.Dict[str, t.Any]], None],
-            results: t.Union[t.Iterable[BulkResultItem], None]):
+            records: t.List[t.Dict[str, t.Any]],
+            results: t.List[BulkResultItem]):
+        if records is None:
+            raise ValueError("Processing a bulk response without records is an invalid operation")
+        if results is None:
+            raise ValueError("Processing a bulk response without results is an invalid operation")
         self.records = records
         self.results = results
 
@@ -34,8 +38,6 @@ def failed_records(self) -> t.List[t.Dict[str, t.Any]]:
 
         https://cratedb.com/docs/crate/reference/en/latest/interfaces/http.html#error-handling
         """
-        if self.records is None or self.results is None:
-            return []
         errors: t.List[t.Dict[str, t.Any]] = []
         for record, status in zip(self.records, self.results):
             if status["rowcount"] == -2:

src/crate/client/test_result.py

@@ -68,3 +68,21 @@ def test_executemany_empty(self):
 
         cursor.close()
         connection.close()
+
+    @unittest.skipIf(sys.version_info < (3, 8), "BulkResponse needs Python 3.8 or higher")
+    def test_bulk_response_empty_records_or_results(self):
+
+        # Import at runtime is on purpose, to permit skipping the test case.
+        from crate.client.result import BulkResponse
+
+        with self.assertRaises(ValueError) as cm:
+            BulkResponse(records=None, results=None)
+        self.assertEqual(
+            str(cm.exception),
+            "Processing a bulk response without records is an invalid operation")
+
+        with self.assertRaises(ValueError) as cm:
+            BulkResponse(records=[], results=None)
+        self.assertEqual(
+            str(cm.exception),
+            "Processing a bulk response without results is an invalid operation")