Merge branch 'main' into support-overload-control

Author: apetenchea

.github/workflows/build.yaml

@@ -13,11 +13,11 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11.1"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout repository
@@ -28,14 +28,8 @@ jobs:
 
       - name: Create ArangoDB Docker container
         run: >
-          docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd
-          arangodb/arangodb:3.7.7 --server.jwt-secret-keyfile=/tmp/keyfile
-
-      - name: Copy Foxx service zip into ArangoDB Docker container
-        run: docker cp tests/static/service.zip arango:/tmp/service.zip
-
-      - name: Copy keyfile into ArangoDB Docker container
-        run: docker cp tests/static/keyfile arango:/tmp/keyfile
+          docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd -v "$(pwd)/tests/static/":/tests/static
+          arangodb/arangodb:3.10.6 --server.jwt-secret-keyfile=/tests/static/keyfile
 
       - name: Start ArangoDB Docker container
         run: docker start arango

.gitignore

@@ -121,3 +121,6 @@ node_modules/
 
 # setuptools_scm
 arango/version.py
+
+# test results
+*_results.txt

CHANGELOG.md

@@ -0,0 +1,7 @@
+main
+----
+
+* Adding peak_memory_usage as a new property of AQL queries, available since ArangoDB 3.11.
+
+* The explain method of AQL queries includes the "stats" field in the returned object. Note that the REST API returns
+  it separately from the "plan" field, but for now we have to merge them together to ensure backward compatibility.

CONTRIBUTING.md

@@ -13,6 +13,12 @@ Run unit tests with coverage:
 py.test --cov=arango --cov-report=html  # Open htmlcov/index.html in your browser
 ```
 
+For a more comprehensive test suite, run:
+
+```shell
+./tester.sh  # Requires docker
+```
+
 Build and test documentation:
 
 ```shell

README.md

@@ -72,6 +72,11 @@ db = client.db("test", username="root", password="passwd")
 # Create a new graph named "school".
 graph = db.create_graph("school")
 
+# Create a new EnterpriseGraph [Enterprise Edition]
+eegraph = db.create_graph(
+    name="school",
+    smart=True)
+
 # Create vertex collections for the graph.
 students = graph.create_vertex_collection("students")
 lectures = graph.create_vertex_collection("lectures")

arango/aql.py

@@ -213,11 +213,19 @@ def response_handler(resp: Response) -> Union[Json, Jsons]:
             if not resp.is_success:
                 raise AQLQueryExplainError(resp, request)
             if "plan" in resp.body:
-                plan: Json = resp.body["plan"]
-                return plan
+                result: Json = resp.body["plan"]
+                if "stats" in resp.body:
+                    result["stats"] = resp.body["stats"]
+                return result
             else:
-                plans: Jsons = resp.body["plans"]
-                return plans
+                results: Jsons = resp.body["plans"]
+                if "stats" in resp.body:
+                    # Although "plans" contains an array, "stats" is a single object.
+                    # We need to duplicate "stats" for each plan in order to preserve
+                    # the original structure.
+                    for plan in results:
+                        plan["stats"] = resp.body["stats"]
+                return results
 
         return self._execute(request, response_handler)
 

arango/backup.py

@@ -38,7 +38,7 @@ def get(self, backup_id: Optional[str] = None) -> Result[Json]:
         request = Request(
             method="post",
             endpoint="/_admin/backup/list",
-            data={} if backup_id is None else {"id": backup_id},
+            data=None if backup_id is None else {"id": backup_id},
         )
 
         def response_handler(resp: Response) -> Json:

arango/client.py

@@ -3,7 +3,7 @@
 from json import dumps, loads
 from typing import Any, Callable, Optional, Sequence, Union
 
-from pkg_resources import get_distribution
+import importlib_metadata
 
 from arango.connection import (
     BasicConnection,
@@ -127,7 +127,7 @@ def version(self) -> str:
         :return: Client version.
         :rtype: str
         """
-        version: str = get_distribution("python-arango").version
+        version: str = importlib_metadata.version("python-arango")
         return version
 
     @property

arango/collection.py

@@ -863,7 +863,7 @@ def find_in_box(
         limit: Optional[int] = None,
         index: Optional[str] = None,
     ) -> Result[Cursor]:
-        """Return all documents in an rectangular area.
+        """Return all documents in a rectangular area.
 
         :param latitude1: First latitude.
         :type latitude1: int | float

arango/formatter.py

@@ -65,6 +65,8 @@ def format_index(body: Json) -> Json:
         result["cacheEnabled"] = body["cacheEnabled"]
     if "legacyPolygons" in body:
         result["legacyPolygons"] = body["legacyPolygons"]
+    if "estimates" in body:
+        result["estimates"] = body["estimates"]
 
     return verify_format(body, result)
 
@@ -227,6 +229,8 @@ def format_collection(body: Json) -> Json:
             }
             for cv in body["computedValues"]
         ]
+    if "internalValidatorType" in body:
+        result["internal_validator_type"] = body["internalValidatorType"]
 
     return verify_format(body, result)
 
@@ -318,6 +322,10 @@ def format_aql_query(body: Json) -> Json:
         result["stream"] = body["stream"]
     if "user" in body:
         result["user"] = body["user"]
+
+    # New in 3.11
+    if "peakMemoryUsage" in body:
+        result["peak_memory_usage"] = body["peakMemoryUsage"]
     return verify_format(body, result)
 
 
@@ -393,6 +401,10 @@ def format_server_status(body: Json) -> Json:
     """
     result: Json = {}
 
+    if "agency" in body:
+        result["agency"] = body["agency"]
+    if "coordinator" in body:
+        result["coordinator"] = body["coordinator"]
     if "foxxApi" in body:
         result["foxx_api"] = body["foxxApi"]
     if "host" in body:
@@ -985,6 +997,9 @@ def format_backup(body: Json) -> Json:
     if "nrPiecesPresent" in body:
         result["pieces_present"] = body["nrPiecesPresent"]
 
+    if "countIncludesFilesOnly" in body:
+        result["count_includes_files_only"] = body["countIncludesFilesOnly"]
+
     return verify_format(body, result)
 
 
@@ -1135,6 +1150,14 @@ def format_pregel_job_data(body: Json) -> Json:
     # The detail element was introduced in 3.10
     if "detail" in body:
         result["detail"] = body["detail"]
+    if "database" in body:
+        result["database"] = body["database"]
+    if "masterContext" in body:
+        result["master_context"] = body["masterContext"]
+    if "parallelism" in body:
+        result["parallelism"] = body["parallelism"]
+    if "useMemoryMaps" in body:
+        result["use_memory_maps"] = body["useMemoryMaps"]
 
     return verify_format(body, result)
 
@@ -1177,12 +1200,18 @@ def format_graph_properties(body: Json) -> Json:
     }
     if "isSmart" in body:
         result["smart"] = body["isSmart"]
+    if "isSatellite" in body:
+        result["is_satellite"] = body["isSatellite"]
     if "smartGraphAttribute" in body:
         result["smart_field"] = body["smartGraphAttribute"]
     if "numberOfShards" in body:
         result["shard_count"] = body["numberOfShards"]
     if "replicationFactor" in body:
         result["replication_factor"] = body["replicationFactor"]
+    if "minReplicationFactor" in body:
+        result["min_replication_factor"] = body["minReplicationFactor"]
+    if "writeConcern" in body:
+        result["write_concern"] = body["writeConcern"]
 
     return verify_format(body, result)