Merge pull request #798 from oliverhaas/feat/sorted-set-methods-with-mixins

feat: add sorted set operations and mixins for RedisCache

Author: WisdomPill

.gitignore

@@ -27,3 +27,4 @@ dump.rdb
 .coverage
 coverage.xml
 cobertura.xml
+CLAUDE.md

.ruff.toml

@@ -178,3 +178,6 @@ ban-relative-imports = "all"
 
 # pickle is used on purpose and its use is discouraged
 "django_redis/serializers/pickle.py" = ["S301"]
+
+# min/max are official Redis parameter names matching redis-py API
+"django_redis/client/mixins/sorted_sets.py" = ["A002"]

changelog.d/797.feature

@@ -0,0 +1 @@
+Add sorted set operations (zadd, zrange, zrem, etc.) and mixins for RedisCache

django_redis/cache.py

@@ -278,3 +278,60 @@ def hkeys(self, *args, **kwargs):
     @omit_exception
     def hexists(self, *args, **kwargs):
         return self.client.hexists(*args, **kwargs)
+
+    # Sorted Set Operations
+    @omit_exception
+    def zadd(self, *args, **kwargs):
+        return self.client.zadd(*args, **kwargs)
+
+    @omit_exception
+    def zcard(self, *args, **kwargs):
+        return self.client.zcard(*args, **kwargs)
+
+    @omit_exception
+    def zcount(self, *args, **kwargs):
+        return self.client.zcount(*args, **kwargs)
+
+    @omit_exception
+    def zincrby(self, *args, **kwargs):
+        return self.client.zincrby(*args, **kwargs)
+
+    @omit_exception
+    def zpopmax(self, *args, **kwargs):
+        return self.client.zpopmax(*args, **kwargs)
+
+    @omit_exception
+    def zpopmin(self, *args, **kwargs):
+        return self.client.zpopmin(*args, **kwargs)
+
+    @omit_exception
+    def zrange(self, *args, **kwargs):
+        return self.client.zrange(*args, **kwargs)
+
+    @omit_exception
+    def zrangebyscore(self, *args, **kwargs):
+        return self.client.zrangebyscore(*args, **kwargs)
+
+    @omit_exception
+    def zrank(self, *args, **kwargs):
+        return self.client.zrank(*args, **kwargs)
+
+    @omit_exception
+    def zrem(self, *args, **kwargs):
+        return self.client.zrem(*args, **kwargs)
+
+    @omit_exception
+    def zremrangebyscore(self, *args, **kwargs):
+        return self.client.zremrangebyscore(*args, **kwargs)
+
+    @omit_exception
+    def zrevrange(self, *args, **kwargs):
+        return self.client.zrevrange(*args, **kwargs)
+
+    @omit_exception
+    def zrevrangebyscore(self, *args, **kwargs):
+        return self.client.zrevrangebyscore(*args, **kwargs)
+
+    @omit_exception
+    def zscore(self, *args, **kwargs):
+        return self.client.zscore(*args, **kwargs)

django_redis/client/default.py

@@ -23,6 +23,7 @@
 from redis.typing import AbsExpiryT, EncodableT, ExpiryT, KeyT, PatternT
 
 from django_redis import pool
+from django_redis.client.mixins import SortedSetMixin
 from django_redis.exceptions import CompressorError, ConnectionInterrupted
 from django_redis.util import CacheKey
 
@@ -40,7 +41,7 @@ def glob_escape(s: str) -> str:
     return special_re.sub(r"[\1]", s)
 
 
-class DefaultClient:
+class DefaultClient(SortedSetMixin):
     def __init__(self, server, params: dict[str, Any], backend: BaseCache) -> None:
         self._backend = backend
         self._server = server

django_redis/client/mixins/__init__.py

@@ -0,0 +1,4 @@
+from django_redis.client.mixins.protocols import ClientProtocol
+from django_redis.client.mixins.sorted_sets import SortedSetMixin
+
+__all__ = ["ClientProtocol", "SortedSetMixin"]

django_redis/client/mixins/protocols.py

@@ -0,0 +1,33 @@
+from typing import Any, Optional, Protocol, Union
+
+from redis import Redis
+from redis.typing import KeyT
+
+
+class ClientProtocol(Protocol):
+    """
+    Protocol for client methods required by mixins.
+
+    Any class using django-redis mixins must implement these methods.
+    """
+
+    def make_key(
+        self,
+        key: KeyT,
+        version: Optional[int] = None,
+        prefix: Optional[str] = None,
+    ) -> KeyT:
+        """Create a cache key with optional version and prefix."""
+        ...
+
+    def encode(self, value: Any) -> Union[bytes, int]:
+        """Encode a value for storage in Redis."""
+        ...
+
+    def decode(self, value: Union[bytes, int]) -> Any:
+        """Decode a value retrieved from Redis."""
+        ...
+
+    def get_client(self, write: bool = False) -> Redis:
+        """Get a Redis client instance for read or write operations."""
+        ...