python-arango 8.2.4__tar.gz → 8.2.6__tar.gz

{python_arango-8.2.4 → python_arango-8.2.6}/.circleci/config.yml

@@ -1,7 +1,14 @@
 version: 2.1
 
-orbs:
-  codecov: codecov/codecov@3.3.0
+executors:
+  python-container:
+    docker:
+      - image: cimg/python:3.12
+    resource_class: small
+  python-vm:
+    machine:
+      image: ubuntu-2404:current
+    resource_class: medium
 
 workflows:
   ci:
@@ -14,98 +21,81 @@ workflows:
               python_version: ["3.10", "3.11", "3.12"]
               arangodb_config: ["single", "cluster"]
               arangodb_license: ["enterprise"]
-              arangodb_version: ["latest"]
+              arangodb_version: ["3.12"]
 
 jobs:
   lint:
-    docker:
-      - image: python:latest
+    executor: python-container
+    resource_class: small
     steps:
       - checkout
       - run:
           name: Install Dependencies
           command: pip install .[dev]
-
       - run:
-          name: Run black
-          command: black --check --verbose --diff --color --config=pyproject.toml ./arango ./tests/
-
+            name: Run black
+            command: black --check --verbose --diff --color --config=pyproject.toml ./arango ./tests/
       - run:
           name: Run flake8
           command: flake8 ./arango ./tests
-
       - run:
           name: Run isort
           command: isort --check ./arango ./tests
-
       - run:
           name: Run mypy
           command: mypy ./arango
-
   test:
     parameters:
-      python_version:
-        type: string
-      arangodb_config:
-        type: string
-      arangodb_license:
-        type: string
-      arangodb_version:
-        type: string
-    # TODO: Reconsider using a docker image instead of a machine
-    # i.e cimg/python:<< parameters.python_version >>
-    machine:
-      image: ubuntu-2204:current
+        python_version:
+            type: string
+        arangodb_config:
+            type: string
+        arangodb_license:
+            type: string
+        arangodb_version:
+            type: string
+    executor: python-vm
     steps:
       - checkout
-
       - run:
-          name: Set Up ArangoDB
+          name: Setup ArangoDB
           command: |
             chmod +x starter.sh
             ./starter.sh << parameters.arangodb_config >> << parameters.arangodb_license >> << parameters.arangodb_version >>
-
       - restore_cache:
           key: pip-and-local-cache
-
-      # TODO: Revisit this bottleneck
       - run:
           name: Setup Python
           command: |
             pyenv --version
             pyenv install -f << parameters.python_version >>
             pyenv global << parameters.python_version >>
-
       - run:
-          name: "Install Dependencies"
+          name: Install Dependencies
           command: pip install -e .[dev]
-
       - run: docker ps -a
-
       - run: docker logs arango
-
       - run:
-          name: "Run pytest"
+          name: Run pytest
           command: |
             mkdir test-results
+            mkdir htmlcov
 
             args=("--junitxml=test-results/junit.xml" "--log-cli-level=DEBUG" "--host" "localhost" "--port=8529")
             if [ << parameters.arangodb_config >> = "cluster" ]; then
               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[@]}"
-            pytest --cov=arango --cov-report=xml --cov-report term-missing --color=yes --code-highlight=yes "${args[@]}"
-
+            pytest --cov=arango --cov-report=html:htmlcov --color=yes --code-highlight=yes "${args[@]}"
+      - store_artifacts:
+          path: htmlcov
+          destination: coverage-report
       - store_artifacts:
           path: test-results
-
       - store_test_results:
           path: test-results
-
-      - codecov/upload:
-        file: coverage.xml

{python_arango-8.2.4 → python_arango-8.2.6}/.gitignore

@@ -119,9 +119,6 @@ node_modules/
 .envrc
 .direnv/
 
-# setuptools_scm
-arango/version.py
-
 # test results
 *_results.txt
 

{python_arango-8.2.4 → python_arango-8.2.6}/.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
     -   id: trailing-whitespace
 
 -   repo: https://github.com/psf/black
-    rev: 23.1.0
+    rev: 26.1.0
     hooks:
     -   id: black
 
@@ -29,7 +29,7 @@ repos:
         args: [ --profile, black ]
 
 -   repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+    rev: 7.3.0
     hooks:
     -   id: flake8
 

{python_arango-8.2.4 → python_arango-8.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.2.4
+Version: 8.2.6
 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>
@@ -39,19 +39,17 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Documentation :: Sphinx
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: urllib3>=1.26.0
 Requires-Dist: requests
 Requires-Dist: requests_toolbelt
 Requires-Dist: PyJWT
-Requires-Dist: setuptools>=42
-Requires-Dist: importlib_metadata>=4.7.1
 Requires-Dist: packaging>=23.1
 Provides-Extra: dev
-Requires-Dist: black>=22.3.0; extra == "dev"
-Requires-Dist: flake8>=4.0.1; extra == "dev"
+Requires-Dist: black==26.1.0; extra == "dev"
+Requires-Dist: flake8==7.3.0; extra == "dev"
 Requires-Dist: isort>=5.10.1; extra == "dev"
 Requires-Dist: mypy>=0.942; extra == "dev"
 Requires-Dist: mock; extra == "dev"
@@ -61,6 +59,7 @@ Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: allure-pytest>=2.15; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 Dynamic: license-file
 

{python_arango-8.2.4 → python_arango-8.2.6}/arango/client.py

@@ -3,8 +3,6 @@ __all__ = ["ArangoClient"]
 from json import dumps, loads
 from typing import Any, Callable, Optional, Sequence, Union
 
-import importlib_metadata
-
 from arango.connection import (
     BasicConnection,
     Connection,
@@ -27,6 +25,7 @@ from arango.resolver import (
     RoundRobinHostResolver,
     SingleHostResolver,
 )
+from arango.version import __version__
 
 
 def default_serializer(x: Any) -> str:
@@ -175,8 +174,7 @@ class ArangoClient:
         :return: Client version.
         :rtype: str
         """
-        version: str = importlib_metadata.version("python-arango")
-        return version
+        return __version__
 
     @property
     def request_timeout(self) -> Any:

{python_arango-8.2.4 → python_arango-8.2.6}/arango/collection.py

@@ -871,9 +871,7 @@ class Collection(ApiGroup):
         query = """
         FOR doc IN NEAR(@collection, @latitude, @longitude{})
             RETURN doc
-        """.format(
-            "" if limit is None else ", @limit "
-        )
+        """.format("" if limit is None else ", @limit ")
 
         bind_vars = {
             "collection": self._name,
@@ -996,9 +994,7 @@ class Collection(ApiGroup):
         query = """
         FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius{})
             RETURN doc
-        """.format(
-            "" if distance_field is None else ", @distance"
-        )
+        """.format("" if distance_field is None else ", @distance")
 
         bind_vars = {
             "@collection": self._name,
@@ -1080,7 +1076,7 @@ class Collection(ApiGroup):
         coord_str = ""
         if index is None:
             # Find the first geo index
-            for collection_index in self.indexes():  # type:ignore[union-attr]
+            for collection_index in self.indexes():  # type: ignore[union-attr]
                 if collection_index["type"] == "geo":
                     coord_str = build_coord_str_from_index(collection_index)
                     break
@@ -1168,9 +1164,7 @@ class Collection(ApiGroup):
         aql = """
         FOR doc IN FULLTEXT(@collection, @field, @query{})
             RETURN doc
-        """.format(
-            "" if limit is None else ", @limit"
-        )
+        """.format("" if limit is None else ", @limit")
 
         request = Request(
             method="post",

{python_arango-8.2.4 → python_arango-8.2.6}/arango/database.py

@@ -19,6 +19,9 @@ from arango.collection import StandardCollection
 from arango.connection import Connection
 from arango.errno import HTTP_NOT_FOUND
 from arango.exceptions import (
+    AccessTokenCreateError,
+    AccessTokenDeleteError,
+    AccessTokenListError,
     AnalyzerCreateError,
     AnalyzerDeleteError,
     AnalyzerGetError,
@@ -1158,6 +1161,89 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def create_access_token(
+        self,
+        user: str,
+        name: str,
+        valid_until: int,
+    ) -> Result[Json]:
+        """Create an access token for the given user.
+
+        :param user: The name of the user.
+        :type user: str
+        :param name: A name for the access token to make identification easier,
+            like a short description.
+        :type name: str
+        :param valid_until: A Unix timestamp in seconds to set the expiration
+            date and time.
+        :type valid_until: int
+
+        :return: Information about the created access token, including the token itself.
+        :rtype: dict
+
+        :raise arango.exceptions.AccessTokenCreateError: If the operations fails.
+        """
+        data: Json = {
+            "name": name,
+            "valid_until": valid_until,
+        }
+
+        request = Request(
+            method="post",
+            endpoint=f"/_api/token/{user}",
+            data=data,
+        )
+
+        def response_handler(resp: Response) -> Json:
+            if not resp.is_success:
+                raise AccessTokenCreateError(resp, request)
+            result: Json = resp.body
+            return result
+
+        return self._executor.execute(request, response_handler)
+
+    def delete_access_token(self, user: str, token_id: int) -> Result[None]:
+        """Delete an access token for the given user.
+
+        :param user: The name of the user.
+        :type user: str
+        :param token_id: The ID of the access token to delete.
+        :type token_id: int
+
+        :raise arango.exceptions.AccessTokenDeleteError: If the operation fails.
+        """
+        request = Request(
+            method="delete",
+            endpoint=f"/_api/token/{user}/{token_id}",
+        )
+
+        def response_handler(resp: Response) -> None:
+            if not resp.is_success:
+                raise AccessTokenDeleteError(resp, request)
+
+        return self._executor.execute(request, response_handler)
+
+    def list_access_tokens(self, user: str) -> Result[Jsons]:
+        """List all access tokens for the given user.
+
+        :param user: The name of the user.
+        :type user: str
+
+        :return: List of access tokens for the user.
+        :rtype: list
+
+        :raise arango.exceptions.AccessTokenListError: If the operation fails.
+        """
+        request = Request(method="get", endpoint=f"/_api/token/{user}")
+
+        def response_handler(resp: Response) -> Jsons:
+            if not resp.is_success:
+                raise AccessTokenListError(resp, request)
+            result: Jsons = resp.body["tokens"]
+            return result
+
+        return self._executor.execute(request, response_handler)
+
     def tls(self) -> Result[Json]:
         """Return TLS data (server key, client-auth CA).
 

{python_arango-8.2.4 → python_arango-8.2.6}/arango/exceptions.py

@@ -161,6 +161,23 @@ class AQLQueryRulesGetError(ArangoServerError):
     """Failed to retrieve AQL query rules."""
 
 
+#######################
+# Access Token Errors #
+#######################
+
+
+class AccessTokenCreateError(ArangoServerError):
+    """Failed to create an access token."""
+
+
+class AccessTokenDeleteError(ArangoServerError):
+    """Failed to delete an access token."""
+
+
+class AccessTokenListError(ArangoServerError):
+    """Failed to retrieve access tokens."""
+
+
 ##############################
 # Async Execution Exceptions #
 ##############################

{python_arango-8.2.4 → python_arango-8.2.6}/arango/request.py

@@ -3,6 +3,7 @@ __all__ = ["Request"]
 from typing import Any, MutableMapping, Optional
 
 from arango.typings import DriverFlags, Fields, Headers, Params
+from arango.version import __version__
 
 
 def normalize_headers(
@@ -12,7 +13,7 @@ def normalize_headers(
     if driver_flags is not None:
         for flag in driver_flags:
             flags = flags + flag + ";"
-    driver_version = "8.2.4"
+    driver_version = __version__
     driver_header = "python-arango/" + driver_version + " (" + flags + ")"
     normalized_headers: Headers = {
         "charset": "utf-8",

python_arango-8.2.6/arango/version.py

@@ -0,0 +1 @@
+__version__ = "8.2.6"

{python_arango-8.2.4 → python_arango-8.2.6}/docs/contributing.rst

@@ -59,7 +59,7 @@ To run the test suite (use your own host, port and root password):
     ~$ pip install pytest
     ~$ git clone https://github.com/arangodb/python-arango.git
     ~$ cd python-arango
-    ~$ py.test --complete --host=127.0.0.1 --port=8529 --passwd=passwd
+    ~$ pytest --cluster --host=127.0.0.1 --port=8529 --password=passwd
 
 To run the test suite with coverage report:
 
@@ -68,7 +68,7 @@ To run the test suite with coverage report:
     ~$ pip install coverage pytest pytest-cov
     ~$ git clone https://github.com/arangodb/python-arango.git
     ~$ cd python-arango
-    ~$ py.test --complete --host=127.0.0.1 --port=8529 --passwd=passwd --cov=kq
+    ~$ pytest --cluster --host=127.0.0.1 --port=8529 --password=passwd --cov=kq
 
 As the test suite creates real databases and jobs, it should only be run in
 development environments.

{python_arango-8.2.4 → python_arango-8.2.6}/docs/requirements.txt

@@ -1,4 +1,3 @@
 requests_toolbelt
-importlib_metadata
 PyJWT
 sphinx_rtd_theme

{python_arango-8.2.4 → python_arango-8.2.6}/pyproject.toml

@@ -18,7 +18,7 @@ keywords = ["arangodb", "python", "driver"]
 readme = "README.md"
 dynamic = ["version"]
 license = { file = "LICENSE" }
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 
 classifiers = [
     "Intended Audience :: Developers",
@@ -39,15 +39,16 @@ dependencies = [
     "requests",
     "requests_toolbelt",
     "PyJWT",
-    "setuptools>=42",
-    "importlib_metadata>=4.7.1",
     "packaging>=23.1",
 ]
 
+[tool.setuptools.dynamic]
+version = { attr = "arango.version.__version__" }
+
 [project.optional-dependencies]
 dev = [
-    "black>=22.3.0",
-    "flake8>=4.0.1",
+    "black==26.1.0",
+    "flake8==7.3.0",
     "isort>=5.10.1",
     "mypy>=0.942",
     "mock",
@@ -57,6 +58,7 @@ dev = [
     "sphinx",
     "sphinx_rtd_theme",
     "types-requests",
+    "allure-pytest>=2.15",
     "types-setuptools",
 ]
 

{python_arango-8.2.4 → python_arango-8.2.6}/python_arango.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.2.4
+Version: 8.2.6
 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>
@@ -39,19 +39,17 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Documentation :: Sphinx
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: urllib3>=1.26.0
 Requires-Dist: requests
 Requires-Dist: requests_toolbelt
 Requires-Dist: PyJWT
-Requires-Dist: setuptools>=42
-Requires-Dist: importlib_metadata>=4.7.1
 Requires-Dist: packaging>=23.1
 Provides-Extra: dev
-Requires-Dist: black>=22.3.0; extra == "dev"
-Requires-Dist: flake8>=4.0.1; extra == "dev"
+Requires-Dist: black==26.1.0; extra == "dev"
+Requires-Dist: flake8==7.3.0; extra == "dev"
 Requires-Dist: isort>=5.10.1; extra == "dev"
 Requires-Dist: mypy>=0.942; extra == "dev"
 Requires-Dist: mock; extra == "dev"
@@ -61,6 +59,7 @@ Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx_rtd_theme; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: allure-pytest>=2.15; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
 Dynamic: license-file
 

{python_arango-8.2.4 → python_arango-8.2.6}/python_arango.egg-info/SOURCES.txt

@@ -40,6 +40,7 @@ arango/response.py
 arango/result.py
 arango/typings.py
 arango/utils.py
+arango/version.py
 arango/wal.py
 docs/Makefile
 docs/admin.rst

{python_arango-8.2.4 → python_arango-8.2.6}/python_arango.egg-info/requires.txt

@@ -2,13 +2,11 @@ urllib3>=1.26.0
 requests
 requests_toolbelt
 PyJWT
-setuptools>=42
-importlib_metadata>=4.7.1
 packaging>=23.1
 
 [dev]
-black>=22.3.0
-flake8>=4.0.1
+black==26.1.0
+flake8==7.3.0
 isort>=5.10.1
 mypy>=0.942
 mock
@@ -18,4 +16,5 @@ pytest-cov>=3.0.0
 sphinx
 sphinx_rtd_theme
 types-requests
+allure-pytest>=2.15
 types-setuptools