coredis 5.0.0rc1__tar.gz → 5.0.1__tar.gz

{coredis-5.0.0rc1 → coredis-5.0.1}/HISTORY.rst

@@ -3,6 +3,49 @@
 Changelog
 =========
 
+v5.0.1
+------
+Release Date: 2025-07-18
+
+* Bug Fix
+
+  * Fix regression caused by ``5.0.0`` which completely broke the use of Sentinel
+    with ``decode_responses=False``.
+
+v5.0.0
+------
+Release Date: 2025-07-16
+
+* Features
+
+  * Add support for using custom types with redis commands
+    by registering serializers and deserializers
+  * Allow stacking pipeline commands synchronously
+  * Expose statically typed responses for pipeline commands
+
+
+* Compatibility
+
+  * Redis command methods are no longer coroutines and instead
+    synchronous methods that return subclasses of ``Awaitable``
+    (``CommandRequest``) which can be awaited as before.
+  * Add support for redis 8.0 vector set commands
+  * Add support for redis 8.0 hash expiry commands
+  * Remove deprecated pubsub ``listen`` and threaded worker APIs
+  * Remove support for KeyDB
+
+* Performance
+
+  * Streamline client side cache shrinking
+
+v5.0.0rc2
+---------
+Release Date: 2025-07-10
+
+* Bug Fix
+
+  * Fix duplicate command error in using ``transform`` with pipeline
+
 v5.0.0rc1
 ---------
 Release Date: 2025-07-07
@@ -1957,9 +2000,3 @@ v1.0.1
 * fix bug of `PubSub.run_in_thread`
 * add more examples
 * change `Script.register` to `Script.execute`
-
-
-
-
-
-

{coredis-5.0.0rc1/coredis.egg-info → coredis-5.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coredis
-Version: 5.0.0rc1
+Version: 5.0.1
 Summary: Python async client for Redis key-value store
 Home-page: https://github.com/alisaifee/coredis
 Author: Ali-Akber Saifee
@@ -14,7 +14,6 @@ Project-URL: Documentation, https://coredis.readthedocs.org
 Keywords: Redis,key-value store,asyncio
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
@@ -80,9 +79,6 @@ coredis is an async redis client with support for redis server, cluster & sentin
   and the [API Documentation](https://coredis.readthedocs.io/en/latest/api/index.html)
   for more details.
 
-> **Warning**
-> The command API does NOT mirror the official python [redis client](https://github.com/redis/redis-py). For details about the high level differences refer to [Divergence from aredis & redis-py](https://coredis.readthedocs.io/en/latest/history.html#divergence-from-aredis-redis-py)
-
 ______________________________________________________________________
 
 <!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

{coredis-5.0.0rc1 → coredis-5.0.1}/README.md

@@ -27,9 +27,6 @@ coredis is an async redis client with support for redis server, cluster & sentin
   and the [API Documentation](https://coredis.readthedocs.io/en/latest/api/index.html)
   for more details.
 
-> **Warning**
-> The command API does NOT mirror the official python [redis client](https://github.com/redis/redis-py). For details about the high level differences refer to [Divergence from aredis & redis-py](https://coredis.readthedocs.io/en/latest/history.html#divergence-from-aredis-redis-py)
-
 ______________________________________________________________________
 
 <!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/_protocols.py

@@ -10,14 +10,10 @@ from coredis.typing import (
     Awaitable,
     Callable,
     ExecutionParameters,
-    KeyT,
-    Parameters,
     Protocol,
     R,
     RedisCommandP,
-    RedisValueT,
     ResponseType,
-    StringT,
     TypeVar,
     Unpack,
     ValueT,
@@ -47,25 +43,6 @@ class AbstractExecutor(Protocol):
     ) -> CommandRequest[R]: ...
 
 
-@runtime_checkable
-class SupportsScript(Protocol[T_co]):  # noqa
-    async def evalsha(
-        self,
-        sha1: StringT,
-        keys: Parameters[KeyT] | None = ...,
-        args: Parameters[RedisValueT] | None = ...,
-    ) -> ResponseType: ...
-
-    async def evalsha_ro(
-        self,
-        sha1: StringT,
-        keys: Parameters[KeyT] | None = ...,
-        args: Parameters[RedisValueT] | None = ...,
-    ) -> ResponseType: ...
-
-    async def script_load(self, script: StringT) -> T_co: ...
-
-
 @runtime_checkable
 class ConnectionP(Protocol):
     decode_responses: bool

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/_utils.py

@@ -72,6 +72,14 @@ class EncodingInsensitiveDict(UserDict[Any, Any]):
         alt = self._alt_key(key)
         return self.data.pop(alt, default)
 
+    def stringify_keys(self) -> dict[str, Any]:
+        d = {}
+        for key, value in self.items():
+            d[key.decode(self._encoding) if isinstance(key, bytes) else key] = (
+                value.stringify_keys() if isinstance(value, EncodingInsensitiveDict) else value
+            )
+        return d
+
 
 @enum.unique
 class CaseAndEncodingInsensitiveEnum(bytes, enum.Enum):
@@ -120,10 +128,6 @@ def b(x: ResponseType, encoding: str | None = None) -> bytes:
     return _v.encode(encoding) if encoding else _v.encode()
 
 
-def defaultvalue(value: U | None, default: T) -> U | T:
-    return default if value is None else value
-
-
 def nativestr(x: ResponseType, encoding: str = "utf-8") -> str:
     if isinstance(x, (str, bytes)):
         return x if isinstance(x, str) else x.decode(encoding, "replace")

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-07-07T11:41:52-0700",
+ "date": "2025-07-18T09:26:51-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "e2034feabddbed8c1a549ccc53976ca41d724a00",
- "version": "5.0.0rc1"
+ "full-revisionid": "dbec024933c248c144549a88927631eb9294a9a2",
+ "version": "5.0.1"
 }
 '''  # END VERSION_JSON
 

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/commands/core.py

@@ -7,7 +7,7 @@ from typing import overload
 from deprecated.sphinx import versionadded
 
 from coredis._json import json
-from coredis._utils import defaultvalue, dict_to_flat_list, tuples_to_flat_list
+from coredis._utils import dict_to_flat_list, tuples_to_flat_list
 from coredis.commands import CommandMixin
 from coredis.commands._utils import (
     normalized_milliseconds,
@@ -5269,8 +5269,8 @@ class CoreCommands(CommandMixin[AnyStr]):
         """
 
         command_arguments: CommandArgList = [
-            defaultvalue(start, "-"),
-            defaultvalue(end, "+"),
+            start if start is not None else "-",
+            end if end is not None else "+",
         ]
 
         if count is not None:
@@ -5298,8 +5298,8 @@ class CoreCommands(CommandMixin[AnyStr]):
         IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE
         """
         command_arguments: CommandArgList = [
-            defaultvalue(end, "+"),
-            defaultvalue(start, "-"),
+            end if end is not None else "+",
+            start if start is not None else "-",
         ]
 
         if count is not None:
@@ -8110,6 +8110,37 @@ class CoreCommands(CommandMixin[AnyStr]):
         filter_ef: int | None = ...,
         truth: bool | None = ...,
     ) -> CommandRequest[dict[AnyStr, float]]: ...
+    @overload
+    def vsim(
+        self,
+        key: KeyT,
+        *,
+        element: StringT | None = ...,
+        values: Parameters[float] | bytes | None = ...,
+        withattribs: Literal[True],
+        count: int | None = ...,
+        epsilon: float | None = ...,
+        ef: int | None = ...,
+        filter: StringT | None = ...,
+        filter_ef: int | None = ...,
+        truth: bool | None = ...,
+    ) -> CommandRequest[dict[AnyStr, JsonType]]: ...
+    @overload
+    def vsim(
+        self,
+        key: KeyT,
+        *,
+        element: StringT | None = ...,
+        values: Parameters[float] | bytes | None = ...,
+        withscores: Literal[True],
+        withattribs: Literal[True],
+        count: int | None = ...,
+        epsilon: float | None = ...,
+        ef: int | None = ...,
+        filter: StringT | None = ...,
+        filter_ef: int | None = ...,
+        truth: bool | None = ...,
+    ) -> CommandRequest[dict[AnyStr, tuple[float, JsonType]]]: ...
 
     @versionadded(version="5.0.0")
     @mutually_exclusive_parameters("values", "element", required=True)
@@ -8117,6 +8148,7 @@ class CoreCommands(CommandMixin[AnyStr]):
         CommandName.VSIM,
         version_introduced="8.0.0",
         group=CommandGroup.VECTOR_SET,
+        arguments={"withattribs": {"version_introduced": "8.1.240"}},
     )
     def vsim(
         self,
@@ -8125,13 +8157,19 @@ class CoreCommands(CommandMixin[AnyStr]):
         element: StringT | None = None,
         values: Parameters[float] | bytes | None = None,
         withscores: bool | None = None,
+        withattribs: bool | None = None,
         count: int | None = None,
         epsilon: float | None = None,
         ef: int | None = None,
         filter: StringT | None = None,
         filter_ef: int | None = None,
         truth: bool | None = None,
-    ) -> CommandRequest[tuple[AnyStr, ...] | dict[AnyStr, float]]:
+    ) -> CommandRequest[
+        tuple[AnyStr, ...]
+        | dict[AnyStr, float]
+        | dict[AnyStr, JsonType]
+        | dict[AnyStr, tuple[float, JsonType]]
+    ]:
         """
         Return elements similar to a given vector or element
 
@@ -8140,6 +8178,7 @@ class CoreCommands(CommandMixin[AnyStr]):
         :param values: either a byte representation of a 32-bit floating point (FP32) blob of values
          or a sequence of doubles representing the vector to use as the similarity reference.
         :param withscores: whether to return similarity scores for each result
+        :param withattribs: whether to include attributes for for each result
         :param count: number of results to limit to
         :param epsilon: distance threshold; results with distance greater than this are
          excluded.
@@ -8148,7 +8187,8 @@ class CoreCommands(CommandMixin[AnyStr]):
         :param filter_ef: limits the number of filtering attempts
         :param truth: forces an exact linear scan of all elements bypassing the HSNW graph
         :return: the matching elements or a mapping of the matching elements to their scores
-         if :paramref:`withscores` is ``True``
+         if :paramref:`withscores` is ``True`` and/or their attributes if :paramref:`withattribs`
+         is ``True``
         """
         command_arguments: CommandArgList = [key]
         if values is not None:
@@ -8162,6 +8202,8 @@ class CoreCommands(CommandMixin[AnyStr]):
 
         if withscores:
             command_arguments.append(PureToken.WITHSCORES)
+        if withattribs:
+            command_arguments.append(PureToken.WITHATTRIBS)
         if count is not None:
             command_arguments.extend([PrefixToken.COUNT, count])
         if ef is not None:
@@ -8177,7 +8219,7 @@ class CoreCommands(CommandMixin[AnyStr]):
         return self.create_request(
             CommandName.VSIM,
             *command_arguments,
-            callback=VSimCallback[AnyStr](withscores=withscores),
+            callback=VSimCallback[AnyStr](withscores=withscores, withattribs=withattribs),
         )
 
     @versionadded(version="5.0.0")

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/commands/script.py

@@ -8,9 +8,9 @@ from typing import TYPE_CHECKING, Any, cast
 
 from deprecated.sphinx import versionadded
 
-from coredis._protocols import SupportsScript
 from coredis._utils import b
 from coredis.exceptions import NoScriptError
+from coredis.retry import ConstantRetryPolicy, retryable
 from coredis.typing import (
     AnyStr,
     Awaitable,
@@ -23,6 +23,7 @@ from coredis.typing import (
     RedisValueT,
     ResponseType,
     StringT,
+    ValueT,
     add_runtime_checks,
     safe_beartype,
 )
@@ -51,7 +52,7 @@ class Script(Generic[AnyStr]):
 
     def __init__(
         self,
-        registered_client: SupportsScript[AnyStr] | None = None,
+        registered_client: coredis.client.Client[AnyStr] | None = None,
         script: StringT | None = None,
         readonly: bool = False,
     ):
@@ -64,7 +65,7 @@ class Script(Generic[AnyStr]):
         :param readonly: If ``True`` the script will be called with
          :meth:`coredis.Redis.evalsha_ro` instead of :meth:`coredis.Redis.evalsha`
         """
-        self.registered_client: SupportsScript[AnyStr] | None = registered_client
+        self.registered_client: coredis.client.Client[AnyStr] | None = registered_client
         self.script: StringT
         if not script:
             raise RuntimeError("No script provided")
@@ -72,16 +73,16 @@ class Script(Generic[AnyStr]):
         self.sha = hashlib.sha1(b(script)).hexdigest()  # type: ignore
         self.readonly = readonly
 
-    async def __call__(
+    def __call__(
         self,
         keys: Parameters[KeyT] | None = None,
-        args: Parameters[RedisValueT] | None = None,
-        client: SupportsScript[AnyStr] | None = None,
+        args: Parameters[ValueT] | None = None,
+        client: coredis.client.Client[AnyStr] | None = None,
         readonly: bool | None = None,
-    ) -> ResponseType:
+    ) -> Awaitable[ResponseType]:
         """
         Executes the script registered in :paramref:`Script.script` using
-        :meth:`coredis.Redis.evalsha`. Additionally if the script was not yet
+        :meth:`coredis.Redis.evalsha`. Additionally, if the script was not yet
         registered on the instance, it will automatically do that as well
         and cache the sha at :data:`Script.sha`
 
@@ -103,26 +104,24 @@ class Script(Generic[AnyStr]):
         if readonly is None:
             readonly = self.readonly
 
+        method = client.evalsha_ro if readonly else client.evalsha
+
         # make sure the Redis server knows about the script
         if isinstance(client, Pipeline):
             # make sure this script is good to go on pipeline
             cast(Pipeline[AnyStr], client).scripts.add(self)
-
-        method = client.evalsha_ro if readonly else client.evalsha
-        try:
-            return await method(self.sha, keys=keys, args=args)
-        except NoScriptError:
-            # Maybe the client is pointed to a different server than the client
-            # that created this instance?
-            # Overwrite the sha just in case there was a discrepancy.
-            self.sha = await client.script_load(self.script)
-            return await method(self.sha, keys=keys, args=args)
+            return method(self.sha, keys=keys, args=args)
+        else:
+            return retryable(
+                ConstantRetryPolicy((NoScriptError,), 1, 0),
+                failure_hook=lambda _: client.script_load(self.script),
+            )(method)(self.sha, keys=keys, args=args)
 
     async def execute(
         self,
         keys: Parameters[KeyT] | None = None,
-        args: Parameters[RedisValueT] | None = None,
-        client: SupportsScript[AnyStr] | None = None,
+        args: Parameters[ValueT] | None = None,
+        client: coredis.client.Client[AnyStr] | None = None,
         readonly: bool | None = None,
     ) -> ResponseType:
         """

{coredis-5.0.0rc1 → coredis-5.0.1}/coredis/commands/sentinel.py

@@ -16,7 +16,7 @@ from coredis.response._callbacks.sentinel import (
 from coredis.typing import (
     AnyStr,
     RedisValueT,
-    ResponseType,
+    ResponsePrimitive,
     StringT,
 )
 
@@ -105,7 +105,7 @@ class SentinelCommands(CommandMixin[AnyStr]):
     @redis_command(CommandName.SENTINEL_INFO_CACHE)
     def sentinel_infocache(
         self, *nodenames: StringT
-    ) -> CommandRequest[dict[AnyStr, dict[int, dict[str, ResponseType]]]]:
+    ) -> CommandRequest[dict[AnyStr, dict[int, dict[str, ResponsePrimitive]]]]:
         """
         Return cached INFO output from masters and replicas.
         """
@@ -119,7 +119,9 @@ class SentinelCommands(CommandMixin[AnyStr]):
     @redis_command(
         CommandName.SENTINEL_MASTER,
     )
-    def sentinel_master(self, service_name: StringT) -> CommandRequest[dict[str, int | bool | str]]:
+    def sentinel_master(
+        self, service_name: StringT
+    ) -> CommandRequest[dict[str, ResponsePrimitive]]:
         """Returns a dictionary containing the specified masters state."""
 
         return CommandRequest(
@@ -129,7 +131,7 @@ class SentinelCommands(CommandMixin[AnyStr]):
     @redis_command(
         CommandName.SENTINEL_MASTERS,
     )
-    def sentinel_masters(self) -> CommandRequest[dict[str, dict[str, int | bool | str]]]:
+    def sentinel_masters(self) -> CommandRequest[dict[str, dict[str, ResponsePrimitive]]]:
         """Returns a list of dictionaries containing each master's state."""
 
         return CommandRequest(self, CommandName.SENTINEL_MASTERS, callback=PrimariesCallback())
@@ -173,7 +175,7 @@ class SentinelCommands(CommandMixin[AnyStr]):
     )
     def sentinel_sentinels(
         self, service_name: StringT
-    ) -> CommandRequest[tuple[dict[str, int | bool | str], ...]]:
+    ) -> CommandRequest[tuple[dict[str, ResponsePrimitive], ...]]:
         """Returns a list of sentinels for :paramref:`service_name`"""
 
         return CommandRequest(
@@ -205,7 +207,7 @@ class SentinelCommands(CommandMixin[AnyStr]):
     )
     def sentinel_slaves(
         self, service_name: StringT
-    ) -> CommandRequest[tuple[dict[str, int | bool | str], ...]]:
+    ) -> CommandRequest[tuple[dict[str, ResponsePrimitive], ...]]:
         """Returns a list of slaves for paramref:`service_name`"""
 
         return CommandRequest(
@@ -217,7 +219,7 @@ class SentinelCommands(CommandMixin[AnyStr]):
     )
     def sentinel_replicas(
         self, service_name: StringT
-    ) -> CommandRequest[tuple[dict[str, int | bool | str], ...]]:
+    ) -> CommandRequest[tuple[dict[str, ResponsePrimitive], ...]]:
         """Returns a list of replicas for :paramref:`service_name`"""
 
         return CommandRequest(