dqlite-client 0.1.0__tar.gz

dqlite_client-0.1.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v5
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dqlite-client
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

dqlite_client-0.1.0/.gitignore

@@ -0,0 +1,46 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# mypy
+.mypy_cache/
+
+# Distribution
+dist/
+build/

dqlite_client-0.1.0/DEVELOPMENT.md

@@ -0,0 +1,71 @@
+# Development Guide
+
+## Prerequisites
+
+- Python 3.13+
+- [uv](https://github.com/astral-sh/uv) - Fast Python package manager
+- Docker (for integration tests)
+
+## Setup
+
+Start by also cloning [dqlite-wire](https://github.com/letsdiscodev/python-dqlite-wire).
+
+```bash
+# Install uv (if not already installed)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Create virtual environment and install dependencies
+uv venv --python 3.13
+uv pip install -e "../python-dqlite-wire" -e ".[dev]"
+```
+
+## Development Tools
+
+| Tool | Purpose | Command |
+|------|---------|---------|
+| **pytest** | Testing framework | `pytest` |
+| **ruff** | Linter (replaces flake8, isort, etc.) | `ruff check` |
+| **ruff format** | Code formatter (replaces black) | `ruff format` |
+| **mypy** | Static type checker | `mypy src` |
+
+## Running Tests
+
+```bash
+# Run unit tests only
+.venv/bin/pytest tests/ --ignore=tests/integration
+
+# Run all tests (requires Docker cluster)
+cd ../dqlite-test-cluster && docker compose up -d
+.venv/bin/pytest tests/
+
+# Run with verbose output
+.venv/bin/pytest -v
+```
+
+## Linting & Formatting
+
+```bash
+# Lint
+.venv/bin/ruff check src tests
+
+# Auto-fix lint issues
+.venv/bin/ruff check --fix src tests
+
+# Format
+.venv/bin/ruff format src tests
+```
+
+## Type Checking
+
+```bash
+.venv/bin/mypy src
+```
+
+## Pre-commit Workflow
+
+```bash
+.venv/bin/ruff format src tests
+.venv/bin/ruff check --fix src tests
+.venv/bin/mypy src
+.venv/bin/pytest tests/ --ignore=tests/integration
+```

dqlite_client-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: dqlite-client
+Version: 0.1.0
+Summary: Async Python client for dqlite with connection pooling and leader detection
+Project-URL: Homepage, https://github.com/letsdiscodev/python-dqlite-client
+Project-URL: Repository, https://github.com/letsdiscodev/python-dqlite-client
+Project-URL: Issues, https://github.com/letsdiscodev/python-dqlite-client/issues
+Author-email: Antoine Leclair <antoineleclair@gmail.com>
+License-Expression: MIT
+Keywords: async,asyncio,database,distributed,dqlite,sqlite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: dqlite-wire>=0.1.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == 'yaml'
+Description-Content-Type: text/markdown
+
+# dqlite-client
+
+Async Python client for [dqlite](https://dqlite.io/), following asyncpg patterns.
+
+## Installation
+
+```bash
+pip install dqlite-client
+```
+
+## Usage
+
+```python
+import asyncio
+from dqliteclient import connect
+
+async def main():
+    conn = await connect("localhost:9001")
+    async with conn.transaction():
+        await conn.execute("CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY, name TEXT)")
+        await conn.execute("INSERT INTO test (name) VALUES (?)", ["hello"])
+        rows = await conn.fetch("SELECT * FROM test")
+        for row in rows:
+            print(row)
+    await conn.close()
+
+asyncio.run(main())
+```
+
+## Connection Pooling
+
+```python
+from dqliteclient import create_pool
+
+pool = await create_pool(["localhost:9001", "localhost:9002", "localhost:9003"])
+async with pool.acquire() as conn:
+    rows = await conn.fetch("SELECT 1")
+```
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for setup and contribution guidelines.
+
+## License
+
+MIT

dqlite_client-0.1.0/README.md

@@ -0,0 +1,46 @@
+# dqlite-client
+
+Async Python client for [dqlite](https://dqlite.io/), following asyncpg patterns.
+
+## Installation
+
+```bash
+pip install dqlite-client
+```
+
+## Usage
+
+```python
+import asyncio
+from dqliteclient import connect
+
+async def main():
+    conn = await connect("localhost:9001")
+    async with conn.transaction():
+        await conn.execute("CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY, name TEXT)")
+        await conn.execute("INSERT INTO test (name) VALUES (?)", ["hello"])
+        rows = await conn.fetch("SELECT * FROM test")
+        for row in rows:
+            print(row)
+    await conn.close()
+
+asyncio.run(main())
+```
+
+## Connection Pooling
+
+```python
+from dqliteclient import create_pool
+
+pool = await create_pool(["localhost:9001", "localhost:9002", "localhost:9003"])
+async with pool.acquire() as conn:
+    rows = await conn.fetch("SELECT 1")
+```
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md) for setup and contribution guidelines.
+
+## License
+
+MIT

dqlite_client-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dqlite-client"
+version = "0.1.0"
+description = "Async Python client for dqlite with connection pooling and leader detection"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "MIT"
+authors = [{ name = "Antoine Leclair", email = "antoineleclair@gmail.com" }]
+keywords = ["dqlite", "sqlite", "distributed", "database", "async", "asyncio"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Database :: Database Engines/Servers",
+    "Typing :: Typed",
+]
+dependencies = ["dqlite-wire>=0.1.0"]
+
+[project.urls]
+Homepage = "https://github.com/letsdiscodev/python-dqlite-client"
+Repository = "https://github.com/letsdiscodev/python-dqlite-client"
+Issues = "https://github.com/letsdiscodev/python-dqlite-client/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "pytest-cov>=4.0", "pytest-asyncio>=0.23", "mypy>=1.0", "ruff>=0.4"]
+yaml = ["pyyaml>=6.0"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dqliteclient"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.mypy]
+strict = true
+python_version = "3.13"
+
+[tool.ruff]
+target-version = "py313"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["dqliteclient", "dqlitewire"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true

dqlite_client-0.1.0/src/dqliteclient/__init__.py

@@ -0,0 +1,82 @@
+"""Async Python client for dqlite."""
+
+from dqliteclient.cluster import ClusterClient
+from dqliteclient.connection import DqliteConnection
+from dqliteclient.exceptions import (
+    ClusterError,
+    ConnectionError,
+    DqliteError,
+    OperationalError,
+    ProtocolError,
+)
+from dqliteclient.node_store import MemoryNodeStore, NodeStore
+from dqliteclient.pool import ConnectionPool
+
+__all__ = [
+    "connect",
+    "create_pool",
+    "DqliteConnection",
+    "ConnectionPool",
+    "ClusterClient",
+    "NodeStore",
+    "MemoryNodeStore",
+    "DqliteError",
+    "ConnectionError",
+    "ProtocolError",
+    "ClusterError",
+    "OperationalError",
+]
+
+__version__ = "0.1.0"
+
+
+async def connect(
+    address: str,
+    *,
+    database: str = "default",
+    timeout: float = 10.0,
+) -> DqliteConnection:
+    """Connect to a dqlite node.
+
+    Args:
+        address: Node address in "host:port" format
+        database: Database name to open
+        timeout: Connection timeout in seconds
+
+    Returns:
+        A connected DqliteConnection
+    """
+    conn = DqliteConnection(address, database=database, timeout=timeout)
+    await conn.connect()
+    return conn
+
+
+async def create_pool(
+    addresses: list[str],
+    *,
+    database: str = "default",
+    min_size: int = 1,
+    max_size: int = 10,
+    timeout: float = 10.0,
+) -> ConnectionPool:
+    """Create a connection pool with automatic leader detection.
+
+    Args:
+        addresses: List of node addresses in "host:port" format
+        database: Database name to open
+        min_size: Minimum number of connections to maintain
+        max_size: Maximum number of connections
+        timeout: Connection timeout in seconds
+
+    Returns:
+        An initialized ConnectionPool
+    """
+    pool = ConnectionPool(
+        addresses,
+        database=database,
+        min_size=min_size,
+        max_size=max_size,
+        timeout=timeout,
+    )
+    await pool.initialize()
+    return pool

dqlite_client-0.1.0/src/dqliteclient/cluster.py

@@ -0,0 +1,105 @@
+"""Cluster management and leader detection for dqlite."""
+
+import asyncio
+
+from dqliteclient.connection import DqliteConnection
+from dqliteclient.exceptions import ClusterError
+from dqliteclient.node_store import MemoryNodeStore, NodeInfo, NodeStore
+from dqliteclient.protocol import DqliteProtocol
+from dqliteclient.retry import retry_with_backoff
+
+
+class ClusterClient:
+    """Client with automatic leader detection and failover."""
+
+    def __init__(
+        self,
+        node_store: NodeStore,
+        *,
+        timeout: float = 10.0,
+    ) -> None:
+        """Initialize cluster client.
+
+        Args:
+            node_store: Store for cluster node information
+            timeout: Connection timeout in seconds
+        """
+        self._node_store = node_store
+        self._timeout = timeout
+        self._leader_address: str | None = None
+
+    @classmethod
+    def from_addresses(cls, addresses: list[str], timeout: float = 10.0) -> "ClusterClient":
+        """Create cluster client from list of addresses."""
+        store = MemoryNodeStore(addresses)
+        return cls(store, timeout=timeout)
+
+    async def find_leader(self) -> str:
+        """Find the current cluster leader.
+
+        Returns the leader address.
+        """
+        nodes = await self._node_store.get_nodes()
+
+        if not nodes:
+            raise ClusterError("No nodes configured")
+
+        errors: list[str] = []
+
+        for node in nodes:
+            try:
+                leader_address = await self._query_leader(node.address)
+                if leader_address:
+                    self._leader_address = leader_address
+                    return leader_address
+            except Exception as e:
+                errors.append(f"{node.address}: {e}")
+                continue
+
+        raise ClusterError(f"Could not find leader. Errors: {'; '.join(errors)}")
+
+    async def _query_leader(self, address: str) -> str | None:
+        """Query a node for the current leader."""
+        host, port_str = address.rsplit(":", 1)
+        port = int(port_str)
+
+        try:
+            reader, writer = await asyncio.wait_for(
+                asyncio.open_connection(host, port),
+                timeout=self._timeout,
+            )
+        except (TimeoutError, OSError):
+            return None
+
+        protocol = DqliteProtocol(reader, writer)
+
+        try:
+            await protocol.handshake()
+            node_id, leader_addr = await protocol.get_leader()
+
+            # If address is empty, this node is the leader
+            if not leader_addr:
+                return address
+
+            return leader_addr
+        finally:
+            protocol.close()
+            await protocol.wait_closed()
+
+    async def connect(self, database: str = "default") -> DqliteConnection:
+        """Connect to the cluster leader.
+
+        Returns a connection to the current leader.
+        """
+
+        async def try_connect() -> DqliteConnection:
+            leader = await self.find_leader()
+            conn = DqliteConnection(leader, database=database, timeout=self._timeout)
+            await conn.connect()
+            return conn
+
+        return await retry_with_backoff(try_connect, max_attempts=5)
+
+    async def update_nodes(self, nodes: list[NodeInfo]) -> None:
+        """Update the node store with new node information."""
+        await self._node_store.set_nodes(nodes)

dqlite_client-0.1.0/src/dqliteclient/connection.py

@@ -0,0 +1,146 @@
+"""High-level connection interface for dqlite."""
+
+import asyncio
+from collections.abc import AsyncIterator
+from contextlib import asynccontextmanager
+from typing import Any
+
+from dqliteclient.exceptions import ConnectionError
+from dqliteclient.protocol import DqliteProtocol
+
+
+class DqliteConnection:
+    """High-level async connection to a dqlite database."""
+
+    def __init__(
+        self,
+        address: str,
+        *,
+        database: str = "default",
+        timeout: float = 10.0,
+    ) -> None:
+        """Initialize connection (does not connect yet).
+
+        Args:
+            address: Node address in "host:port" format
+            database: Database name to open
+            timeout: Connection timeout in seconds
+        """
+        self._address = address
+        self._database = database
+        self._timeout = timeout
+        self._protocol: DqliteProtocol | None = None
+        self._db_id: int | None = None
+        self._in_transaction = False
+
+    @property
+    def address(self) -> str:
+        """Get the connection address."""
+        return self._address
+
+    @property
+    def is_connected(self) -> bool:
+        """Check if connected."""
+        return self._protocol is not None
+
+    async def connect(self) -> None:
+        """Establish connection to the database."""
+        if self._protocol is not None:
+            return
+
+        host, port_str = self._address.rsplit(":", 1)
+        port = int(port_str)
+
+        try:
+            reader, writer = await asyncio.wait_for(
+                asyncio.open_connection(host, port),
+                timeout=self._timeout,
+            )
+        except TimeoutError as e:
+            raise ConnectionError(f"Connection to {self._address} timed out") from e
+        except OSError as e:
+            raise ConnectionError(f"Failed to connect to {self._address}: {e}") from e
+
+        self._protocol = DqliteProtocol(reader, writer)
+
+        try:
+            await self._protocol.handshake()
+            self._db_id = await self._protocol.open_database(self._database)
+        except Exception:
+            self._protocol.close()
+            self._protocol = None
+            raise
+
+    async def close(self) -> None:
+        """Close the connection."""
+        if self._protocol is not None:
+            self._protocol.close()
+            await self._protocol.wait_closed()
+            self._protocol = None
+            self._db_id = None
+
+    async def __aenter__(self) -> "DqliteConnection":
+        await self.connect()
+        return self
+
+    async def __aexit__(self, *args: Any) -> None:
+        await self.close()
+
+    def _ensure_connected(self) -> tuple[DqliteProtocol, int]:
+        """Ensure we're connected and return protocol and db_id."""
+        if self._protocol is None or self._db_id is None:
+            raise ConnectionError("Not connected")
+        return self._protocol, self._db_id
+
+    async def execute(self, sql: str, params: list[Any] | None = None) -> tuple[int, int]:
+        """Execute a SQL statement.
+
+        Returns (last_insert_id, rows_affected).
+        """
+        protocol, db_id = self._ensure_connected()
+        return await protocol.exec_sql(db_id, sql, params)
+
+    async def fetch(self, sql: str, params: list[Any] | None = None) -> list[dict[str, Any]]:
+        """Execute a query and return results as list of dicts."""
+        protocol, db_id = self._ensure_connected()
+        columns, rows = await protocol.query_sql(db_id, sql, params)
+        return [dict(zip(columns, row, strict=True)) for row in rows]
+
+    async def fetchall(self, sql: str, params: list[Any] | None = None) -> list[list[Any]]:
+        """Execute a query and return results as list of lists."""
+        protocol, db_id = self._ensure_connected()
+        _, rows = await protocol.query_sql(db_id, sql, params)
+        return rows
+
+    async def fetchone(self, sql: str, params: list[Any] | None = None) -> dict[str, Any] | None:
+        """Execute a query and return the first result."""
+        results = await self.fetch(sql, params)
+        return results[0] if results else None
+
+    async def fetchval(self, sql: str, params: list[Any] | None = None) -> Any:
+        """Execute a query and return the first column of the first row."""
+        protocol, db_id = self._ensure_connected()
+        _, rows = await protocol.query_sql(db_id, sql, params)
+        if rows and rows[0]:
+            return rows[0][0]
+        return None
+
+    @asynccontextmanager
+    async def transaction(self) -> AsyncIterator[None]:
+        """Context manager for transactions."""
+        if self._in_transaction:
+            # Nested transaction - just yield
+            yield
+            return
+
+        await self.execute("BEGIN")
+        self._in_transaction = True
+
+        try:
+            yield
+            await self.execute("COMMIT")
+        except Exception:
+            await self.execute("ROLLBACK")
+            raise
+        finally:
+            self._in_transaction = False