Update redis stubs to 4.1 (#6711)

Co-authored-by: Akuli <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

stubs/redis/@tests/stubtest_allowlist.txt

@@ -1 +1,2 @@
 redis.client.Pipeline.transaction  # instance attribute has same name as superclass method
+redis.ocsp  # requires cryptography to be installed

stubs/redis/METADATA.toml

@@ -1,2 +1 @@
-version = "4.0.*"
-requires = []
+version = "4.1.*"

stubs/redis/redis/__init__.pyi

@@ -1,5 +1,34 @@
 from . import client, connection, exceptions, sentinel, utils
 
+__all__ = [
+    "AuthenticationError",
+    "AuthenticationWrongNumberOfArgsError",
+    "BlockingConnectionPool",
+    "BusyLoadingError",
+    "ChildDeadlockedError",
+    "Connection",
+    "ConnectionError",
+    "ConnectionPool",
+    "DataError",
+    "from_url",
+    "InvalidResponse",
+    "PubSubError",
+    "ReadOnlyError",
+    "Redis",
+    "RedisCluster",
+    "RedisError",
+    "ResponseError",
+    "Sentinel",
+    "SentinelConnectionPool",
+    "SentinelManagedConnection",
+    "SentinelManagedSSLConnection",
+    "SSLConnection",
+    "StrictRedis",
+    "TimeoutError",
+    "UnixDomainSocketConnection",
+    "WatchError",
+]
+
 Redis = client.Redis
 
 BlockingConnectionPool = connection.BlockingConnectionPool

stubs/redis/redis/client.pyi

@@ -1,4 +1,3 @@
-import builtins
 import threading
 from _typeshed import Self, SupportsItems
 from datetime import datetime, timedelta
@@ -36,6 +35,10 @@ _StrType = TypeVar("_StrType", bound=Union[str, bytes])
 _VT = TypeVar("_VT")
 _T = TypeVar("_T")
 
+SYM_EMPTY: bytes
+EMPTY_RESPONSE: str
+NEVER_DECODE: str
+
 class CaseInsensitiveDict(Dict[_StrType, _VT]):
     def __init__(self, data: SupportsItems[_StrType, _VT]) -> None: ...
     def update(self, data: SupportsItems[_StrType, _VT]) -> None: ...  # type: ignore[override]
@@ -45,15 +48,15 @@ class CaseInsensitiveDict(Dict[_StrType, _VT]):
     def get(self, k: _StrType, default: _VT | _T) -> _VT | _T: ...
     # Overrides many other methods too, but without changing signature
 
-SYM_EMPTY: Any
-SENTINEL_STATE_TYPES: Any
-
 def list_or_args(keys, args): ...
 def timestamp_to_datetime(response): ...
 def string_keys_to_dict(key_string, callback): ...
 def parse_debug_object(response): ...
 def parse_object(response, infotype): ...
 def parse_info(response): ...
+
+SENTINEL_STATE_TYPES: dict[str, type[int]]
+
 def parse_sentinel_state(item): ...
 def parse_sentinel_master(response): ...
 def parse_sentinel_masters(response): ...
@@ -166,18 +169,23 @@ class Redis(RedisModuleCommands, CoreCommands[_StrType], SentinelCommands, Gener
         errors: str | None,
         decode_responses: Literal[True],
         retry_on_timeout: bool = ...,
+        retry_on_error=...,
         ssl: bool = ...,
         ssl_keyfile: str | None = ...,
         ssl_certfile: str | None = ...,
         ssl_cert_reqs: str | int | None = ...,
         ssl_ca_certs: str | None = ...,
+        ssl_ca_path: Any | None = ...,
         ssl_check_hostname: bool = ...,
+        ssl_password: Any | None = ...,
+        ssl_validate_ocsp: bool = ...,
         max_connections: int | None = ...,
         single_connection_client: bool = ...,
         health_check_interval: float = ...,
         client_name: str | None = ...,
         username: str | None = ...,
         retry: Retry | None = ...,
+        redis_connect_func: Any | None = ...,
     ) -> None: ...
     @overload
     def __init__(
@@ -211,6 +219,7 @@ class Redis(RedisModuleCommands, CoreCommands[_StrType], SentinelCommands, Gener
         client_name: str | None = ...,
         username: str | None = ...,
         retry: Retry | None = ...,
+        redis_connect_func: Any | None = ...,
     ) -> None: ...
     @overload
     def __init__(
@@ -243,7 +252,10 @@ class Redis(RedisModuleCommands, CoreCommands[_StrType], SentinelCommands, Gener
         client_name: str | None = ...,
         username: str | None = ...,
         retry: Retry | None = ...,
+        redis_connect_func: Any | None = ...,
     ) -> None: ...
+    def get_encoder(self): ...
+    def get_connection_kwargs(self): ...
     def set_response_callback(self, command, callback): ...
     def pipeline(self, transaction: bool = ..., shard_hint: Any = ...) -> Pipeline[_StrType]: ...
     def transaction(self, func, *watches, **kwargs): ...
@@ -281,179 +293,7 @@ class Redis(RedisModuleCommands, CoreCommands[_StrType], SentinelCommands, Gener
     def pubsub(self, *, shard_hint: Any = ..., ignore_subscribe_messages: bool = ...) -> PubSub: ...
     def execute_command(self, *args, **options): ...
     def parse_response(self, connection, command_name, **options): ...
-    # TODO: Most of the following methods must be moved to the command classes.
-    def readwrite(self) -> bool: ...
-    def readonly(self) -> bool: ...
-    def config_get(self, pattern=...): ...
-    def config_set(self, name, value): ...
-    def config_resetstat(self): ...
-    def config_rewrite(self): ...
-    def dbsize(self) -> int: ...
-    def debug_object(self, key): ...
-    def echo(self, value: _Value) -> bytes: ...
-    def info(self, section: _Key | None = ...) -> Mapping[str, Any]: ...
-    def lastsave(self): ...
-    def object(self, infotype, key): ...
-    def ping(self) -> bool: ...
-    def save(self) -> bool: ...
-    def shutdown(self, save: bool = ..., nosave: bool = ...) -> None: ...
-    def slaveof(self, host=..., port=...): ...
-    def slowlog_get(self, num=...): ...
-    def slowlog_len(self): ...
-    def slowlog_reset(self): ...
-    def time(self): ...
-    def decr(self, name, amount=...) -> int: ...
-    def decrby(self, name, amount=...) -> int: ...
-    def delete(self, *names: _Key) -> int: ...
-    def __delitem__(self, _Key): ...
-    def dump(self, name): ...
-    def exists(self, *names: _Key) -> int: ...
-    __contains__: Any
-    def expire(self, name: _Key, time: int | timedelta) -> bool: ...
-    def expireat(self, name, when): ...
-    def get(self, name: _Key) -> _StrType | None: ...
-    def __getitem__(self, name): ...
-    def getbit(self, name: _Key, offset: int) -> int: ...
-    def getrange(self, key, start, end): ...
-    def getset(self, name, value) -> _StrType | None: ...
-    def incr(self, name: _Key, amount: int = ...) -> int: ...
-    def incrby(self, name: _Key, amount: int = ...) -> int: ...
-    def incrbyfloat(self, name: _Key, amount: float = ...) -> float: ...
-    def keys(self, pattern: _Key = ...) -> list[_StrType]: ...
-    def mget(self, keys: _Key | Iterable[_Key], *args: _Key) -> list[_StrType | None]: ...
-    def mset(self, mapping: Mapping[_Key, _Value]) -> Literal[True]: ...
-    def msetnx(self, mapping: Mapping[_Key, _Value]) -> bool: ...
-    def move(self, name: _Key, db: int) -> bool: ...
-    def persist(self, name: _Key) -> bool: ...
-    def pexpire(self, name: _Key, time: int | timedelta) -> Literal[1, 0]: ...
-    def pexpireat(self, name: _Key, when: int | datetime) -> Literal[1, 0]: ...
-    def psetex(self, name, time_ms, value): ...
-    def pttl(self, name): ...
-    def __setitem__(self, name, value): ...
-    def setbit(self, name: _Key, offset: int, value: int) -> int: ...
-    def setex(self, name: _Key, time: int | timedelta, value: _Value) -> bool: ...
-    def setnx(self, name: _Key, value: _Value) -> bool: ...
-    def setrange(self, name, offset, value): ...
-    def strlen(self, name): ...
-    def substr(self, name, start, end=...): ...
-    def ttl(self, name: _Key) -> int: ...
-    def type(self, name): ...
-    def watch(self, *names): ...
-    def unlink(self, *names: _Key) -> int: ...
-    def unwatch(self): ...
-    @overload
-    def blpop(self, keys: _Value | Iterable[_Value], timeout: Literal[0] = ...) -> tuple[_StrType, _StrType]: ...
-    @overload
-    def blpop(self, keys: _Value | Iterable[_Value], timeout: float) -> tuple[_StrType, _StrType] | None: ...
-    @overload
-    def brpop(self, keys: _Value | Iterable[_Value], timeout: Literal[0] = ...) -> tuple[_StrType, _StrType]: ...
-    @overload
-    def brpop(self, keys: _Value | Iterable[_Value], timeout: float) -> tuple[_StrType, _StrType] | None: ...
-    def brpoplpush(self, src, dst, timeout=...): ...
-    @overload
-    def sort(
-        self,
-        name: _Key,
-        start: int | None = ...,
-        num: int | None = ...,
-        by: _Key | None = ...,
-        get: _Key | Sequence[_Key] | None = ...,
-        desc: bool = ...,
-        alpha: bool = ...,
-        store: None = ...,
-        groups: bool = ...,
-    ) -> list[_StrType]: ...
-    @overload
-    def sort(
-        self,
-        name: _Key,
-        start: int | None = ...,
-        num: int | None = ...,
-        by: _Key | None = ...,
-        get: _Key | Sequence[_Key] | None = ...,
-        desc: bool = ...,
-        alpha: bool = ...,
-        *,
-        store: _Key,
-        groups: bool = ...,
-    ) -> int: ...
-    @overload
-    def sort(
-        self,
-        name: _Key,
-        start: int | None,
-        num: int | None,
-        by: _Key | None,
-        get: _Key | Sequence[_Key] | None,
-        desc: bool,
-        alpha: bool,
-        store: _Key,
-        groups: bool = ...,
-    ) -> int: ...
-    def scan(
-        self, cursor: int = ..., match: _Key | None = ..., count: int | None = ..., _type: str | None = ...
-    ) -> tuple[int, list[_StrType]]: ...
-    def scan_iter(self, match: str | None = ..., count: int | None = ..., _type: str | None = ...) -> Iterator[_StrType]: ...
-    def sscan(
-        self, name: _Key, cursor: int = ..., match: str | None = ..., count: int | None = ...
-    ) -> tuple[int, list[_StrType]]: ...
-    def sscan_iter(self, name: _Key, match: str | None = ..., count: int | None = ...): ...
-    def hscan(
-        self, name: _Key, cursor: int = ..., match: str | None = ..., count: int | None = ...
-    ) -> tuple[int, dict[_StrType, _StrType]]: ...
-    def hscan_iter(self, name: _Key, match: str | None = ..., count: int | None = ...): ...
-    def zscan(self, name, cursor=..., match=..., count=..., score_cast_func=...): ...
-    def zscan_iter(self, name, match=..., count=..., score_cast_func=...): ...
-    def sadd(self, name: _Key, *values: _Value) -> int: ...
-    def scard(self, name: _Key) -> int: ...
-    def sdiff(self, keys: _Key | Iterable[_Key], *args: _Key) -> builtins.set[_Value]: ...
-    def sdiffstore(self, dest: _Key, keys: _Key | Iterable[_Key], *args: _Key) -> int: ...
-    def sinter(self, keys: _Key | Iterable[_Key], *args: _Key) -> builtins.set[_Value]: ...
-    def sinterstore(self, dest: _Key, keys: _Key | Iterable[_Key], *args: _Key) -> int: ...
-    def sismember(self, name: _Key, value: _Value) -> bool: ...
-    def smembers(self, name: _Key) -> builtins.set[_StrType]: ...
-    def smove(self, src: _Key, dst: _Key, value: _Value) -> bool: ...
-    @overload
-    def spop(self, name: _Key, count: None = ...) -> _Value | None: ...
-    @overload
-    def spop(self, name: _Key, count: int) -> list[_Value]: ...
-    @overload
-    def srandmember(self, name: _Key, number: None = ...) -> _Value | None: ...
-    @overload
-    def srandmember(self, name: _Key, number: int) -> list[_Value]: ...
-    def srem(self, name: _Key, *values: _Value) -> int: ...
-    def sunion(self, keys: _Key | Iterable[_Key], *args: _Key) -> builtins.set[_Value]: ...
-    def sunionstore(self, dest: _Key, keys: _Key | Iterable[_Key], *args: _Key) -> int: ...
-    def pfadd(self, name: _Key, *values: _Value) -> int: ...
-    def pfcount(self, name: _Key) -> int: ...
-    def pfmerge(self, dest: _Key, *sources: _Key) -> bool: ...
-    def hdel(self, name: _Key, *keys: _Key) -> int: ...
-    def hexists(self, name: _Key, key: _Key) -> bool: ...
-    def hget(self, name: _Key, key: _Key) -> _StrType | None: ...
-    def hgetall(self, name: _Key) -> dict[_StrType, _StrType]: ...
-    def hincrby(self, name: _Key, key: _Key, amount: int = ...) -> int: ...
-    def hincrbyfloat(self, name: _Key, key: _Key, amount: float = ...) -> float: ...
-    def hkeys(self, name: _Key) -> list[_StrType]: ...
-    def hlen(self, name: _Key) -> int: ...
-    @overload
-    def hset(self, name: _Key, key: _Key, value: _Value, mapping: Mapping[_Key, _Value] | None = ...) -> int: ...
-    @overload
-    def hset(self, name: _Key, key: None, value: None, mapping: Mapping[_Key, _Value]) -> int: ...
-    @overload
-    def hset(self, name: _Key, *, mapping: Mapping[_Key, _Value]) -> int: ...
-    def hsetnx(self, name: _Key, key: _Key, value: _Value) -> int: ...
-    def hmset(self, name: _Key, mapping: Mapping[_Key, _Value]) -> bool: ...
-    def hmget(self, name: _Key, keys: _Key | Iterable[_Key], *args: _Key) -> list[_StrType | None]: ...
-    def hvals(self, name: _Key) -> list[_StrType]: ...
-    def publish(self, channel: _Key, message: _Key) -> int: ...
-    def eval(self, script, numkeys, *keys_and_args): ...
-    def evalsha(self, sha, numkeys, *keys_and_args): ...
-    def pubsub_channels(self, pattern: _Key = ...) -> list[str]: ...
-    def pubsub_numsub(self, *args: _Key) -> list[tuple[str, int]]: ...
-    def pubsub_numpat(self) -> int: ...
     def monitor(self) -> Monitor: ...
-    def memory_stats(self) -> dict[str, Any]: ...
-    def memory_purge(self) -> bool: ...
     def cluster(self, cluster_arg: str, *args: Any) -> Any: ...
     def __enter__(self) -> Redis[_StrType]: ...
     def __exit__(self, exc_type, exc_value, traceback): ...
@@ -471,9 +311,13 @@ class PubSub:
     shard_hint: Any
     ignore_subscribe_messages: Any
     connection: Any
+    subscribed_event: threading.Event
     encoder: Any
-    health_check_response: Any
-    def __init__(self, connection_pool, shard_hint=..., ignore_subscribe_messages: bool = ...) -> None: ...
+    health_check_response_b: bytes
+    health_check_response: list[str] | list[bytes]
+    def __init__(
+        self, connection_pool, shard_hint: Any | None = ..., ignore_subscribe_messages: bool = ..., encoder: Any | None = ...
+    ) -> None: ...
     def __enter__(self: Self) -> Self: ...
     def __exit__(self, exc_type: object, exc_value: object, traceback: object) -> None: ...
     def __del__(self): ...
@@ -485,7 +329,10 @@ class PubSub:
     @property
     def subscribed(self): ...
     def execute_command(self, *args): ...
+    def clean_health_check_responses(self) -> None: ...
     def parse_response(self, block: bool = ..., timeout: float = ...): ...
+    def is_health_check_response(self, response) -> bool: ...
+    def check_health(self) -> None: ...
     def psubscribe(self, *args: _Key, **kwargs: Callable[[Any], None]): ...
     def punsubscribe(self, *args: _Key) -> None: ...
     def subscribe(self, *args: _Key, **kwargs: Callable[[Any], None]) -> None: ...
@@ -698,7 +545,7 @@ class Pipeline(Redis[_StrType], Generic[_StrType]):
         groups: bool = ...,
     ) -> Pipeline[_StrType]: ...
     def scan(self, cursor: int = ..., match: _Key | None = ..., count: int | None = ..., _type: str | None = ...) -> Pipeline[_StrType]: ...  # type: ignore[override]
-    def scan_iter(self, match: str | None = ..., count: int | None = ..., _type: str | None = ...) -> Iterator[Any]: ...
+    def scan_iter(self, match: str | None = ..., count: int | None = ..., _type: str | None = ...) -> Iterator[Any]: ...  # type: ignore[override]
     def sscan(self, name: _Key, cursor: int = ..., match: str | None = ..., count: int | None = ...) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def sscan_iter(self, name: _Key, match: str | None = ..., count: int | None = ...) -> Iterator[Any]: ...
     def hscan(self, name: _Key, cursor: int = ..., match: str | None = ..., count: int | None = ...) -> Pipeline[_StrType]: ...  # type: ignore[override]
@@ -836,21 +683,13 @@ class Pipeline(Redis[_StrType], Generic[_StrType]):
     def script_flush(self, sync_type: Any | None = ...) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def script_kill(self) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def script_load(self, script) -> Pipeline[_StrType]: ...  # type: ignore[override]
-    def register_script(self, script: str | _StrType) -> Script: ...  # type: ignore[override]
     def pubsub_channels(self, pattern: _Key = ...) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def pubsub_numsub(self, *args: _Key) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def pubsub_numpat(self) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def monitor(self) -> Monitor: ...
     def cluster(self, cluster_arg: str, *args: Any) -> Pipeline[_StrType]: ...  # type: ignore[override]
     def client(self) -> Any: ...
 
-class Script:
-    registered_client: Any
-    script: Any
-    sha: Any
-    def __init__(self, registered_client, script) -> None: ...
-    def __call__(self, keys=..., args=..., client=...): ...
-
 class Monitor(object):
     command_re: Pattern[str]
     monitor_re: Pattern[str]