python-arango-async 1.2.5__tar.gz → 1.2.6__tar.gz

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/.circleci/config.yml

@@ -30,11 +30,18 @@ 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, 3.12.9 << matrix.arangodb_config >>)
+          matrix:
+            parameters:
+              arangodb_config: ["single", "cluster"]
+              arangodb_image: ["arangodb/enterprise:3.12.9"]
               arangodb_conf_version: ["3.12"]
       - integration-test:
           name: ArangoDB (core-preview, 4.0-nightly << matrix.arangodb_config >>)
@@ -60,8 +67,8 @@ jobs:
           name: Install Dependencies
           command: python -m pip install .[dev]
       - run:
-            name: Run black
-            command: black --check --verbose --diff --color --config=pyproject.toml ./arangoasync ./tests/
+          name: Run black
+          command: black --check --verbose --diff --color --config=pyproject.toml ./arangoasync ./tests/
       - run:
           name: Run flake8
           command: flake8 ./arangoasync ./tests
@@ -90,12 +97,12 @@ jobs:
           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
+      arangodb_config:
+        type: string
+      arangodb_image:
+        type: string
+      arangodb_conf_version:
+        type: string
     executor:
       name: arangodb-container
       arangodb_image: << parameters.arangodb_image >>

python_arango_async-1.2.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_async-1.2.6/AGENTS.md

@@ -0,0 +1,91 @@
+# Quickstart
+
+python-arango-async is an async Python driver for ArangoDB. Run the commands below from the
+repository root.
+
+## Repository layout
+
+- `arangoasync/`: 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. In this workspace, use
+`/home/apetenchea/programs/pyenv/ida/bin/python` and run tests from
+`/home/apetenchea/arangodb/python-arango-async`, so they exercise this driver.
+
+## 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=arangoasync --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_async-1.2.5 → python_arango_async-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 1.2.5
+Version: 1.2.6
 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>

python_arango_async-1.2.6/arangoasync/version.py

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

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/docs/indexes.rst

@@ -76,7 +76,7 @@ on fields ``_from`` and ``_to``. For more information on indexes, refer to
             },
         )
 
-        # Index creation may succeed even if vector training fails.
+        # Index creation may succeed even if there is insufficient training data.
         if vector_index.training_state != "ready":
             raise RuntimeError(
                 vector_index.error_message or "Vector index is not ready"
@@ -86,7 +86,10 @@ 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 ``training_state`` before
-using it. If training fails permanently, the state is ``"unusable"`` and
-``error_message`` describes the failure.
+using it. If there is insufficient data to train the index, the state is
+``"unusable"`` and ``error_message`` 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 :class:`arangoasync.collection.StandardCollection` for API specification.

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/python_arango_async.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-arango-async
-Version: 1.2.5
+Version: 1.2.6
 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>

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/python_arango_async.egg-info/SOURCES.txt

@@ -1,7 +1,7 @@
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yaml
-CONTRIBUTING.md
+AGENTS.md
 LICENSE
 README.md
 pyproject.toml

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/python_arango_async.egg-info/scm_file_list.json

@@ -7,7 +7,7 @@
     ".gitignore",
     ".pre-commit-config.yaml",
     ".readthedocs.yaml",
-    "CONTRIBUTING.md",
+    "AGENTS.md",
     "LICENSE",
     "README.md",
     "arangoasync/__init__.py",

python_arango_async-1.2.6/python_arango_async.egg-info/scm_version.json

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

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/starter.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Starts a local ArangoDB server or cluster (community or enterprise).
-# Useful for testing the python-arango driver against a local ArangoDB setup.
+# Useful for testing the python-arango-async driver against a local ArangoDB setup.
 
 # Usage:
 #   ./starter.sh [single|cluster] [community|enterprise|enterprise-preview] [version]
@@ -10,9 +10,10 @@
 #   ./starter.sh cluster enterprise 3.12.4
 #   ./starter.sh single enterprise-preview 4.0-nightly
 #   ./starter.sh single arangodb/enterprise-preview:4.0-nightly
+# Defaults: single server, enterprise image, latest version.
 
 setup="${1:-single}"
-image="${2:-community}"
+image="${2:-enterprise}"
 version="${3:-latest}"
 
 extra_ports=""

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/tests/test_collection.py

@@ -337,24 +337,6 @@ async def test_collection_index(doc_col, bad_col, cluster, db_version):
         await doc_col.delete_index(default_index.id)
         await doc_col.delete_index(scaling_index.id)
 
-        # A permanent training failure still creates an unusable index.
-        unusable_index = await doc_col.add_index(
-            "vector",
-            ["embedding1"],
-            {
-                "name": "vector_index_unusable",
-                "params": {
-                    "metric": "cosine",
-                    "dimension": 128,
-                    "nLists": 2,
-                    "factory": "IVF3,Flat",
-                },
-            },
-        )
-        assert unusable_index.training_state == "unusable"
-        assert unusable_index.error_message
-        await doc_col.delete_index(unusable_index.id)
-
         # Invalid requests continue to fail at the HTTP layer.
         with pytest.raises(IndexCreateError) as err:
             await doc_col.add_index(
@@ -378,6 +360,30 @@ async def test_collection_index(doc_col, bad_col, cluster, db_version):
     assert await doc_col.delete_index(idx2.id, ignore_missing=True) is False
 
 
+@pytest.mark.asyncio
+async def test_unusable_vector_index(doc_col, db_version):
+    if db_version < version.parse("3.12.10"):
+        pytest.skip("Unusable vector index test requires ArangoDB 3.12.10+")
+
+    # One training vector is insufficient for two centroids.
+    await doc_col.insert({"embedding": [1.0, 1.0]})
+    index = await doc_col.add_index(
+        "vector",
+        ["embedding"],
+        {
+            "name": "vector_index_unusable",
+            "params": {
+                "metric": "cosine",
+                "dimension": 2,
+                "nLists": 2,
+            },
+        },
+    )
+    assert index.training_state == "unusable"
+    assert index.error_message
+    await doc_col.delete_index(index.id)
+
+
 @pytest.mark.asyncio
 async def test_collection_truncate_count(docs, doc_col, bad_col):
     # Test errors

{python_arango_async-1.2.5 → python_arango_async-1.2.6}/tests/test_user.py

@@ -4,6 +4,7 @@ from arangoasync.auth import Auth
 from arangoasync.errno import USER_NOT_FOUND
 from arangoasync.exceptions import (
     CollectionCreateError,
+    CollectionListError,
     DocumentInsertError,
     PermissionResetError,
     PermissionUpdateError,
@@ -176,6 +177,14 @@ async def test_user_change_permissions(sys_db, arango_client, db):
     with pytest.raises(PermissionResetError):
         await db.reset_permission(username, db.name)
     await sys_db.reset_permission(username, db.name)
+    assert await sys_db.permission(username, db.name) == "none"
+    # ArangoDB 4.0 returns 403 where earlier versions returned 401.
+    with pytest.raises(CollectionCreateError) as err:
+        await db2.create_collection(generate_col_name())
+    assert err.value.http_code in {401, 403}
+    with pytest.raises(CollectionListError) as err:
+        await db2.collections()
+    assert err.value.http_code in {401, 403}
     with pytest.raises(DocumentInsertError):
         await col.insert({"_key": "test"})
 

python_arango_async-1.2.5/.github/workflows/pypi.yaml

@@ -1,40 +0,0 @@
-name: Upload to PyPI
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  upload:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v7
-        with:
-          fetch-depth: 0
-          fetch-tags: true
-
-      - uses: actions/setup-python@v7
-        with:
-          python-version: "3.12"
-
-      - name: Install build dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build twine
-
-      - name: Build package
-        run: python -m build
-
-      - name: Publish to PyPI Test
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.PYPI_TEST_TOKEN }}
-        run: twine upload --verbose --repository testpypi dist/*
-
-      - name: Publish to PyPI
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-        run: twine upload --verbose --repository pypi dist/*

python_arango_async-1.2.5/CONTRIBUTING.md

@@ -1,28 +0,0 @@
-# Contributing
-
-Set up dev environment:
-```shell
-cd ~/your/repository/fork  # Activate venv if you have one (recommended)
-pip install -e .[dev]      # Install dev dependencies (e.g. black, mypy, pre-commit)
-pre-commit install         # Install git pre-commit hooks
-```
-
-Run unit tests with coverage:
-
-```shell
-pytest --cluster --cov=arango --cov-report=html  # Open htmlcov/index.html in your browser
-```
-
-To start and ArangoDB instance locally, run:
-
-```shell
-./starter.sh  # Requires docker
-```
-
-Build and test documentation:
-
-```shell
-python -m sphinx docs docs/_build  # Open docs/_build/index.html in your browser
-```
-
-Thank you for your contribution!

python_arango_async-1.2.5/arangoasync/version.py

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

python_arango_async-1.2.5/python_arango_async.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.2.5",
-  "distance": 0,
-  "node": "g7efe263be99ae30c006413fc1b608b286d7021c1",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-31"
-}