cledar-sdk 2.0.2__py3-none-any.whl → 2.1.0__py3-none-any.whl

cledar/redis/example.py

@@ -0,0 +1,67 @@
+"""Example usage of RedisConfigStore."""
+
+from dataclasses import dataclass
+from typing import Any
+
+from .model import BaseConfigClass
+from .redis_config_store import RedisConfigStore
+
+
+@dataclass
+class ExampleConfig(BaseConfigClass):
+    """Example configuration model."""
+
+    name: str
+    index: int
+    data: dict[str, Any]
+
+
+DEFAULT_CONFIG = ExampleConfig(name="name", index=0, data={})
+CONFIG_KEY = "example_config"
+
+
+class ConfigProvider:
+    """Example provider for configuration using RedisConfigStore."""
+
+    def __init__(self, redis_config_store: RedisConfigStore) -> None:
+        """Initialize the ConfigProvider.
+
+        Args:
+            redis_config_store: The Redis config store instance.
+
+        """
+        self.redis_config_store = redis_config_store
+        if self.redis_config_store.fetch(ExampleConfig, CONFIG_KEY) is None:
+            self.redis_config_store[CONFIG_KEY] = DEFAULT_CONFIG
+
+    def get_example_config(self) -> ExampleConfig:
+        """Get the example configuration.
+
+        Returns:
+            ExampleConfig: The current configuration.
+
+        """
+        return (
+            self.redis_config_store.fetch(ExampleConfig, CONFIG_KEY) or DEFAULT_CONFIG
+        )
+
+    def get_example_config_version(self) -> int:
+        """Get the version of the example configuration.
+
+        Returns:
+            int: The configuration version.
+
+        """
+        return self.redis_config_store.cached_version(CONFIG_KEY) or -1
+
+    def set_example_config(self, config: ExampleConfig | None) -> None:
+        """Set the example configuration.
+
+        Args:
+            config: The new configuration to set.
+
+        """
+        if config is None:
+            return
+
+        self.redis_config_store[CONFIG_KEY] = config

cledar/redis/exceptions.py

@@ -0,0 +1,25 @@
+"""Redis-related exceptions for the Cledar SDK."""
+
+
+class RedisServiceError(Exception):
+    """Base exception for RedisService errors."""
+
+
+class RedisConnectionError(RedisServiceError):
+    """Raised when the Redis connection cannot be established or used."""
+
+
+class RedisClientNotInitializedError(RedisServiceError):
+    """Raised when a Redis operation is attempted without an initialized client."""
+
+
+class RedisSerializationError(RedisServiceError):
+    """Raised when serialization of a value fails before sending to Redis."""
+
+
+class RedisDeserializationError(RedisServiceError):
+    """Raised when deserialization of a value fetched from Redis fails."""
+
+
+class RedisOperationError(RedisServiceError):
+    """Raised for generic Redis operation errors (e.g., command failures)."""

cledar/redis/logger.py

@@ -0,0 +1,5 @@
+"""Logger configuration for the Redis module."""
+
+import logging
+
+logger = logging.getLogger("redis_service")

cledar/redis/model.py

@@ -0,0 +1,14 @@
+"""Base models for Redis-based configuration."""
+
+from dataclasses import dataclass
+from typing import TypeVar
+
+
+@dataclass
+class BaseConfigClass:
+    """Base class for configuration models stored in Redis."""
+
+    pass
+
+
+ConfigAbstract = TypeVar("ConfigAbstract", bound=BaseConfigClass)