python-arango 8.2.1__tar.gz → 8.2.2__tar.gz

{python_arango-8.2.1 → python_arango-8.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.2.1
+Version: 8.2.2
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>

{python_arango-8.2.1 → python_arango-8.2.2}/arango/backup.py

@@ -33,7 +33,7 @@ class Backup(ApiGroup):  # pragma: no cover
         :type backup_id: str
         :return: Backup details.
         :rtype: dict
-        :raise arango.exceptions.BackupGetError: If delete fails.
+        :raise arango.exceptions.BackupGetError: If the operation fails.
         """
         request = Request(
             method="post",

{python_arango-8.2.1 → python_arango-8.2.2}/arango/cluster.py

@@ -261,7 +261,7 @@ class Cluster(ApiGroup):  # pragma: no cover
 
         :return: List of endpoints.
         :rtype: [str]
-        :raise arango.exceptions.ServerEndpointsError: If retrieval fails.
+        :raise arango.exceptions.ClusterEndpointsError: If retrieval fails.
         """
         request = Request(method="get", endpoint="/_api/cluster/endpoints")
 

{python_arango-8.2.1 → python_arango-8.2.2}/arango/collection.py

@@ -537,10 +537,18 @@ class Collection(ApiGroup):
     def load(self) -> Result[bool]:
         """Load the collection into memory.
 
+        .. note::
+            The load function is deprecated from version 3.8.0 onwards and is a
+            no-op from version 3.9.0 onwards. It should no longer be used, as it
+            may be removed in a future version of ArangoDB.
+
         :return: True if collection was loaded successfully.
         :rtype: bool
         :raise arango.exceptions.CollectionLoadError: If operation fails.
         """
+        m = "The load function is deprecated from version 3.8.0 onwards and is a no-op from version 3.9.0 onwards."  # noqa: E501
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(method="put", endpoint=f"/_api/collection/{self.name}/load")
 
         def response_handler(resp: Response) -> bool:
@@ -553,10 +561,18 @@ class Collection(ApiGroup):
     def unload(self) -> Result[bool]:
         """Unload the collection from memory.
 
+        .. note::
+            The unload function is deprecated from version 3.8.0 onwards and is a
+            no-op from version 3.9.0 onwards. It should no longer be used, as it
+            may be removed in a future version of ArangoDB.
+
         :return: True if collection was unloaded successfully.
         :rtype: bool
         :raise arango.exceptions.CollectionUnloadError: If operation fails.
         """
+        m = "The unload function is deprecated from version 3.8.0 onwards and is a no-op from version 3.9.0 onwards."  # noqa: E501
+        warn(m, DeprecationWarning, stacklevel=2)
+
         request = Request(method="put", endpoint=f"/_api/collection/{self.name}/unload")
 
         def response_handler(resp: Response) -> bool:

{python_arango-8.2.1 → python_arango-8.2.2}/arango/database.py

@@ -27,6 +27,7 @@ from arango.exceptions import (
     AsyncJobListError,
     CollectionCreateError,
     CollectionDeleteError,
+    CollectionKeyGeneratorsError,
     CollectionListError,
     DatabaseCompactError,
     DatabaseCreateError,
@@ -44,6 +45,7 @@ from arango.exceptions import (
     PermissionResetError,
     PermissionUpdateError,
     ServerAvailableOptionsGetError,
+    ServerCheckAvailabilityError,
     ServerCurrentOptionsGetError,
     ServerDetailsError,
     ServerEchoError,
@@ -444,7 +446,7 @@ class Database(ApiGroup):
         :type force: bool
         :return: Server license.
         :rtype: dict
-        :raise arango.exceptions.ServerLicenseError: If retrieval fails.
+        :raise arango.exceptions.ServerLicenseSetError: If retrieval fails.
         """
         request = Request(
             method="put",
@@ -480,6 +482,25 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def check_availability(self) -> Result[str]:
+        """Return ArangoDB server availability mode.
+
+        :return: Server availability mode ("readonly" or "default").
+        :rtype: str
+        :raise arango.exceptions.ServerCheckAvailabilityError: If retrieval fails.
+        """
+        request = Request(
+            method="get",
+            endpoint="/_admin/server/availability",
+        )
+
+        def response_handler(resp: Response) -> str:
+            if not resp.is_success:
+                raise ServerCheckAvailabilityError(resp, request)
+            return str(resp.body["mode"])
+
+        return self._execute(request, response_handler)
+
     def compact(
         self,
         change_level: Optional[bool] = None,
@@ -1068,6 +1089,7 @@ class Database(ApiGroup):
 
         :return: Server metrics in Prometheus format.
         :rtype: str
+        :raise arango.exceptions.ServerMetricsError: If operation fails.
         """
         request = Request(method="get", endpoint="/_admin/metrics/v2")
 
@@ -1623,6 +1645,23 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def key_generators(self) -> Result[List[str]]:
+        """Returns the available key generators for collections.
+
+        :return: List of available key generators.
+        :rtype: [str]
+        :raise arango.exceptions.CollectionKeyGeneratorsError: If retrieval fails.
+        """  # noqa: E501
+        request = Request(method="get", endpoint="/_api/key-generators")
+
+        def response_handler(resp: Response) -> List[str]:
+            if not resp.is_success:
+                raise CollectionKeyGeneratorsError(resp, request)
+            result: List[str] = resp.body["keyGenerators"]
+            return result
+
+        return self._execute(request, response_handler)
+
     ####################
     # Graph Management #
     ####################

{python_arango-8.2.1 → python_arango-8.2.2}/arango/exceptions.py

@@ -298,6 +298,10 @@ class CollectionTruncateError(ArangoServerError):
     """Failed to truncate collection."""
 
 
+class CollectionKeyGeneratorsError(ArangoServerError):
+    """Failed to retrieve key generators."""
+
+
 class CollectionLoadError(ArangoServerError):
     """Failed to load collection."""
 
@@ -650,6 +654,10 @@ class ServerTimeError(ArangoServerError):
     """Failed to retrieve server system time."""
 
 
+class ServerCheckAvailabilityError(ArangoServerError):
+    """Failed to retrieve server availability mode."""
+
+
 class ServerEchoError(ArangoServerError):
     """Failed to retrieve details on last request."""
 

{python_arango-8.2.1 → python_arango-8.2.2}/arango/request.py

@@ -12,7 +12,7 @@ def normalize_headers(
     if driver_flags is not None:
         for flag in driver_flags:
             flags = flags + flag + ";"
-    driver_version = "8.2.1"
+    driver_version = "8.2.2"
     driver_header = "python-arango/" + driver_version + " (" + flags + ")"
     normalized_headers: Headers = {
         "charset": "utf-8",

{python_arango-8.2.1 → python_arango-8.2.2}/docs/foxx.rst

@@ -83,9 +83,9 @@ information, refer to `ArangoDB manual`_.
     foxx.readme(service_mount)
     foxx.swagger(service_mount)
     foxx.download(service_mount)
-    foxx.commit(service_mount)
+    foxx.commit()
     foxx.scripts(service_mount)
-    foxx.run_script(service_mount, 'setup', [])
+    foxx.run_script(service_mount, 'setup', {})
     foxx.run_tests(service_mount, reporter='xunit', output_format='xml')
 
     # Delete a service.

{python_arango-8.2.1 → python_arango-8.2.2}/python_arango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.2.1
+Version: 8.2.2
 Summary: Python Driver for ArangoDB
 Author-email: Joohwan Oh <joohwan.oh@outlook.com>
 Maintainer-email: Joohwan Oh <joohwan.oh@outlook.com>, Alexandru Petenchea <alex.petenchea@gmail.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>