Adding get_many method

Author: apetenchea

arangoasync/collection.py

@@ -1,7 +1,7 @@
 __all__ = ["Collection", "StandardCollection"]
 
 
-from typing import Generic, List, Optional, Tuple, TypeVar, cast
+from typing import Generic, List, Optional, Sequence, Tuple, TypeVar, cast
 
 from arangoasync.errno import (
     DOCUMENT_NOT_FOUND,
@@ -889,3 +889,55 @@ def response_handler(resp: Response) -> bool | Json:
             raise DocumentDeleteError(resp, request, msg)
 
         return await self._executor.execute(request, response_handler)
+
+    async def get_many(
+        self,
+        documents: Sequence[str | Json],
+        allow_dirty_read: Optional[bool] = None,
+        ignore_revs: Optional[bool] = None,
+    ) -> Result[V]:
+        """Return multiple documents ignoring any missing ones.
+
+        Args:
+            documents (list): List of document IDs, keys or bodies. A search document
+                must contain at least a value for the `_key` field. A value for `_rev`
+                may be specified to verify whether the document has the same revision
+                value, unless `ignoreRevs` is set to false.
+            allow_dirty_read (bool | None): Allow reads from followers in a cluster.
+            ignore_revs (bool | None): If set to `True`, the `_rev` attribute in the
+                document is ignored. If this is set to `False`, then the `_rev`
+                attribute given in the body document is taken as a precondition.
+                The document is only replaced if the current revision is the one
+                specified.
+
+        Returns:
+            list: List of documents. Missing ones are not included.
+
+        Raises:
+            DocumentGetError: If retrieval fails.
+
+        References:
+            - `get-multiple-documents <https://docs.arangodb.com/stable/develop/http-api/documents/#get-multiple-documents>`__
+        """  # noqa: E501
+        params: Params = {"onlyget": True}
+        if ignore_revs is not None:
+            params["ignoreRevs"] = ignore_revs
+
+        headers: RequestHeaders = {}
+        if allow_dirty_read is not None:
+            headers["x-arango-allow-dirty-read"] = allow_dirty_read
+
+        request = Request(
+            method=Method.PUT,
+            endpoint=f"/_api/document/{self.name}",
+            params=params,
+            headers=headers,
+            data=self.serializer.dumps(documents),
+        )
+
+        def response_handler(resp: Response) -> V:
+            if not resp.is_success:
+                raise DocumentGetError(resp, request)
+            return self._doc_deserializer.loads_many(resp.raw_body)
+
+        return await self._executor.execute(request, response_handler)

arangoasync/serialization.py

@@ -9,7 +9,7 @@
 
 import json
 from abc import ABC, abstractmethod
-from typing import Generic, TypeVar
+from typing import Generic, Sequence, TypeVar
 
 from arangoasync.exceptions import DeserializationError, SerializationError
 from arangoasync.typings import Json, Jsons
@@ -26,7 +26,7 @@ class Serializer(ABC, Generic[T]):  # pragma: no cover
     """
 
     @abstractmethod
-    def dumps(self, data: T) -> str:
+    def dumps(self, data: str | bool | T | Sequence[T | str]) -> str:
         """Serialize any generic data.
 
         Args:

tests/test_document.py

@@ -1,3 +1,5 @@
+import asyncio
+
 import pytest
 
 from arangoasync.exceptions import (
@@ -200,3 +202,35 @@ async def test_document_has(doc_col, bad_col, docs):
         await doc_col.has(inserted["_id"], if_none_match=inserted["_rev"])
     with pytest.raises(DocumentRevisionError):
         await doc_col.has(inserted["_id"], if_match="foobar")
+
+
+@pytest.mark.asyncio
+async def test_document_get_many(doc_col, bad_col, docs):
+    # Test with invalid collection
+    with pytest.raises(DocumentGetError):
+        await bad_col.get_many(["non-existent"])
+
+    # Insert all documents first
+    await asyncio.gather(*[doc_col.insert(doc) for doc in docs])
+
+    # Test with good keys
+    many = await doc_col.get_many([doc["_key"] for doc in docs])
+    assert len(many) == len(docs)
+
+    # Test with full documents
+    many = await doc_col.get_many(docs)
+    assert len(many) == len(docs)
+
+    # Revs
+    bad_rev = many
+    bad_rev[0]["_rev"] = "foobar"
+    many = await doc_col.get_many([bad_rev[0]], ignore_revs=True)
+    assert len(many) == 1
+    assert "error" not in many[0]
+    many = await doc_col.get_many([bad_rev[0]], ignore_revs=False)
+    assert len(many) == 1
+    assert "error" in many[0]
+
+    # Empty list
+    many = await doc_col.get_many([])
+    assert len(many) == 0