openframe-adapters-db-redis 1.1.0__tar.gz

openframe_adapters_db_redis-1.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Miscellaneous
+.DS_Store

openframe_adapters_db_redis-1.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: openframe-adapters-db-redis
+Version: 1.1.0
+Summary: OpenFrame Microservice Suite - Redis key-value adapter.
+Project-URL: Homepage, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Documentation, https://furious-meteors.github.io/openframe-adapters/
+Project-URL: Repository, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Changelog, https://github.com/Furious-Meteors/openframe-adapters/blob/production/.github/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/Furious-Meteors/openframe-adapters/issues
+Author-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+Maintainer-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+License: MIT
+Keywords: cache,hexagonal,microservice,openframe,redis
+Classifier: Development Status :: 5 - Production/Stable
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: openframe-core<3,>=2.0
+Requires-Dist: redis[asyncio]>=5.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openframe-adapters-db-redis
+
+Redis key-value adapter for the **OpenFrame Microservice Development Suite**.
+
+Part of the [`openframe-adapters`](https://github.com/Furious-Meteors/openframe-adapters) monorepo.
+
+---
+
+## What it provides
+
+| Symbol | Purpose |
+|---|---|
+| `RedisSettings` | Pydantic-settings subclass — reads all config from env vars |
+| `RedisRepository[T]` | Generic async repository — `BaseRepository[T]` + `HealthCheck` |
+| `get_redis_client()` | Async factory — creates and caches the `redis.asyncio.Redis` client |
+| `RedisPlugin` | `OpenFramePlugin` — structured lifecycle via `PluginRegistry` |
+
+## Installation
+
+```bash
+# Via meta-package (recommended)
+pip install "openframe-adapters[redis]"
+
+# Or directly
+pip install openframe-adapters-db-redis
+```
+
+## Quick start
+
+```python
+from openframe.adapters.db.redis import RedisSettings, RedisRepository
+
+settings = RedisSettings(redis_url="redis://localhost:6379/0")
+repo = RedisRepository(settings)
+
+# Store and retrieve
+await repo.create({"id": "user-1", "name": "Alice"})
+user = await repo.get("user-1")         # {"id": "user-1", "name": "Alice"}
+await repo.update({"id": "user-1", "name": "Alice B."})
+await repo.delete("user-1")             # True
+```
+
+## Configuration
+
+| Env var | Default | Description |
+|---|---|---|
+| `REDIS_URL` | **required** | `redis://[:password@]host[:port][/db]` or `rediss://` for TLS |
+| `REDIS_MAX_CONNECTIONS` | `10` | Max connections in pool |
+| `REDIS_SOCKET_TIMEOUT` | `5.0` | Socket read/write timeout (seconds) |
+| `REDIS_SOCKET_CONNECT_TIMEOUT` | `5.0` | Connection timeout (seconds) |
+| `REDIS_KEY_PREFIX` | `"openframe"` | Key namespace — keys stored as `{prefix}:{id}` |
+| `REDIS_DEFAULT_TTL` | `0` | TTL in seconds; `0` = no expiry |
+
+## Typed domain objects
+
+```python
+from dataclasses import dataclass
+from openframe.adapters.db.redis import RedisRepository, RedisSettings
+
+@dataclass
+class Session:
+    id: str
+    user_id: str
+    token: str
+
+class SessionRepository(RedisRepository[Session]):
+    def _dict_to_entity(self, data: dict) -> Session:
+        return Session(**data)
+    def _entity_to_dict(self, entity: Session) -> dict:
+        return {"id": entity.id, "user_id": entity.user_id, "token": entity.token}
+```
+
+## Plugin lifecycle (optional)
+
+```python
+from openframe.core.plugins import PluginRegistry
+from openframe.adapters.db.redis import RedisPlugin, RedisSettings
+
+registry = PluginRegistry()
+registry.register(RedisPlugin(RedisSettings()))
+await registry.initialize_all()
+
+plugin = registry.get("cache")          # capability = "cache"
+repo = plugin.get_repository()
+```
+
+## License
+
+MIT — © Furious Meteors Engineering

openframe_adapters_db_redis-1.1.0/README.md

@@ -0,0 +1,89 @@
+# openframe-adapters-db-redis
+
+Redis key-value adapter for the **OpenFrame Microservice Development Suite**.
+
+Part of the [`openframe-adapters`](https://github.com/Furious-Meteors/openframe-adapters) monorepo.
+
+---
+
+## What it provides
+
+| Symbol | Purpose |
+|---|---|
+| `RedisSettings` | Pydantic-settings subclass — reads all config from env vars |
+| `RedisRepository[T]` | Generic async repository — `BaseRepository[T]` + `HealthCheck` |
+| `get_redis_client()` | Async factory — creates and caches the `redis.asyncio.Redis` client |
+| `RedisPlugin` | `OpenFramePlugin` — structured lifecycle via `PluginRegistry` |
+
+## Installation
+
+```bash
+# Via meta-package (recommended)
+pip install "openframe-adapters[redis]"
+
+# Or directly
+pip install openframe-adapters-db-redis
+```
+
+## Quick start
+
+```python
+from openframe.adapters.db.redis import RedisSettings, RedisRepository
+
+settings = RedisSettings(redis_url="redis://localhost:6379/0")
+repo = RedisRepository(settings)
+
+# Store and retrieve
+await repo.create({"id": "user-1", "name": "Alice"})
+user = await repo.get("user-1")         # {"id": "user-1", "name": "Alice"}
+await repo.update({"id": "user-1", "name": "Alice B."})
+await repo.delete("user-1")             # True
+```
+
+## Configuration
+
+| Env var | Default | Description |
+|---|---|---|
+| `REDIS_URL` | **required** | `redis://[:password@]host[:port][/db]` or `rediss://` for TLS |
+| `REDIS_MAX_CONNECTIONS` | `10` | Max connections in pool |
+| `REDIS_SOCKET_TIMEOUT` | `5.0` | Socket read/write timeout (seconds) |
+| `REDIS_SOCKET_CONNECT_TIMEOUT` | `5.0` | Connection timeout (seconds) |
+| `REDIS_KEY_PREFIX` | `"openframe"` | Key namespace — keys stored as `{prefix}:{id}` |
+| `REDIS_DEFAULT_TTL` | `0` | TTL in seconds; `0` = no expiry |
+
+## Typed domain objects
+
+```python
+from dataclasses import dataclass
+from openframe.adapters.db.redis import RedisRepository, RedisSettings
+
+@dataclass
+class Session:
+    id: str
+    user_id: str
+    token: str
+
+class SessionRepository(RedisRepository[Session]):
+    def _dict_to_entity(self, data: dict) -> Session:
+        return Session(**data)
+    def _entity_to_dict(self, entity: Session) -> dict:
+        return {"id": entity.id, "user_id": entity.user_id, "token": entity.token}
+```
+
+## Plugin lifecycle (optional)
+
+```python
+from openframe.core.plugins import PluginRegistry
+from openframe.adapters.db.redis import RedisPlugin, RedisSettings
+
+registry = PluginRegistry()
+registry.register(RedisPlugin(RedisSettings()))
+await registry.initialize_all()
+
+plugin = registry.get("cache")          # capability = "cache"
+repo = plugin.get_repository()
+```
+
+## License
+
+MIT — © Furious Meteors Engineering

openframe_adapters_db_redis-1.1.0/openframe/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_db_redis-1.1.0/openframe/adapters/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_db_redis-1.1.0/openframe/adapters/db/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

openframe_adapters_db_redis-1.1.0/openframe/adapters/db/redis/__init__.py

@@ -0,0 +1,46 @@
+"""
+openframe.adapters.db.redis
+=============================
+Redis key-value adapter for the OpenFrame Microservice Suite.
+
+Public API::
+
+    RedisSettings      — Pydantic Settings subclass for connection config.
+    RedisRepository    — Generic async repository (BaseRepository + HealthCheck).
+    get_redis_client   — Async factory that creates / returns the cached client.
+    RedisPlugin        — OpenFramePlugin implementation for PluginRegistry.
+
+Quick start::
+
+    from openframe.adapters.db.redis import (
+        RedisSettings,
+        RedisRepository,
+        get_redis_client,
+    )
+
+    settings = RedisSettings(redis_url="redis://localhost:6379/0")
+
+    # Raw dict mode
+    repo = RedisRepository(settings)
+    item = await repo.get("abc-123")           # dict | None
+
+    # Typed mode — subclass and override mapping methods
+    class SessionRepository(RedisRepository[Session]):
+        def _dict_to_entity(self, data: dict) -> Session:
+            return Session(**data)
+        def _entity_to_dict(self, entity: Session) -> dict:
+            return entity.model_dump()
+"""
+from __future__ import annotations
+
+from .config import RedisSettings
+from .connection import get_redis_client
+from .plugin import RedisPlugin
+from .repository import RedisRepository
+
+__all__ = [
+    "RedisSettings",
+    "RedisRepository",
+    "get_redis_client",
+    "RedisPlugin",
+]

openframe_adapters_db_redis-1.1.0/openframe/adapters/db/redis/config.py

@@ -0,0 +1,42 @@
+"""
+openframe/adapters/db/redis/config.py
+======================================
+Settings for the Redis adapter, sourced from environment variables via
+``openframe-core``'s ``BaseAdapterSettings`` (pydantic-settings).
+
+Required env vars:
+    REDIS_URL: Redis connection URL.
+               Format: redis://[:password@]host[:port][/db]
+               TLS:    rediss://host:port
+
+Optional env vars (all have defaults):
+    REDIS_MAX_CONNECTIONS:        int   = 10
+    REDIS_SOCKET_TIMEOUT:         float = 5.0
+    REDIS_SOCKET_CONNECT_TIMEOUT: float = 5.0
+    REDIS_KEY_PREFIX:             str   = "openframe"
+    REDIS_DEFAULT_TTL:            int   = 0
+    ADAPTER_NAME:                 str   = "redis"
+"""
+from __future__ import annotations
+
+from openframe.core.config import BaseAdapterSettings
+
+__all__ = ["RedisSettings"]
+
+
+class RedisSettings(BaseAdapterSettings):
+    """
+    Pydantic-settings subclass for the Redis adapter.
+
+    All fields are read from environment variables with the exact names
+    shown above. ``BaseAdapterSettings`` provides ``operation_timeout``
+    (default 30.0 s) and ``connection_timeout`` (default 30.0 s).
+    """
+
+    redis_url: str
+    redis_max_connections: int = 10
+    redis_socket_timeout: float = 5.0
+    redis_socket_connect_timeout: float = 5.0
+    redis_key_prefix: str = "openframe"
+    redis_default_ttl: int = 0
+    adapter_name: str = "redis"

openframe_adapters_db_redis-1.1.0/openframe/adapters/db/redis/connection.py

@@ -0,0 +1,94 @@
+"""
+openframe/adapters/db/redis/connection.py
+==========================================
+Async factory that creates and caches a ``redis.asyncio.Redis`` client.
+
+The client is shared across all ``RedisRepository`` instances in the same
+process. Cache key is the ``REDIS_URL`` string so different URLs each
+maintain an independent client.
+"""
+from __future__ import annotations
+
+import asyncio
+
+import redis.asyncio as aioredis
+import redis.exceptions
+
+from openframe.core.exceptions import (
+    AdapterConfigurationError,
+    AdapterConnectionError,
+    AdapterTimeoutError,
+)
+
+from .config import RedisSettings
+
+__all__ = ["get_redis_client", "_client_cache"]
+
+# Module-level cache: redis_url → redis.asyncio.Redis
+_client_cache: dict[str, aioredis.Redis] = {}  # type: ignore[type-arg]
+
+
+async def get_redis_client(settings: RedisSettings) -> aioredis.Redis:  # type: ignore[type-arg]
+    """
+    Create or return the cached ``redis.asyncio.Redis`` client.
+
+    Creates the client on first call. Subsequent calls with the same
+    ``REDIS_URL`` return the cached instance. The client is shared
+    across all ``RedisRepository`` instances in the same process.
+
+    Args:
+        settings: A ``RedisSettings`` instance.
+
+    Returns:
+        ``redis.asyncio.Redis`` — ready to use, with ``decode_responses=True``.
+
+    Raises:
+        AdapterConnectionError:    Redis server is unreachable or auth failed.
+        AdapterConfigurationError: ``REDIS_URL`` is malformed.
+        AdapterTimeoutError:       Connection attempt exceeded the timeout.
+    """
+    if settings.redis_url in _client_cache:
+        return _client_cache[settings.redis_url]
+
+    try:
+        async with asyncio.timeout(settings.connection_timeout):
+            pool = aioredis.ConnectionPool.from_url(
+                settings.redis_url,
+                max_connections=settings.redis_max_connections,
+                socket_timeout=settings.redis_socket_timeout,
+                socket_connect_timeout=settings.redis_socket_connect_timeout,
+                decode_responses=True,
+            )
+            client: aioredis.Redis = aioredis.Redis(connection_pool=pool)  # type: ignore[type-arg]
+            await client.ping()
+    except asyncio.TimeoutError as exc:
+        raise AdapterTimeoutError(
+            f"Redis connection to {settings.redis_url!r} timed out "
+            f"after {settings.connection_timeout}s",
+            adapter=settings.adapter_name,
+            operation="connect",
+            cause=exc,
+        ) from exc
+    except redis.exceptions.AuthenticationError as exc:
+        raise AdapterConnectionError(
+            f"Redis authentication failed for {settings.redis_url!r}: {exc}",
+            adapter=settings.adapter_name,
+            operation="connect",
+            cause=exc,
+        ) from exc
+    except redis.exceptions.ConnectionError as exc:
+        raise AdapterConnectionError(
+            f"Redis connection failed for {settings.redis_url!r}: {exc}",
+            adapter=settings.adapter_name,
+            operation="connect",
+            cause=exc,
+        ) from exc
+    except redis.exceptions.ResponseError as exc:
+        raise AdapterConfigurationError(
+            f"Redis configuration error for {settings.redis_url!r}: {exc}",
+            adapter=settings.adapter_name,
+            operation="connect",
+        ) from exc
+
+    _client_cache[settings.redis_url] = client
+    return client