Make Cursor.close return None when ID is not set

Author: joowani

arango/cursor.py

@@ -283,13 +283,15 @@ def close(self, ignore_missing=False):
         :param ignore_missing: Do not raise exception on missing cursors.
         :type ignore_missing: bool
         :return: True if cursor was closed successfully, False if cursor was
-            not found and **ignore_missing** was set to True.
-        :rtype: bool
+            missing on the server and **ignore_missing** was set to True, None
+            if there are no cursors to close server-side (e.g. result set is
+            smaller than the batch size, or in transactions).
+        :rtype: bool | None
         :raise arango.exceptions.CursorCloseError: If operation fails.
         :raise arango.exceptions.CursorStateError: If cursor ID is not set.
         """
         if self._id is None:
-            raise CursorStateError('cursor ID not set')
+            return None
         request = Request(
             method='delete',
             endpoint='/_api/{}/{}'.format(self._type, self._id)

arango/version.py

@@ -1 +1 @@
-__version__ = '4.2.0'
+__version__ = '4.2.1'

tests/test_aql.py

@@ -15,7 +15,7 @@
     AQLQueryTrackingSetError,
     AQLQueryKillError,
     AQLQueryValidateError,
-    CursorStateError)
+)
 from tests.helpers import assert_raises, extract
 
 
@@ -114,9 +114,7 @@ def test_aql_query_management(db, bad_db, col, docs):
         assert cursor.profile() is None
         assert cursor.warnings() is None
         assert extract('_key', cursor) == extract('_key', docs)
-        with assert_raises(CursorStateError) as err:
-            cursor.close()
-        assert err.value.message == 'cursor ID not set'
+        assert cursor.close() is None
     else:
         assert cursor.id is not None
         assert cursor.type == 'cursor'

tests/test_cursor.py

@@ -183,14 +183,12 @@ def test_cursor_invalid_id(db, col):
         cursor.next()
     assert err.value.message == 'cursor ID not set'
 
-    with pytest.raises(CursorStateError) as err:
-        cursor.close()
-    assert err.value.message == 'cursor ID not set'
-
     with pytest.raises(CursorStateError) as err:
         cursor.fetch()
     assert err.value.message == 'cursor ID not set'
 
+    assert cursor.close() is None
+
 
 def test_cursor_premature_close(db, col, docs):
     cursor = db.aql.execute(