python-arango 8.3.4__tar.gz → 8.3.6__tar.gz

{python_arango-8.3.4 → python_arango-8.3.6}/.circleci/config.yml

@@ -30,19 +30,33 @@ workflows:
             parameters:
               python_version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
       - integration-test:
-          name: ArangoDB (enterprise, 3.12 << matrix.arangodb_config >>)
+          name: ArangoDB (enterprise, 3.12.10 << matrix.arangodb_config >>)
           matrix:
             parameters:
               arangodb_config: ["single", "cluster"]
-              arangodb_image: ["arangodb/enterprise:3.12"]
+              arangodb_image: ["arangodb/enterprise:3.12.10"]
               arangodb_conf_version: ["3.12"]
       - integration-test:
-          name: ArangoDB (enterprise-preview, 4.0-nightly << matrix.arangodb_config >>)
+          name: ArangoDB (enterprise, 3.12.9 << matrix.arangodb_config >>)
           matrix:
             parameters:
               arangodb_config: ["single", "cluster"]
-              arangodb_image: ["arangodb/enterprise-preview:4.0-nightly"]
-              arangodb_conf_version: ["4.0"]
+              arangodb_image: ["arangodb/enterprise:3.12.9"]
+              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:

{python_arango-8.3.4 → python_arango-8.3.6}/.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.6/.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.6/.github/workflows/pypi.yaml

@@ -0,0 +1,66 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: python -m pip install build
+
+      - name: Build distribution
+        run: python -m build
+
+      - uses: actions/upload-artifact@v5
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  testpypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    needs: testpypi
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

python_arango-8.3.6/AGENTS.md

@@ -0,0 +1,89 @@
+# Quickstart
+
+python-arango is a Python driver for ArangoDB. Run the commands below from the
+repository root.
+
+## Repository layout
+
+- `arango/`: driver implementation, public APIs, and type annotations.
+- `tests/`: pytest tests; `conftest.py` defines database fixtures and CLI options.
+- `tests/static/`: server configurations and test data used by `starter.sh`.
+- `docs/`: Sphinx documentation in reStructuredText.
+- `pyproject.toml`, `setup.cfg`, `.pre-commit-config.yaml`: packaging and tooling.
+- `.circleci/`, `.github/workflows/`: CI checks, documentation, and publishing.
+
+## Development setup
+
+Use Python 3.10 or newer. Create a virtual environment, or use an existing one:
+
+```bash
+python3 -m venv .venv               # Create an isolated Python environment.
+source .venv/bin/activate           # Use its interpreter and tools.
+python -m pip install -e '.[dev]'   # Install the editable driver and dev tools.
+pre-commit install                  # Enable checks before each commit.
+```
+
+Examples use `python` from the activated environment. If it is unavailable on
+PATH, invoke your environment's interpreter directly.
+
+## Local cluster and tests
+
+The starter requires Docker, Bash, `wget`, and `jq`. To replace an existing test
+container, run `docker stop arango` and `docker rm arango` first.
+
+```bash
+version="latest"  # Or pin a supported version, such as 3.12.10.
+./starter.sh cluster enterprise "$version"  # Start a local test cluster.
+python -m pytest --cluster  # Run the full suite against the cluster.
+# Run one test while developing a document change.
+python -m pytest --cluster tests/test_document.py::test_document_insert
+# Generate an HTML coverage report.
+python -m pytest --cluster --cov=arango --cov-report=html
+```
+
+Defaults are `127.0.0.1:8529`, user `root`, password `passwd`, and JWT secret
+`secret`, matching the starter configuration. Override them with `--host`,
+`--port`, `--root`, `--password`, and `--secret`. Use a disposable development
+database: tests create and delete databases, users, jobs, and backups. If a
+sandbox blocks localhost access, rerun with the required sandbox permission.
+
+For a single server, use `./starter.sh single enterprise "$version"` and omit
+`--cluster`. Import tests can run without ArangoDB:
+
+```bash
+python -m pytest tests/test_imports.py --skip-arango-setup  # Check imports offline.
+```
+
+## Style and documentation
+
+Run the configured hooks for formatting, import ordering, linting, and type
+checks. Build and test documentation separately:
+
+```bash
+pre-commit run --all-files  # Run hooks; formatters may modify files.
+python -m sphinx -b html docs docs/_build  # Build the HTML documentation.
+python -m sphinx -b doctest docs docs/_build  # Test documentation examples.
+```
+
+The Sphinx doctests require a running ArangoDB server. Open
+`docs/_build/index.html` for the HTML documentation or `htmlcov/index.html` for
+the coverage report.
+
+## Changes and pull requests
+
+- Agents must work on a branch other than `main`; never commit directly to `main`.
+  Check the current branch before editing or committing. If on `main` or a
+  detached HEAD, create a branch first:
+
+  ```bash
+  git branch --show-current  # Check the current branch.
+  git switch -c fix/describe-change  # Choose a descriptive branch name.
+  ```
+
+- Preserve public API compatibility unless a breaking change is intentional.
+- Follow existing code patterns, type annotations, and Sphinx docstrings.
+- Add regression tests for fixes and tests for new behavior; update user documentation.
+- Run relevant tests and checks; report anything skipped and why.
+- Keep test coverage up and squash changes into one commit for submission.
+- Use present-tense commit messages, such as `Fix cursor retry`.
+- Explain what changed, why, and any compatibility impact in the pull request.

{python_arango-8.3.4/python_arango.egg-info → python_arango-8.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.4
+Version: 8.3.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>
@@ -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.4 → python_arango-8.3.6}/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.4 → python_arango-8.3.6}/arango/collection.py

@@ -1274,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:

{python_arango-8.3.4 → python_arango-8.3.6}/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.4 → python_arango-8.3.6}/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)
 

python_arango-8.3.6/arango/version.py

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

{python_arango-8.3.4 → python_arango-8.3.6}/docs/foxx.rst

@@ -13,7 +13,7 @@ information, refer to `ArangoDB manual`_.
 
 **Example:**
 
-.. testcode::
+.. code-block:: python
 
     from arango import ArangoClient
 

{python_arango-8.3.4 → python_arango-8.3.6}/docs/index.rst

@@ -13,7 +13,7 @@ Requirements
 =============
 
 - ArangoDB version 3.11+
-- Python version 3.9+
+- Python version 3.10+
 
 Installation
 ============
@@ -94,7 +94,6 @@ Development
 .. toctree::
     :maxdepth: 1
 
-    contributing
     specs
 
 .. _ArangoDB: https://www.arangodb.com

{python_arango-8.3.4 → python_arango-8.3.6}/docs/indexes.rst

@@ -62,4 +62,46 @@ on fields ``_from`` and ``_to``. For more information on indexes, refer to
     # Delete the last index from the collection.
     cities.delete_index(index['id'])
 
+    # Insert documents with vector embeddings.
+    cities.insert_many([
+        {
+            '_key': f'city{i}',
+            'continent': f'continent{i}',
+            'country': f'country{i}',
+            'population': i,
+            'coordinates': [float(i % 180), float(i % 90)],
+            'x': float(i),
+            'y': float(i),
+            'embedding': [float(i), float(i % 7), float(i % 11), 1.0],
+        }
+        for i in range(100)
+    ])
+
+    # Let ArangoDB determine the number of vector-index centroids.
+    vector_index = cities.add_index({
+        'type': 'vector',
+        'fields': ['embedding'],
+        'name': 'vector_index',
+        'params': {
+            'metric': 'cosine',
+            'dimension': 4,
+        },
+    })
+
+    # Index creation may succeed even if there is insufficient training data.
+    if vector_index.get('trainingState') != 'ready':
+        raise RuntimeError(
+            vector_index.get('errorMessage', 'Vector index is not ready')
+        )
+
+Omitted or scaling-object ``nLists``, ``numberOfDocsPerCentroid``, factory
+placeholders such as ``IVF{},Flat``, and successful-but-unusable creation
+behavior require ArangoDB 3.12.10 or later. A successful creation response
+means that the index exists, but callers should check ``trainingState`` before
+using it. If there is insufficient data to train the index, the state is
+``"unusable"`` and ``errorMessage`` describes the failure. Invalid index
+definitions, such as an ``nLists`` value that disagrees with the number of
+centroids in the factory string, are rejected during creation with
+``IndexCreateError`` and no index is created.
+
 See :ref:`StandardCollection` for API specification.

{python_arango-8.3.4 → python_arango-8.3.6}/pyproject.toml

@@ -26,7 +26,6 @@ classifiers = [
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -47,7 +46,7 @@ version = { attr = "arango.version.__version__" }
 
 [project.optional-dependencies]
 dev = [
-    "black==26.1.0",
+    "black==26.5.1",
     "flake8==7.3.0",
     "isort==5.10.1",
     "mypy==1.15.0",

{python_arango-8.3.4 → python_arango-8.3.6/python_arango.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango
-Version: 8.3.4
+Version: 8.3.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>
@@ -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.4 → python_arango-8.3.6}/python_arango.egg-info/SOURCES.txt

@@ -1,7 +1,7 @@
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yaml
-CONTRIBUTING.md
+AGENTS.md
 LICENSE
 MANIFEST.in
 README.md
@@ -9,6 +9,7 @@ pyproject.toml
 setup.cfg
 setup.py
 starter.sh
+todo.md
 .circleci/config.yml
 .github/workflows/codeql.yaml
 .github/workflows/docs.yaml
@@ -42,7 +43,6 @@ arango/typings.py
 arango/utils.py
 arango/version.py
 arango/wal.py
-ci/conftest.py
 docs/Makefile
 docs/admin.rst
 docs/analyzer.rst
@@ -56,7 +56,6 @@ docs/cluster.rst
 docs/collection.rst
 docs/compression.rst
 docs/conf.py
-docs/contributing.rst
 docs/cursor.rst
 docs/database.rst
 docs/document.rst

{python_arango-8.3.4 → python_arango-8.3.6}/python_arango.egg-info/requires.txt

@@ -5,7 +5,7 @@ PyJWT>=2.10.0
 packaging>=23.1
 
 [dev]
-black==26.1.0
+black==26.5.1
 flake8==7.3.0
 isort==5.10.1
 mypy==1.15.0

{python_arango-8.3.4 → python_arango-8.3.6}/python_arango.egg-info/scm_file_list.json

@@ -7,7 +7,7 @@
     ".gitignore",
     ".pre-commit-config.yaml",
     ".readthedocs.yaml",
-    "CONTRIBUTING.md",
+    "AGENTS.md",
     "LICENSE",
     "MANIFEST.in",
     "README.md",
@@ -40,7 +40,6 @@
     "arango/utils.py",
     "arango/version.py",
     "arango/wal.py",
-    "ci/conftest.py",
     "docs/Makefile",
     "docs/admin.rst",
     "docs/analyzer.rst",
@@ -54,7 +53,6 @@
     "docs/collection.rst",
     "docs/compression.rst",
     "docs/conf.py",
-    "docs/contributing.rst",
     "docs/cursor.rst",
     "docs/database.rst",
     "docs/document.rst",
@@ -125,6 +123,7 @@
     "tests/test_transaction.py",
     "tests/test_user.py",
     "tests/test_view.py",
-    "tests/test_wal.py"
+    "tests/test_wal.py",
+    "todo.md"
   ]
 }

python_arango-8.3.6/python_arango.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "8.3.6",
+  "distance": 0,
+  "node": "gc019d8643272db4621ffd7d20795a387618705a8",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-04"
+}

{python_arango-8.3.4 → python_arango-8.3.6}/starter.sh

@@ -4,15 +4,16 @@
 # Useful for testing the python-arango driver against a local ArangoDB setup.
 
 # Usage:
-#   ./starter.sh [single|cluster] [community|enterprise|enterprise-preview] [version]
+#   ./starter.sh [single|cluster] [core-preview|enterprise|enterprise-preview] [version]
 #   ./starter.sh [single|cluster] [image[:tag]]
 # Example:
 #   ./starter.sh cluster enterprise 3.12.4
-#   ./starter.sh single enterprise-preview 4.0-nightly
-#   ./starter.sh single arangodb/enterprise-preview:4.0-nightly
+#   ./starter.sh single core-preview 4.0-nightly
+#   ./starter.sh single arangodb/enterprise-preview:3.12-nightly
+# Defaults: single server, enterprise image, latest version.
 
 setup="${1:-single}"
-image="${2:-community}"
+image="${2:-enterprise}"
 version="${3:-latest}"
 
 extra_ports=""
@@ -35,14 +36,14 @@ if [[ "$image" == */* ]]; then
     else
         image_ref="$image:$version"
     fi
-elif [ "$image" == "community" ]; then
-    image_ref="arangodb/arangodb:$version"
+elif [ "$image" == "core-preview" ]; then
+    image_ref="arangodb/core-preview:$version"
 elif [ "$image" == "enterprise" ]; then
     image_ref="arangodb/enterprise:$version"
 elif [ "$image" == "enterprise-preview" ]; then
     image_ref="arangodb/enterprise-preview:$version"
 else
-    echo "Invalid argument. Please provide 'community', 'enterprise', 'enterprise-preview', or a full image reference."
+    echo "Invalid argument. Please provide 'core-preview', 'enterprise', 'enterprise-preview', or a full image reference."
     exit 1
 fi