archipy-redis 5.11.0__tar.gz

archipy_redis-5.11.0/.gitignore

@@ -0,0 +1,245 @@
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+dist
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+.ruff_cache
+bandit-report.json
+
+.gitattributes

archipy_redis-5.11.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.5
+Name: archipy-redis
+Version: 5.11.0
+Summary: ArchiPy Redis adapter.
+Author-email: Hossein Nejati <hosseinnejati14@gmail.com>
+License-Expression: Apache-2.0
+Requires-Python: <4,>=3.14
+Requires-Dist: archipy==5.11.0
+Requires-Dist: redis[hiredis]>=8.1.0
+Description-Content-Type: text/markdown
+
+# archipy-redis
+
+Redis adapter for [ArchiPy](https://syntaxarc.github.io/ArchiPy/). Install via the core extra:
+
+```bash
+uv add "archipy[redis]"
+```
+
+Imports stay the same: `from archipy.adapters.redis.adapters import RedisAdapter`.

archipy_redis-5.11.0/README.md

@@ -0,0 +1,9 @@
+# archipy-redis
+
+Redis adapter for [ArchiPy](https://syntaxarc.github.io/ArchiPy/). Install via the core extra:
+
+```bash
+uv add "archipy[redis]"
+```
+
+Imports stay the same: `from archipy.adapters.redis.adapters import RedisAdapter`.

archipy_redis-5.11.0/archipy/adapters/redis/__init__.py

@@ -0,0 +1 @@
+"""Redis adapters for ArchiPy."""

archipy_redis-5.11.0/archipy/adapters/redis/adapter_mixins/__init__.py

@@ -0,0 +1,59 @@
+"""Redis adapter mixins package."""
+
+from archipy.adapters.redis.adapter_mixins.arrays import (
+    AsyncRedisArraysMixin,
+    RedisArraysMixin,
+)
+from archipy.adapters.redis.adapter_mixins.cluster import (
+    AsyncRedisClusterMixin,
+    RedisClusterMixin,
+)
+from archipy.adapters.redis.adapter_mixins.connection import (
+    AsyncRedisConnectionMixin,
+    RedisConnectionMixin,
+)
+from archipy.adapters.redis.adapter_mixins.hashes import (
+    AsyncRedisHashesMixin,
+    RedisHashesMixin,
+)
+from archipy.adapters.redis.adapter_mixins.keys import (
+    AsyncRedisKeysMixin,
+    RedisKeysMixin,
+)
+from archipy.adapters.redis.adapter_mixins.lists import (
+    AsyncRedisListsMixin,
+    RedisListsMixin,
+)
+from archipy.adapters.redis.adapter_mixins.pubsub import (
+    AsyncRedisPubSubMixin,
+    RedisPubSubMixin,
+)
+from archipy.adapters.redis.adapter_mixins.sets import (
+    AsyncRedisSetsMixin,
+    RedisSetsMixin,
+)
+from archipy.adapters.redis.adapter_mixins.sorted_sets import (
+    AsyncRedisSortedSetsMixin,
+    RedisSortedSetsMixin,
+)
+
+__all__ = [
+    "AsyncRedisArraysMixin",
+    "AsyncRedisClusterMixin",
+    "AsyncRedisConnectionMixin",
+    "AsyncRedisHashesMixin",
+    "AsyncRedisKeysMixin",
+    "AsyncRedisListsMixin",
+    "AsyncRedisPubSubMixin",
+    "AsyncRedisSetsMixin",
+    "AsyncRedisSortedSetsMixin",
+    "RedisArraysMixin",
+    "RedisClusterMixin",
+    "RedisConnectionMixin",
+    "RedisHashesMixin",
+    "RedisKeysMixin",
+    "RedisListsMixin",
+    "RedisPubSubMixin",
+    "RedisSetsMixin",
+    "RedisSortedSetsMixin",
+]

archipy_redis-5.11.0/archipy/adapters/redis/adapter_mixins/_shared.py

@@ -0,0 +1,102 @@
+"""Shared helpers and attribute bases for Redis adapter mixins."""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable, Iterable, Mapping
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from redis import RedisCluster
+    from redis.asyncio import RedisCluster as AsyncRedisCluster
+    from redis.asyncio.client import Redis as AsyncRedis
+    from redis.client import Redis
+
+    from archipy.configs.config_template import RedisConfig
+
+_set = set
+
+
+class SyncRedisMixinBase:
+    """Shared attribute/method declarations for sync Redis adapter mixins."""
+
+    client: Redis | RedisCluster
+    read_only_client: Redis | RedisCluster
+    _configs: RedisConfig
+    _search_client: Redis | RedisCluster | None
+
+    @staticmethod
+    def _ensure_sync_int(value: int | Awaitable[int]) -> int:
+        """Coerce sync Redis int responses that may be typed as Awaitable."""
+        raise NotImplementedError
+
+
+class AsyncRedisMixinBase:
+    """Shared attribute/method declarations for async Redis adapter mixins."""
+
+    client: AsyncRedis | AsyncRedisCluster
+    read_only_client: AsyncRedis | AsyncRedisCluster
+    _configs: RedisConfig
+    _search_client: AsyncRedis | AsyncRedisCluster | None
+
+    @staticmethod
+    async def _ensure_async_int(value: int | Awaitable[int]) -> int:
+        """Coerce async Redis int responses that may be typed as Awaitable."""
+        raise NotImplementedError
+
+    @staticmethod
+    async def _ensure_async_bool(value: bool | Awaitable[bool]) -> bool:
+        """Coerce async Redis bool responses that may be typed as Awaitable."""
+        raise NotImplementedError
+
+    @staticmethod
+    async def _ensure_async_str(
+        value: str | bytes | Awaitable[str | bytes | None] | None,
+    ) -> str | None:
+        """Coerce async Redis string responses that may be typed as Awaitable."""
+        raise NotImplementedError
+
+    @staticmethod
+    async def _ensure_async_list(value: list[Any] | Awaitable[list[Any]]) -> list[Any]:
+        """Coerce async Redis list responses that may be typed as Awaitable."""
+        raise NotImplementedError
+
+
+def _redis_connection_kwargs(configs: RedisConfig, *, decode_responses: bool | None = None) -> dict[str, Any]:
+    """Build common Redis client connection kwargs from config."""
+    return {
+        "password": configs.PASSWORD,
+        "decode_responses": (configs.DECODE_RESPONSES if decode_responses is None else decode_responses),
+        "health_check_interval": configs.HEALTH_CHECK_INTERVAL,
+        "max_connections": configs.MAX_CONNECTIONS,
+        "socket_connect_timeout": configs.SOCKET_CONNECT_TIMEOUT,
+        "socket_timeout": configs.SOCKET_TIMEOUT,
+        "protocol": configs.PROTOCOL,
+    }
+
+
+def _sentinel_redis_kwargs(configs: RedisConfig) -> dict[str, Any]:
+    """Build Redis kwargs for sentinel master_for/slave_for connections."""
+    return {
+        "socket_timeout": configs.SOCKET_TIMEOUT,
+        "socket_connect_timeout": configs.SOCKET_CONNECT_TIMEOUT,
+        "max_connections": configs.MAX_CONNECTIONS,
+        "password": configs.PASSWORD,
+        "decode_responses": configs.DECODE_RESPONSES,
+        "protocol": configs.PROTOCOL,
+    }
+
+
+def _sentinel_kwargs(configs: RedisConfig) -> dict[str, str] | None:
+    """Build sentinel-node auth kwargs when SENTINEL_PASSWORD is set."""
+    if configs.SENTINEL_PASSWORD:
+        return {"password": configs.SENTINEL_PASSWORD}
+    return None
+
+
+def _normalize_zset_keys(
+    keys: Mapping[bytes | str, float] | Iterable[bytes | str],
+) -> dict[str, float] | list[str]:
+    """Normalize sorted-set keys for zunion/zinter into a form the Redis client accepts."""
+    if isinstance(keys, Mapping):
+        return {str(key): float(value) for key, value in keys.items()}
+    return [str(key) for key in keys]

archipy_redis-5.11.0/archipy/adapters/redis/adapter_mixins/arrays.py

@@ -0,0 +1,151 @@
+"""Redis adapter mixins for arrays operations."""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable
+
+from archipy.adapters.redis.adapter_mixins._shared import (
+    AsyncRedisMixinBase,
+    SyncRedisMixinBase,
+)
+
+
+class RedisArraysMixin(SyncRedisMixinBase):
+    """Sync Redis mixin for arrays operations."""
+
+    def arset(self, name: bytes | str, index: int, *values: bytes | str | float) -> int:
+        """Set one or more contiguous values in an array.
+
+        Args:
+            name (bytes | str): The key of the array.
+            index (int): The starting index to set values at.
+            *values (bytes | str | float): Values to store at consecutive indices.
+
+        Returns:
+            RedisResponseType: The number of previously empty slots that were set.
+        """
+        result = self.client.arset(name, index, *values)
+        return self._ensure_sync_int(result)
+
+    def arget(self, name: bytes | str, index: int) -> bytes | str | None:
+        """Get the value at an index in an array.
+
+        Args:
+            name (bytes | str): The key of the array.
+            index (int): The index to read.
+
+        Returns:
+            RedisResponseType: The value at the index, or None if unset.
+        """
+        return self.read_only_client.arget(name, index)
+
+    def arlen(self, name: bytes | str) -> int:
+        """Get the number of populated elements in an array.
+
+        Args:
+            name (bytes | str): The key of the array.
+
+        Returns:
+            RedisResponseType: The number of populated elements.
+        """
+        result = self.read_only_client.arlen(name)
+        return self._ensure_sync_int(result)
+
+    def ardel(self, name: bytes | str, *indices: int) -> int:
+        """Delete one or more indices from an array.
+
+        Args:
+            name (bytes | str): The key of the array.
+            *indices (int): Indices to delete.
+
+        Returns:
+            RedisResponseType: The number of elements deleted.
+        """
+        result = self.client.ardel(name, *indices)
+        return self._ensure_sync_int(result)
+
+    def arring(self, name: bytes | str, size: int, *values: bytes | str | float) -> int:
+        """Insert values into an array as a fixed-size ring buffer.
+
+        Args:
+            name (bytes | str): The key of the array.
+            size (int): The fixed size of the ring buffer.
+            *values (bytes | str | float): Values to insert.
+
+        Returns:
+            RedisResponseType: The last index where a value was inserted.
+        """
+        result = self.client.arring(name, size, *values)
+        return self._ensure_sync_int(result)
+
+
+class AsyncRedisArraysMixin(AsyncRedisMixinBase):
+    """Async Redis mixin for arrays operations."""
+
+    async def arset(self, name: bytes | str, index: int, *values: bytes | str | float) -> int:
+        """Set one or more contiguous values in an array asynchronously.
+
+        Args:
+            name (bytes | str): The key of the array.
+            index (int): The starting index to set values at.
+            *values (bytes | str | float): Values to store at consecutive indices.
+
+        Returns:
+            RedisResponseType: The number of previously empty slots that were set.
+        """
+        result = self.client.arset(name, index, *values)
+        return await self._ensure_async_int(result)
+
+    async def arget(self, name: bytes | str, index: int) -> bytes | str | None:
+        """Get the value at an index in an array asynchronously.
+
+        Args:
+            name (bytes | str): The key of the array.
+            index (int): The index to read.
+
+        Returns:
+            RedisResponseType: The value at the index, or None if unset.
+        """
+        result = self.read_only_client.arget(name, index)
+        if isinstance(result, Awaitable):
+            return await result
+        return result
+
+    async def arlen(self, name: bytes | str) -> int:
+        """Get the number of populated elements in an array asynchronously.
+
+        Args:
+            name (bytes | str): The key of the array.
+
+        Returns:
+            RedisResponseType: The number of populated elements.
+        """
+        result = self.read_only_client.arlen(name)
+        return await self._ensure_async_int(result)
+
+    async def ardel(self, name: bytes | str, *indices: int) -> int:
+        """Delete one or more indices from an array asynchronously.
+
+        Args:
+            name (bytes | str): The key of the array.
+            *indices (int): Indices to delete.
+
+        Returns:
+            RedisResponseType: The number of elements deleted.
+        """
+        result = self.client.ardel(name, *indices)
+        return await self._ensure_async_int(result)
+
+    async def arring(self, name: bytes | str, size: int, *values: bytes | str | float) -> int:
+        """Insert values into an array as a fixed-size ring buffer asynchronously.
+
+        Args:
+            name (bytes | str): The key of the array.
+            size (int): The fixed size of the ring buffer.
+            *values (bytes | str | float): Values to insert.
+
+        Returns:
+            RedisResponseType: The last index where a value was inserted.
+        """
+        result = self.client.arring(name, size, *values)
+        return await self._ensure_async_int(result)

archipy_redis-5.11.0/archipy/adapters/redis/adapter_mixins/cluster.py

@@ -0,0 +1,97 @@
+"""Redis adapter mixins for cluster operations."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from redis import RedisCluster
+from redis.asyncio import RedisCluster as AsyncRedisCluster
+
+from archipy.adapters.redis.adapter_mixins._shared import (
+    AsyncRedisMixinBase,
+    SyncRedisMixinBase,
+)
+
+
+class RedisClusterMixin(SyncRedisMixinBase):
+    """Sync Redis mixin for cluster operations."""
+
+    def cluster_info(self) -> dict[str, str] | None:
+        """Get cluster information."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_info()
+        return None
+
+    def cluster_nodes(
+        self,
+    ) -> dict[str, dict[str, str | bool | list[list[str]] | list[dict[str, str]]]] | None:
+        """Get cluster nodes information."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_nodes()
+        return None
+
+    def cluster_slots(self) -> list[Any] | None:
+        """Get cluster slots mapping."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_slots()
+        return None
+
+    def cluster_key_slot(self, key: str) -> int | None:
+        """Get the hash slot for a key."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_keyslot(key)
+        return None
+
+    def cluster_count_keys_in_slot(self, slot: int) -> int | None:
+        """Count keys in a specific slot."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_countkeysinslot(slot)
+        return None
+
+    def cluster_get_keys_in_slot(self, slot: int, count: int) -> list[bytes | str] | None:
+        """Get keys in a specific slot."""
+        if isinstance(self.client, RedisCluster):
+            return self.client.cluster_get_keys_in_slot(slot, count)
+        return None
+
+
+class AsyncRedisClusterMixin(AsyncRedisMixinBase):
+    """Async Redis mixin for cluster operations."""
+
+    async def cluster_info(self) -> dict[str, str] | None:
+        """Get cluster information asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_info()
+        return None
+
+    async def cluster_nodes(
+        self,
+    ) -> dict[str, dict[str, str | bool | list[list[str]] | list[dict[str, str]]]] | None:
+        """Get cluster nodes information asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_nodes()
+        return None
+
+    async def cluster_slots(self) -> list[Any] | None:
+        """Get cluster slots mapping asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_slots()
+        return None
+
+    async def cluster_key_slot(self, key: str) -> int | None:
+        """Get the hash slot for a key asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_keyslot(key)
+        return None
+
+    async def cluster_count_keys_in_slot(self, slot: int) -> int | None:
+        """Count keys in a specific slot asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_countkeysinslot(slot)
+        return None
+
+    async def cluster_get_keys_in_slot(self, slot: int, count: int) -> list[bytes | str] | None:
+        """Get keys in a specific slot asynchronously."""
+        if isinstance(self.client, AsyncRedisCluster):
+            return await self.client.cluster_get_keys_in_slot(slot, count)
+        return None