python-arango-async 1.0.3__tar.gz → 1.0.5__tar.gz

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/.circleci/config.yml

@@ -7,7 +7,7 @@ executors:
     resource_class: small
   python-vm:
     machine:
-      image: ubuntu-2204:current
+      image: ubuntu-2404:current
     resource_class: medium
 
 workflows:
@@ -86,8 +86,8 @@ jobs:
               args+=("--cluster" "--port=8539" "--port=8549")
             fi
 
-            if [ << parameters.arangodb_license >> = "enterprise" ]; then
-              args+=("--enterprise")
+            if [ << parameters.arangodb_license >> != "enterprise" ]; then
+              args+=("--skip" "enterprise")
             fi
 
             echo "Running pytest with args: ${args[@]}"

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/CONTRIBUTING.md

@@ -10,7 +10,7 @@ pre-commit install         # Install git pre-commit hooks
 Run unit tests with coverage:
 
 ```shell
-pytest --enterprise --cluster --cov=arango --cov-report=html  # Open htmlcov/index.html in your browser
+pytest --cluster --cov=arango --cov-report=html  # Open htmlcov/index.html in your browser
 ```
 
 To start and ArangoDB instance locally, run:

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 1.0.3
+Version: 1.0.5
 Summary: Async Python Driver for ArangoDB
 Author-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
 Maintainer-email: Alexandru Petenchea <alexandru.petenchea@arangodb.com>, Anthony Mahanna <anthony.mahanna@arangodb.com>
@@ -37,6 +37,7 @@ Requires-Dist: pytest-asyncio>=0.23.8; extra == "dev"
 Requires-Dist: pytest-cov>=5.0; extra == "dev"
 Requires-Dist: sphinx>=7.3; extra == "dev"
 Requires-Dist: sphinx_rtd_theme>=2.0; extra == "dev"
+Requires-Dist: allure-pytest>=2.15; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 Dynamic: license-file
 
@@ -117,7 +118,7 @@ async def main():
                 student_names.append(doc["name"])
 ```
 
-Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
+Another example with [graphs](https://docs.arango.ai/arangodb/stable/graphs/):
 
 ```python
 async def main():

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/README.md

@@ -75,7 +75,7 @@ async def main():
                 student_names.append(doc["name"])
 ```
 
-Another example with [graphs](https://docs.arangodb.com/stable/graphs/):
+Another example with [graphs](https://docs.arango.ai/arangodb/stable/graphs/):
 
 ```python
 async def main():

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/arangoasync/aql.py

@@ -78,7 +78,7 @@ class AQLQueryCache:
             AQLCacheEntriesError: If retrieval fails.
 
         References:
-            - `list-the-entries-of-the-aql-query-results-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#list-the-entries-of-the-aql-query-results-cache>`__
+            - `list-the-entries-of-the-aql-query-results-cache <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-results-cache/#list-the-entries-of-the-aql-query-results-cache>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_api/query-cache/entries")
 
@@ -99,7 +99,7 @@ class AQLQueryCache:
             AQLCacheEntriesError: If retrieval fails.
 
         References:
-            - `list-the-entries-of-the-aql-query-plan-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-plan-cache/#list-the-entries-of-the-aql-query-plan-cache>`__
+            - `list-the-entries-of-the-aql-query-plan-cache <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-plan-cache/#list-the-entries-of-the-aql-query-plan-cache>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_api/query-plan-cache")
 
@@ -117,7 +117,7 @@ class AQLQueryCache:
             AQLCacheClearError: If clearing the cache fails.
 
         References:
-            - `clear-the-aql-query-results-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#clear-the-aql-query-results-cache>`__
+            - `clear-the-aql-query-results-cache <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-results-cache/#clear-the-aql-query-results-cache>`__
         """  # noqa: E501
         request = Request(method=Method.DELETE, endpoint="/_api/query-cache")
 
@@ -134,7 +134,7 @@ class AQLQueryCache:
             AQLCacheClearError: If clearing the cache fails.
 
         References:
-            - `clear-the-aql-query-plan-cache <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-plan-cache/#clear-the-aql-query-plan-cache>`__
+            - `clear-the-aql-query-plan-cache <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-plan-cache/#clear-the-aql-query-plan-cache>`__
         """  # noqa: E501
         request = Request(method=Method.DELETE, endpoint="/_api/query-plan-cache")
 
@@ -154,7 +154,7 @@ class AQLQueryCache:
             AQLCachePropertiesError: If retrieval fails.
 
         References:
-            - `get-the-aql-query-results-cache-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#get-the-aql-query-results-cache-configuration>`__
+            - `get-the-aql-query-results-cache-configuration <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-results-cache/#get-the-aql-query-results-cache-configuration>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_api/query-cache/properties")
 
@@ -193,7 +193,7 @@ class AQLQueryCache:
             AQLCacheConfigureError: If setting the configuration fails.
 
         References:
-            - `set-the-aql-query-results-cache-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-query-results-cache/#set-the-aql-query-results-cache-configuration>`__
+            - `set-the-aql-query-results-cache-configuration <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-query-results-cache/#set-the-aql-query-results-cache-configuration>`__
         """  # noqa: E501
         data: Json = dict()
         if mode is not None:
@@ -298,7 +298,7 @@ class AQL:
             Cursor: Result cursor.
 
         References:
-            - `create-a-cursor <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#create-a-cursor>`__
+            - `create-a-cursor <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#create-a-cursor>`__
         """  # noqa: E501
         data: Json = dict(query=query)
         if count is not None:
@@ -353,7 +353,7 @@ class AQL:
             AQLQueryTrackingGetError: If retrieval fails.
 
         References:
-            - `get-the-aql-query-tracking-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#get-the-aql-query-tracking-configuration>`__
+            - `get-the-aql-query-tracking-configuration <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#get-the-aql-query-tracking-configuration>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_api/query/properties")
 
@@ -397,7 +397,7 @@ class AQL:
             AQLQueryTrackingSetError: If setting the configuration fails.
 
         References:
-            - `update-the-aql-query-tracking-configuration <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#update-the-aql-query-tracking-configuration>`__
+            - `update-the-aql-query-tracking-configuration <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#update-the-aql-query-tracking-configuration>`__
         """  # noqa: E501
         data: Json = dict()
 
@@ -462,7 +462,7 @@ class AQL:
             AQLQueryListError: If retrieval fails.
 
         References:
-            - `list-the-running-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-the-running-queries>`__
+            - `list-the-running-queries <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#list-the-running-queries>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -493,7 +493,7 @@ class AQL:
             AQLQueryListError: If retrieval fails.
 
         References:
-            - `list-the-slow-aql-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-the-slow-aql-queries>`__
+            - `list-the-slow-aql-queries <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#list-the-slow-aql-queries>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -523,7 +523,7 @@ class AQL:
             AQLQueryClearError: If retrieval fails.
 
         References:
-            - `clear-the-list-of-slow-aql-queries <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#clear-the-list-of-slow-aql-queries>`__
+            - `clear-the-list-of-slow-aql-queries <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#clear-the-list-of-slow-aql-queries>`__
         """  # noqa: E501
         request = Request(
             method=Method.DELETE,
@@ -560,7 +560,7 @@ class AQL:
             AQLQueryKillError: If killing the query fails.
 
         References:
-            - `kill-a-running-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#kill-a-running-aql-query>`__
+            - `kill-a-running-aql-query <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#kill-a-running-aql-query>`__
         """  # noqa: E501
         request = Request(
             method=Method.DELETE,
@@ -598,7 +598,7 @@ class AQL:
             AQLQueryExplainError: If retrieval fails.
 
         References:
-            - `explain-an-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#explain-an-aql-query>`__
+            - `explain-an-aql-query <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#explain-an-aql-query>`__
         """  # noqa: E501
         data: Json = dict(query=query)
         if bind_vars is not None:
@@ -634,7 +634,7 @@ class AQL:
             AQLQueryValidateError: If validation fails.
 
         References:
-            - `parse-an-aql-query <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#parse-an-aql-query>`__
+            - `parse-an-aql-query <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#parse-an-aql-query>`__
         """  # noqa: E501
         request = Request(
             method=Method.POST,
@@ -659,7 +659,7 @@ class AQL:
             AQLQueryRulesGetError: If retrieval fails.
 
         References:
-            - `list-all-aql-optimizer-rules <https://docs.arangodb.com/stable/develop/http-api/queries/aql-queries/#list-all-aql-optimizer-rules>`__
+            - `list-all-aql-optimizer-rules <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/aql-queries/#list-all-aql-optimizer-rules>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_api/query/rules")
 
@@ -684,7 +684,7 @@ class AQL:
             AQLFunctionListError: If retrieval fails.
 
         References:
-            - `list-the-registered-user-defined-aql-functions <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#list-the-registered-user-defined-aql-functions>`__
+            - `list-the-registered-user-defined-aql-functions <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/user-defined-aql-functions/#list-the-registered-user-defined-aql-functions>`__
         """  # noqa: E501
         params: Json = dict()
         if namespace is not None:
@@ -726,7 +726,7 @@ class AQL:
             AQLFunctionCreateError: If registration fails.
 
         References:
-            - `create-a-user-defined-aql-function <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#create-a-user-defined-aql-function>`__
+            - `create-a-user-defined-aql-function <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/user-defined-aql-functions/#create-a-user-defined-aql-function>`__
         """  # noqa: E501
         request = Request(
             method=Method.POST,
@@ -765,7 +765,7 @@ class AQL:
             AQLFunctionDeleteError: If removal fails.
 
         References:
-            - `remove-a-user-defined-aql-function <https://docs.arangodb.com/stable/develop/http-api/queries/user-defined-aql-functions/#remove-a-user-defined-aql-function>`__
+            - `remove-a-user-defined-aql-function <https://docs.arango.ai/arangodb/stable/develop/http-api/queries/user-defined-aql-functions/#remove-a-user-defined-aql-function>`__
         """  # noqa: E501
         params: Json = dict()
         if group is not None:

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/arangoasync/auth.py

@@ -20,8 +20,8 @@ class Auth:
         encoding (str): Encoding for the password (default: utf-8)
     """
 
-    username: str
-    password: str
+    username: str = ""
+    password: str = ""
     encoding: str = "utf-8"
 
 

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/arangoasync/backup.py

@@ -49,7 +49,7 @@ class Backup:
             BackupGetError: If the operation fails.
 
         References:
-            - `list-backups <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#list-all-backups>`__
+            - `list-backups <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#list-all-backups>`__
         """  # noqa: E501
         data: Json = {}
         if backup_id is not None:
@@ -97,7 +97,7 @@ class Backup:
             BackupCreateError: If the backup creation fails.
 
         References:
-            - `create-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#create-a-backup>`__
+            - `create-backup <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#create-a-backup>`__
         """  # noqa: E501
         data: Json = {}
         if label is not None:
@@ -137,7 +137,7 @@ class Backup:
             BackupRestoreError: If the restore operation fails.
 
         References:
-            - `restore-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#restore-a-backup>`__
+            - `restore-backup <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#restore-a-backup>`__
         """  # noqa: E501
         data: Json = {"id": backup_id}
         request = Request(
@@ -165,7 +165,7 @@ class Backup:
             BackupDeleteError: If the delete operation fails.
 
         References:
-            - `delete-backup <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#delete-a-backup>`__
+            - `delete-backup <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#delete-a-backup>`__
         """  # noqa: E501
         data: Json = {"id": backup_id}
         request = Request(
@@ -209,7 +209,7 @@ class Backup:
             BackupUploadError: If upload operation fails.
 
         References:
-            - `upload-a-backup-to-a-remote-repository <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#upload-a-backup-to-a-remote-repository>`__
+            - `upload-a-backup-to-a-remote-repository <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#upload-a-backup-to-a-remote-repository>`__
         """  # noqa: E501
         data: Json = {}
         if upload_id is not None:
@@ -265,7 +265,7 @@ class Backup:
             BackupDownloadError: If the download operation fails.
 
         References:
-            - `download-a-backup-from-a-remote-repository <https://docs.arangodb.com/stable/develop/http-api/hot-backups/#download-a-backup-from-a-remote-repository>`__
+            - `download-a-backup-from-a-remote-repository <https://docs.arango.ai/arangodb/stable/develop/http-api/hot-backups/#download-a-backup-from-a-remote-repository>`__
         """  # noqa: E501
         data: Json = {}
         if download_id is not None:

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/arangoasync/client.py

@@ -147,7 +147,7 @@ class ArangoClient:
         self,
         name: str,
         auth_method: str = "basic",
-        auth: Optional[Auth] = None,
+        auth: Optional[Auth | str] = None,
         token: Optional[JwtToken] = None,
         verify: bool = False,
         compression: Optional[CompressionManager] = None,
@@ -169,7 +169,8 @@ class ArangoClient:
                     and client are synchronized.
                 - "superuser": Superuser JWT authentication.
                     The `token` parameter is required. The `auth` parameter is ignored.
-            auth (Auth | None): Login information.
+            auth (Auth | None): Login information (username and password) or
+                access token.
             token (JwtToken | None): JWT token.
             verify (bool): Verify the connection by sending a test request.
             compression (CompressionManager | None): If set, supersedes the
@@ -188,6 +189,9 @@ class ArangoClient:
         """
         connection: Connection
 
+        if isinstance(auth, str):
+            auth = Auth(password=auth)
+
         if auth_method == "basic":
             if auth is None:
                 raise ValueError("Basic authentication requires the `auth` parameter")

{python_arango_async-1.0.3 → python_arango_async-1.0.5}/arangoasync/cluster.py

@@ -45,7 +45,7 @@ class Cluster:
             ClusterHealthError: If retrieval fails.
 
         References:
-            - `get-the-cluster-health <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-cluster-health>`__
+            - `get-the-cluster-health <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-cluster-health>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -74,7 +74,7 @@ class Cluster:
             ClusterStatisticsError: If retrieval fails.
 
         References:
-            - `get-the-statistics-of-a-db-server <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-statistics-of-a-db-server>`__
+            - `get-the-statistics-of-a-db-server <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-statistics-of-a-db-server>`__
         """  # noqa: E501
         params: Params = {"DBserver": db_server}
 
@@ -103,7 +103,7 @@ class Cluster:
             ClusterEndpointsError: If retrieval fails.
 
         References:
-           - `list-all-coordinator-endpoints <https://docs.arangodb.com/stable/develop/http-api/cluster/#list-all-coordinator-endpoints>`__
+           - `list-all-coordinator-endpoints <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#list-all-coordinator-endpoints>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -129,7 +129,7 @@ class Cluster:
             ClusterServerIDError: If retrieval fails.
 
         References:
-            - `get-the-server-id <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-server-id>`__
+            - `get-the-server-id <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-server-id>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -154,7 +154,7 @@ class Cluster:
             ClusterServerRoleError: If retrieval fails.
 
         References:
-            - `get-the-server-role <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-server-role>`__
+            - `get-the-server-role <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-server-role>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -182,7 +182,7 @@ class Cluster:
             ClusterMaintenanceModeError: If the toggle operation fails.
 
         References:
-            - `toggle-cluster-maintenance-mode <https://docs.arangodb.com/stable/develop/http-api/cluster/#toggle-cluster-maintenance-mode>`__
+            - `toggle-cluster-maintenance-mode <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#toggle-cluster-maintenance-mode>`__
         """  # noqa: E501
         request = Request(
             method=Method.PUT,
@@ -212,7 +212,7 @@ class Cluster:
             ClusterMaintenanceModeError: If retrieval fails.
 
         References:
-           - `get-the-maintenance-status-of-a-db-server <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-maintenance-status-of-a-db-server>`__
+           - `get-the-maintenance-status-of-a-db-server <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-maintenance-status-of-a-db-server>`__
         """  # noqa: E501
         request = Request(
             method=Method.GET,
@@ -242,7 +242,7 @@ class Cluster:
             ClusterMaintenanceModeError: If the operation fails.
 
         References:
-            - `set-the-maintenance-status-of-a-db-server <https://docs.arangodb.com/stable/develop/http-api/cluster/#set-the-maintenance-status-of-a-db-server>`__
+            - `set-the-maintenance-status-of-a-db-server <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#set-the-maintenance-status-of-a-db-server>`__
         """  # noqa: E501
         data: Json = {"mode": mode}
         if timeout is not None:
@@ -271,7 +271,7 @@ class Cluster:
             ClusterRebalanceError: If retrieval fails.
 
         References:
-           - `get-the-current-cluster-imbalance <https://docs.arangodb.com/stable/develop/http-api/cluster/#get-the-current-cluster-imbalance>`__
+           - `get-the-current-cluster-imbalance <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#get-the-current-cluster-imbalance>`__
         """  # noqa: E501
         request = Request(method=Method.GET, endpoint="/_admin/cluster/rebalance")
 
@@ -315,7 +315,7 @@ class Cluster:
             ClusterRebalanceError: If retrieval fails.
 
         References:
-            - `compute-a-set-of-move-shard-operations-to-improve-balance <https://docs.arangodb.com/stable/develop/http-api/cluster/#compute-a-set-of-move-shard-operations-to-improve-balance>`__
+            - `compute-a-set-of-move-shard-operations-to-improve-balance <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#compute-a-set-of-move-shard-operations-to-improve-balance>`__
         """  # noqa: E501
         data: Json = dict(version=version)
         if databases_excluded is not None:
@@ -380,7 +380,7 @@ class Cluster:
             ClusterRebalanceError: If retrieval fails.
 
         References:
-            - `compute-and-execute-a-set-of-move-shard-operations-to-improve-balance <https://docs.arangodb.com/stable/develop/http-api/cluster/#compute-and-execute-a-set-of-move-shard-operations-to-improve-balance>`__
+            - `compute-and-execute-a-set-of-move-shard-operations-to-improve-balance <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#compute-and-execute-a-set-of-move-shard-operations-to-improve-balance>`__
         """  # noqa: E501
         data: Json = dict(version=version)
         if databases_excluded is not None:
@@ -431,7 +431,7 @@ class Cluster:
             ClusterRebalanceError: If the execution fails.
 
         References:
-            - `execute-a-set-of-move-shard-operations <https://docs.arangodb.com/stable/develop/http-api/cluster/#execute-a-set-of-move-shard-operations>`__
+            - `execute-a-set-of-move-shard-operations <https://docs.arango.ai/arangodb/stable/develop/http-api/cluster/#execute-a-set-of-move-shard-operations>`__
         """  # noqa: E501
         data: Json = dict(version=version, moves=moves)