[5.0] Update core.cache.backends, add RedisCache and related classes (#1948)

Author: Viicos

django-stubs/core/cache/backends/base.pyi

@@ -1,4 +1,5 @@
 from collections.abc import Callable, Iterable, Iterator
+from re import Pattern
 from typing import Any
 
 from django.core.exceptions import ImproperlyConfigured
@@ -66,4 +67,6 @@ class BaseCache:
     def close(self, **kwargs: Any) -> None: ...
     async def aclose(self, **kwargs: Any) -> None: ...
 
+memcached_error_chars_re: Pattern[str]
+
 def memcache_key_warnings(key: str) -> Iterator[str]: ...

django-stubs/core/cache/backends/redis.pyi

@@ -0,0 +1,55 @@
+from collections.abc import Mapping
+from datetime import timedelta
+from typing import Any, Callable, Iterable, Protocol, SupportsInt, overload, type_check_only
+
+from _typeshed import ReadableBuffer
+from django.core.cache.backends.base import BaseCache
+from redis._parsers import BaseParser
+from redis.client import Redis
+from redis.connection import ConnectionPool
+from typing_extensions import TypeAlias
+
+@type_check_only
+class _RedisCacheClientSerializer(Protocol):
+    def dumps(self, obj: Any) -> bytes: ...
+    @overload
+    def loads(self, data: SupportsInt) -> int: ...
+    @overload
+    def loads(self, data: ReadableBuffer) -> Any: ...
+
+class RedisSerializer:
+    def __init__(self, protocol: int | None = None) -> None: ...
+    def dumps(self, obj: Any) -> bytes: ...
+    @overload
+    def loads(self, data: SupportsInt) -> int: ...
+    @overload
+    def loads(self, data: ReadableBuffer) -> Any: ...
+
+# Taken from https://github.com/redis/redis-py/blob/6b8978/redis/typing.py
+_Key: TypeAlias = str | bytes | memoryview
+_Expiry: TypeAlias = int | timedelta
+
+class RedisCacheClient:
+    def __init__(
+        self,
+        servers: list[str],
+        serializer: str | Callable[[], _RedisCacheClientSerializer] | _RedisCacheClientSerializer | None = None,
+        pool_class: str | type[ConnectionPool] | None = None,
+        parser_class: str | type[BaseParser] | None = None,
+        **options: Any,
+    ) -> None: ...
+    def get_client(self, key: _Key | None = None, *, write: bool = False) -> Redis: ...
+    def add(self, key: _Key, value: Any, timeout: _Expiry | None) -> bool: ...
+    def get(self, key: _Key, default: Any) -> Any: ...
+    def set(self, key: _Key, value: Any, timeout: _Expiry | None) -> None: ...
+    def touch(self, key: _Key, timeout: _Expiry) -> bool: ...
+    def delete(self, key: _Key) -> bool: ...
+    def get_many(self, keys: Iterable[_Key]) -> dict[_Key, Any]: ...
+    def has_key(self, key: _Key) -> bool: ...
+    def incr(self, key: _Key, delta: int) -> Any: ...
+    def set_many(self, data: Mapping[_Key, Any], timeout: _Expiry) -> None: ...
+    def delete_many(self, keys: Iterable[_Key]) -> None: ...
+    def clear(self) -> bool: ...
+
+class RedisCache(BaseCache):
+    def __init__(self, server: str | list[str], params: dict[str, Any]) -> None: ...

requirements.txt

@@ -11,7 +11,7 @@ psycopg2-binary
 Django==4.2.7; python_version < '3.10'
 Django==5.0.3; python_version >= '3.10'
 -e ./ext
--e .[compatible-mypy]
+-e .[redis,compatible-mypy]
 
 # Overrides:
 mypy==1.9.0

scripts/stubtest/allowlist.txt

@@ -57,6 +57,7 @@ django.contrib.gis.geometry.json_regex
 django.contrib.gis.geometry.wkt_regex
 django.contrib.gis.geos.hex_regex
 django.contrib.gis.geos.wkt_regex
+django.core.cache.backends.base.memcached_error_chars_re
 django.core.validators.EmailValidator.domain_regex
 django.core.validators.EmailValidator.literal_regex
 django.core.validators.EmailValidator.user_regex

scripts/stubtest/allowlist_todo_django50.txt

@@ -61,8 +61,6 @@ django.contrib.sites.migrations.0001_initial
 django.contrib.sites.migrations.0002_alter_domain_unique
 django.contrib.staticfiles.checks.E005
 django.contrib.staticfiles.checks.check_storages
-django.core.cache.backends.base.memcached_error_chars_re
-django.core.cache.backends.redis
 django.core.handlers.asgi.ASGIHandler.get_script_prefix
 django.core.handlers.asgi.ASGIHandler.listen_for_disconnect
 django.core.handlers.asgi.ASGIHandler.run_get_response

setup.py

@@ -32,6 +32,7 @@ def find_stub_files(name: str) -> List[str]:
 # Keep compatible-mypy major.minor version pinned to what we use in CI (requirements.txt)
 extras_require = {
     "compatible-mypy": ["mypy~=1.9.0"],
+    "redis": ["redis"],
 }
 
 setup(