python-arango 8.3.3__tar.gz → 8.3.5__tar.gz

python_arango-8.3.5/.circleci/config.yml

@@ -0,0 +1,207 @@
+version: 2.1
+
+executors:
+  python-container:
+    parameters:
+      python_version:
+        type: string
+        default: "3.14"
+    docker:
+      - image: cimg/python:<< parameters.python_version >>
+    resource_class: arangodb/small-amd64
+  arangodb-container:
+    parameters:
+      arangodb_image:
+        type: string
+    docker:
+      - image: << parameters.arangodb_image >>
+        entrypoint: /bin/sh
+        command: -c "while true; do sleep 10; done"
+        user: root
+    resource_class: arangodb/medium-amd64
+
+workflows:
+  ci:
+    jobs:
+      - lint
+      - import-test:
+          name: Imports (Python << matrix.python_version >>)
+          matrix:
+            parameters:
+              python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+      - integration-test:
+          name: ArangoDB (enterprise, 3.12 << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: ["single", "cluster"]
+              arangodb_image: ["arangodb/enterprise:3.12"]
+              arangodb_conf_version: ["3.12"]
+      - integration-test:
+          name: ArangoDB (core-preview, 4.0-nightly << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: [ "single", "cluster" ]
+              arangodb_image: [ "arangodb/core-preview:4.0-nightly" ]
+              arangodb_conf_version: [ "4.0" ]
+      - integration-test:
+          name: ArangoDB (enterprise-preview, 3.12-nightly << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: ["single", "cluster"]
+              arangodb_image: ["arangodb/enterprise-preview:3.12-nightly"]
+              arangodb_conf_version: ["3.12"]
+
+jobs:
+  lint:
+    executor: python-container
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: python -m pip install .[dev]
+      - run:
+          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
+  import-test:
+    parameters:
+      python_version:
+        type: string
+    executor:
+      name: python-container
+      python_version: << parameters.python_version >>
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: |
+            python --version
+            python -m pip install .[dev]
+      - run:
+          name: Run Import Tests
+          command: python -m pytest tests/test_imports.py --skip-arango-setup --color=yes --code-highlight=yes
+  integration-test:
+    parameters:
+      arangodb_config:
+        type: string
+      arangodb_image:
+        type: string
+      arangodb_conf_version:
+        type: string
+    executor:
+      name: arangodb-container
+      arangodb_image: << parameters.arangodb_image >>
+    steps:
+      - run:
+          name: Bootstrap CI Tools
+          command: |
+            apk add --no-cache \
+              bash \
+              build-base \
+              ca-certificates \
+              curl \
+              git \
+              jq \
+              openssh-client \
+              openssl-dev \
+              py3-pip \
+              py3-virtualenv \
+              python3 \
+              python3-dev
+      - checkout
+      - run:
+          name: Setup ArangoDB
+          command: |
+            mkdir -p /tests
+            if [ ! -e /tests/static ]; then
+              ln -s "$PWD/tests/static" /tests/static
+            fi
+
+            conf_file="/tests/static/<< parameters.arangodb_config >>-<< parameters.arangodb_conf_version >>.conf"
+            if [ ! -f "$conf_file" ]; then
+              echo "Missing configuration file: $conf_file"
+              exit 1
+            fi
+
+            arangodb --configuration="$conf_file" > arangodb.log 2>&1 &
+            echo "$!" > arangodb.pid
+
+            ports="8529"
+            if [ << parameters.arangodb_config >> = "cluster" ]; then
+              ports="$ports 8539 8549"
+            fi
+
+            for port in $ports; do
+              echo "Waiting for ArangoDB at http://localhost:$port/_api/version"
+              for attempt in $(seq 1 120); do
+                if curl --fail --silent --show-error \
+                    --user root:passwd \
+                    "http://localhost:$port/_api/version" | jq; then
+                  break
+                fi
+
+                if ! kill -0 "$(cat arangodb.pid)" 2>/dev/null; then
+                  echo "ArangoDB process exited before port $port became ready"
+                  exit 1
+                fi
+
+                if [ "$attempt" -eq 120 ]; then
+                  echo "Timed out waiting for ArangoDB on port $port"
+                  exit 1
+                fi
+
+                sleep 1
+              done
+            done
+      - run:
+          name: Show ArangoDB Logs
+          command: tail -n 1000 arangodb.log
+          when: always
+      - run:
+          name: Setup Python
+          shell: /bin/bash -eo pipefail
+          command: |
+            python3 --version
+            python3 -m virtualenv .venv
+            source .venv/bin/activate
+            python --version
+            python -m pip --version
+      - run:
+          name: Install Dependencies
+          shell: /bin/bash -eo pipefail
+          command: |
+            source .venv/bin/activate
+            python -m pip install -e .[dev]
+      - run:
+          name: Run pytest
+          shell: /bin/bash -eo pipefail
+          command: |
+            mkdir test-results
+            mkdir htmlcov
+
+            source .venv/bin/activate
+
+            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
+
+            echo "Running pytest with args: ${args[@]}"
+            pytest tests --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_artifacts:
+          path: arangodb.log
+      - store_test_results:
+          path: test-results

{python_arango-8.3.3 → python_arango-8.3.5}/.github/workflows/codeql.yaml

@@ -3,8 +3,6 @@ name: CodeQL
 on:
   pull_request:
     branches: [main]
-  schedule:
-    - cron: '21 2 * * 3'
 
 jobs:
   analyze:
@@ -16,10 +14,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v7
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v4
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v4

python_arango-8.3.5/.github/workflows/docs.yaml

@@ -0,0 +1,47 @@
+name: Docs
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    name: Docs
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+
+      - name: Fetch all tags and branches
+        run: git fetch --prune --unshallow
+
+      - name: Create ArangoDB Docker container
+        run: >
+          docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd -v "$(pwd)/tests/static/":/tests/static
+          arangodb/enterprise:latest --server.jwt-secret-keyfile=/tests/static/keyfile --vector-index=true
+
+      - name: Start ArangoDB Docker container
+        run: docker start arango
+
+      - name: Wait for ArangoDB
+        run: |
+          for _ in {1..30}; do
+            if curl --fail --silent --user root:passwd http://localhost:8529/_api/version > /dev/null; then
+              exit 0
+            fi
+            sleep 1
+          done
+          docker logs arango
+          exit 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Run Sphinx doctest
+        run: python -m sphinx -b doctest docs docs/_build

{python_arango-8.3.3 → python_arango-8.3.5}/.github/workflows/pypi.yaml

@@ -3,13 +3,6 @@ name: Upload to PyPI
 on:
   release:
     types: [published]
-  workflow_dispatch:
-    inputs:
-      debug_enabled:
-        type: boolean
-        description: Debug with tmate
-        required: false
-        default: false
 
 jobs:
   upload:
@@ -17,19 +10,14 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Fetch all tags and branches
-        run: git fetch --prune --unshallow
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/checkout@v7
         with:
-          python-version: "3.10"
+          fetch-depth: 0
+          fetch-tags: true
 
-      - name: Debug with tmate
-        uses: mxschmitt/action-tmate@v3
-        if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
 
       - name: Install dependencies
         run: |

{python_arango-8.3.3 → python_arango-8.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.3
+Version: 8.3.5
 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>
@@ -33,7 +33,6 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -48,7 +47,7 @@ Requires-Dist: requests_toolbelt
 Requires-Dist: PyJWT>=2.10.0
 Requires-Dist: packaging>=23.1
 Provides-Extra: dev
-Requires-Dist: black==26.1.0; extra == "dev"
+Requires-Dist: black==26.5.1; extra == "dev"
 Requires-Dist: flake8==7.3.0; extra == "dev"
 Requires-Dist: isort==5.10.1; extra == "dev"
 Requires-Dist: mypy==1.15.0; extra == "dev"
@@ -89,7 +88,7 @@ If you're interested in using asyncio, please check [python-arango-async](https:
 ## Requirements
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 ## Installation
 

{python_arango-8.3.3 → python_arango-8.3.5}/README.md

@@ -24,7 +24,7 @@ If you're interested in using asyncio, please check [python-arango-async](https:
 ## Requirements
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 ## Installation
 

{python_arango-8.3.3 → python_arango-8.3.5}/arango/collection.py

@@ -816,14 +816,20 @@ class Collection(ApiGroup):
 
         skip_val = skip if skip is not None else 0
         limit_val = limit if limit is not None else "null"
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
+        sort_expression, sort_bind_vars = build_sort_expression(sort)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 LIMIT {skip_val}, {limit_val}
-                {build_sort_expression(sort)}
+                {sort_expression}
                 RETURN doc
         """
-        bind_vars = {"@collection": self.name}
+        bind_vars = {
+            "@collection": self.name,
+            **filter_bind_vars,
+            **sort_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -1268,17 +1274,29 @@ class Collection(ApiGroup):
     # Index Management #
     ####################
 
-    def indexes(self) -> Result[Jsons]:
+    def indexes(
+        self, with_stats: bool = False, with_hidden: bool = False
+    ) -> Result[Jsons]:
         """Return the collection indexes.
 
+        :param with_stats: Whether to include figures and estimates in the result.
+        :type with_stats: bool
+        :param with_hidden: Whether to include hidden indexes in the result.
+        :type with_hidden: bool
         :return: Collection indexes.
         :rtype: [dict]
         :raise arango.exceptions.IndexListError: If retrieval fails.
         """
+        params: Params = {"collection": self.name}
+        if with_stats:
+            params["withStats"] = True
+        if with_hidden:
+            params["withHidden"] = True
+
         request = Request(
             method="get",
             endpoint="/_api/index",
-            params={"collection": self.name},
+            params=params,
         )
 
         def response_handler(resp: Response) -> Jsons:
@@ -1920,9 +1938,10 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f", waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 UPDATE doc WITH @body IN @@collection
                 OPTIONS {{ keepNull: @keep_none, mergeObjects: @merge {sync_val} }}
@@ -1933,6 +1952,7 @@ class Collection(ApiGroup):
             "body": body,
             "keep_none": keep_none,
             "merge": merge,
+            **filter_bind_vars,
         }
 
         request = Request(
@@ -2089,15 +2109,20 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REPLACE doc WITH @body IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name, "body": body}
+        bind_vars = {
+            "@collection": self.name,
+            "body": body,
+            **filter_bind_vars,
+        }
 
         request = Request(
             method="post",
@@ -2248,15 +2273,16 @@ class Collection(ApiGroup):
         # then the collection’s default waitForSync behavior is applied.
         sync_val = f"waitForSync: {sync}" if sync is not None else ""
 
+        filter_conditions, filter_bind_vars = build_filter_conditions(filters)
         query = f"""
             FOR doc IN @@collection
-                {build_filter_conditions(filters)}
+                {filter_conditions}
                 {f"LIMIT {limit}" if limit is not None else ""}
                 REMOVE doc IN @@collection
                 {f"OPTIONS {{ {sync_val} }}" if sync_val else ""}
         """  # noqa: E201 E202
 
-        bind_vars = {"@collection": self.name}
+        bind_vars = {"@collection": self.name, **filter_bind_vars}
 
         request = Request(
             method="post",

{python_arango-8.3.3 → python_arango-8.3.5}/arango/connection.py

@@ -120,8 +120,7 @@ class BaseConnection:
         else:
             resp.body = resp.raw_body
 
-        http_ok = 200 <= resp.status_code < 300
-        resp.is_success = http_ok and resp.error_code is None
+        resp.is_success = 200 <= resp.status_code < 300
         return resp
 
     def process_request(

{python_arango-8.3.3 → python_arango-8.3.5}/arango/database.py

@@ -1128,6 +1128,20 @@ class Database(ApiGroup):
 
         return self._execute(request, response_handler)
 
+    def request(self, request: Request) -> Result[Response]:
+        """Execute a custom request.
+
+        :param request: Request object to be executed.
+        :type request: Request
+        :return: Response object containing the result of the request.
+        :rtype: Response
+        """
+
+        def response_handler(resp: Response) -> Response:
+            return resp
+
+        return self._executor.execute(request, response_handler)
+
     def metrics(self) -> Result[str]:
         """Return server metrics in Prometheus format.
 

{python_arango-8.3.3 → python_arango-8.3.5}/arango/formatter.py

@@ -73,6 +73,8 @@ def format_index(body: Json, formatter: bool = True) -> Json:
         result["cacheEnabled"] = body["cacheEnabled"]
     if "legacyPolygons" in body:
         result["legacyPolygons"] = body["legacyPolygons"]
+    if "figures" in body:
+        result["figures"] = body["figures"]
     if "estimates" in body:
         result["estimates"] = body["estimates"]
     if "analyzer" in body:
@@ -123,6 +125,8 @@ def format_index(body: Json, formatter: bool = True) -> Json:
         result["error_message"] = body["errorMessage"]
     if "trainingState" in body:
         result["training_state"] = body["trainingState"]
+    if "shards" in body:
+        result["shards"] = body["shards"]
 
     return verify_format(body, result)