coredis 5.0.0__tar.gz → 5.0.0rc2__tar.gz

{coredis-5.0.0 → coredis-5.0.0rc2}/HISTORY.rst

@@ -3,32 +3,6 @@
 Changelog
 =========
 
-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
@@ -1998,4 +1972,3 @@ v1.0.1
 
 
 
-

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coredis
-Version: 5.0.0
+Version: 5.0.0rc2
 Summary: Python async client for Redis key-value store
 Home-page: https://github.com/alisaifee/coredis
 Author: Ali-Akber Saifee
@@ -14,6 +14,7 @@ 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

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/_protocols.py

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

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/_utils.py

@@ -120,6 +120,10 @@ 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.0 → coredis-5.0.0rc2}/coredis/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-07-16T17:47:22-0700",
+ "date": "2025-07-10T16:37:52-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "ac290229e2b463e1643d9829542cb1a59083b600",
- "version": "5.0.0"
+ "full-revisionid": "500ec3f7c2c644928da3459bf3242872e672728c",
+ "version": "5.0.0rc2"
 }
 '''  # END VERSION_JSON
 

{coredis-5.0.0 → coredis-5.0.0rc2}/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 dict_to_flat_list, tuples_to_flat_list
+from coredis._utils import defaultvalue, 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 = [
-            start if start is not None else "-",
-            end if end is not None else "+",
+            defaultvalue(start, "-"),
+            defaultvalue(end, "+"),
         ]
 
         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 = [
-            end if end is not None else "+",
-            start if start is not None else "-",
+            defaultvalue(end, "+"),
+            defaultvalue(start, "-"),
         ]
 
         if count is not None:
@@ -8110,37 +8110,6 @@ 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)
@@ -8148,7 +8117,6 @@ 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,
@@ -8157,19 +8125,13 @@ 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]
-        | dict[AnyStr, JsonType]
-        | dict[AnyStr, tuple[float, JsonType]]
-    ]:
+    ) -> CommandRequest[tuple[AnyStr, ...] | dict[AnyStr, float]]:
         """
         Return elements similar to a given vector or element
 
@@ -8178,7 +8140,6 @@ 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.
@@ -8187,8 +8148,7 @@ 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`` and/or their attributes if :paramref:`withattribs`
-         is ``True``
+         if :paramref:`withscores` is ``True``
         """
         command_arguments: CommandArgList = [key]
         if values is not None:
@@ -8202,8 +8162,6 @@ 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:
@@ -8219,7 +8177,7 @@ class CoreCommands(CommandMixin[AnyStr]):
         return self.create_request(
             CommandName.VSIM,
             *command_arguments,
-            callback=VSimCallback[AnyStr](withscores=withscores, withattribs=withattribs),
+            callback=VSimCallback[AnyStr](withscores=withscores),
         )
 
     @versionadded(version="5.0.0")

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/commands/script.py

@@ -8,7 +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.commands import CommandRequest
 from coredis.exceptions import NoScriptError
 from coredis.retry import ConstantRetryPolicy, retryable
 from coredis.typing import (
@@ -23,7 +25,6 @@ from coredis.typing import (
     RedisValueT,
     ResponseType,
     StringT,
-    ValueT,
     add_runtime_checks,
     safe_beartype,
 )
@@ -52,7 +53,7 @@ class Script(Generic[AnyStr]):
 
     def __init__(
         self,
-        registered_client: coredis.client.Client[AnyStr] | None = None,
+        registered_client: SupportsScript[AnyStr] | None = None,
         script: StringT | None = None,
         readonly: bool = False,
     ):
@@ -65,7 +66,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: coredis.client.Client[AnyStr] | None = registered_client
+        self.registered_client: SupportsScript[AnyStr] | None = registered_client
         self.script: StringT
         if not script:
             raise RuntimeError("No script provided")
@@ -76,10 +77,10 @@ class Script(Generic[AnyStr]):
     def __call__(
         self,
         keys: Parameters[KeyT] | None = None,
-        args: Parameters[ValueT] | None = None,
-        client: coredis.client.Client[AnyStr] | None = None,
+        args: Parameters[RedisValueT] | None = None,
+        client: SupportsScript[AnyStr] | None = None,
         readonly: bool | None = None,
-    ) -> Awaitable[ResponseType]:
+    ) -> CommandRequest[ResponseType]:
         """
         Executes the script registered in :paramref:`Script.script` using
         :meth:`coredis.Redis.evalsha`. Additionally, if the script was not yet
@@ -112,16 +113,19 @@ class Script(Generic[AnyStr]):
             cast(Pipeline[AnyStr], client).scripts.add(self)
             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)
+            return cast(
+                CommandRequest[ResponseType],
+                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[ValueT] | None = None,
-        client: coredis.client.Client[AnyStr] | None = None,
+        args: Parameters[RedisValueT] | None = None,
+        client: SupportsScript[AnyStr] | None = None,
         readonly: bool | None = None,
     ) -> ResponseType:
         """

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/pipeline.py

@@ -89,6 +89,8 @@ def wrap_pipeline_method(
     def wrapper(*args: P.args, **kwargs: P.kwargs) -> Awaitable[R]:
         return func(*args, **kwargs)
 
+    wrapper.__annotations__ = wrapper.__annotations__.copy()
+    wrapper.__annotations__["return"] = kls
     wrapper.__doc__ = textwrap.dedent(wrapper.__doc__ or "")
     wrapper.__doc__ = f"""
 .. note:: Pipeline variant of :meth:`coredis.Redis.{func.__name__}` that does not execute
@@ -163,12 +165,13 @@ class PipelineCommandRequest(CommandRequest[CommandResponseT]):
         if hasattr(self, "response"):
             return self.response.__await__()
         elif self.parent:
+            parent = self.parent
 
             async def _transformed() -> CommandResponseT:
-                if (r := await self.parent) == self.client:  # type: ignore
-                    return r  # type: ignore
+                if hasattr(parent, "response"):
+                    return self.callback(await parent.response)
                 else:
-                    return self.callback(r)
+                    return await parent  # type: ignore[no-any-return]
 
             return _transformed().__await__()
         else:
@@ -538,8 +541,6 @@ class Pipeline(Client[AnyStr], metaclass=PipelineMeta):
     ) -> None:
         """
         Queue a command for execution on the next `execute()` call.
-
-        :meta private:
         """
         self.command_stack.append(command)
 

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/response/_callbacks/vector_sets.py

@@ -1,69 +1,36 @@
 from __future__ import annotations
 
-from coredis._json import json
 from coredis._utils import nativestr
 from coredis.response._callbacks import ResponseCallback
 from coredis.response._utils import flat_pairs_to_dict
 from coredis.response.types import VectorData
-from coredis.typing import AnyStr, JsonType, ResponsePrimitive, StringT
+from coredis.typing import AnyStr, ResponsePrimitive, StringT
 
 
 class VSimCallback(
     ResponseCallback[
         list[AnyStr],
-        list[AnyStr] | dict[AnyStr, float | list[float | JsonType]],
-        tuple[AnyStr, ...]
-        | dict[AnyStr, float]
-        | dict[AnyStr, JsonType]
-        | dict[AnyStr, tuple[float, JsonType]],
+        list[AnyStr] | dict[AnyStr, float],
+        tuple[AnyStr, ...] | dict[AnyStr, float],
     ],
 ):
     def transform(
         self,
         response: list[AnyStr],
-    ) -> (
-        tuple[AnyStr, ...]
-        | dict[AnyStr, float]
-        | dict[AnyStr, JsonType]
-        | dict[AnyStr, tuple[float, JsonType]]
-    ):
-        withscores, withattribs = self.options.get("withscores"), self.options.get("withattribs")
-        if withscores or withattribs:
+    ) -> tuple[AnyStr, ...] | dict[AnyStr, float]:
+        if self.options.get("withscores"):
             it = iter(response)
-            match withscores, withattribs:
-                case True, None | False:
-                    return dict(list(zip(it, map(float, it))))
-                case None | False, True:
-                    return dict(list(zip(it, map(json.loads, it))))
-                case True, True:
-                    return dict(
-                        list(zip(it, map(lambda x: (float(x[0]), json.loads(x[1])), zip(it, it))))
-                    )
+            return dict(list(zip(it, map(float, it))))
         else:
-            return self.transform_3(response)
+            return tuple(response)
 
     def transform_3(
         self,
-        response: list[AnyStr]
-        | dict[AnyStr, float]
-        | dict[AnyStr, AnyStr]
-        | dict[AnyStr, list[float | AnyStr]],
-    ) -> (
-        tuple[AnyStr, ...]
-        | dict[AnyStr, float]
-        | dict[AnyStr, JsonType]
-        | dict[AnyStr, tuple[float, JsonType]]
-    ):
-        withscores, withattribs = self.options.get("withscores"), self.options.get("withattribs")
-        if withscores or withattribs:
+        response: list[AnyStr] | dict[AnyStr, float],
+    ) -> tuple[AnyStr, ...] | dict[AnyStr, float]:
+        if self.options.get("withscores"):
             assert isinstance(response, dict)
-            match withscores, withattribs:
-                case None | False, True:
-                    return {k: json.loads(v) for k, v in response.items()}
-                case True, True:
-                    return {k: (v[0], json.loads(v[1])) for k, v in response.items()}
-                case _:
-                    return response
+            return response
         else:
             return tuple(response)
 

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/sentinel.py

@@ -24,7 +24,6 @@ from coredis.typing import (
     Iterable,
     Literal,
     StringT,
-    TypeAdapter,
 )
 
 
@@ -196,7 +195,6 @@ class Sentinel(Generic[AnyStr]):
         sentinel_kwargs: dict[str, Any] | None = ...,
         decode_responses: Literal[False] = ...,
         cache: AbstractCache | None = None,
-        type_adapter: TypeAdapter | None = ...,
         **connection_kwargs: Any,
     ) -> None: ...
 
@@ -208,7 +206,6 @@ class Sentinel(Generic[AnyStr]):
         sentinel_kwargs: dict[str, Any] | None = ...,
         decode_responses: Literal[True] = ...,
         cache: AbstractCache | None = None,
-        type_adapter: TypeAdapter | None = None,
         **connection_kwargs: Any,
     ) -> None: ...
 
@@ -219,7 +216,6 @@ class Sentinel(Generic[AnyStr]):
         sentinel_kwargs: dict[str, Any] | None = None,
         decode_responses: bool = False,
         cache: AbstractCache | None = None,
-        type_adapter: TypeAdapter | None = None,
         **connection_kwargs: Any,
     ) -> None:
         """
@@ -240,9 +236,6 @@ class Sentinel(Generic[AnyStr]):
          and ``protocol_version`` options specified in :paramref:`connection_kwargs` will be used.
         :param cache: If provided the cache will be shared between both primaries and replicas
          returned by this sentinel.
-        :param type_adapter: The adapter to use for serializing / deserializing customs types
-         when interacting with redis commands. If provided this adapter will be used for both
-         primaries and replicas returned by this sentinel.
         :param connection_kwargs: are keyword arguments that will be used when
          establishing a connection to a Redis server (i.e. are passed on to the
          constructor of :class:`Redis` for all primary and replicas).
@@ -267,7 +260,6 @@ class Sentinel(Generic[AnyStr]):
         self.min_other_sentinels = min_other_sentinels
         self.connection_kwargs = connection_kwargs
         self.__cache = cache
-        self.__type_adapter = type_adapter
         self.connection_kwargs["decode_responses"] = self.sentinel_kwargs["decode_responses"] = (
             decode_responses
         )
@@ -414,7 +406,6 @@ class Sentinel(Generic[AnyStr]):
                 **connection_kwargs,
             ),
             cache=self.__cache,
-            type_adapter=self.__type_adapter,
         )
 
     @overload
@@ -470,5 +461,4 @@ class Sentinel(Generic[AnyStr]):
                 **connection_kwargs,
             ),
             cache=self.__cache,
-            type_adapter=self.__type_adapter,
         )

{coredis-5.0.0 → coredis-5.0.0rc2}/coredis/tokens.py

@@ -771,11 +771,6 @@ class PureToken(CaseAndEncodingInsensitiveEnum):
     #:  - ``VSIM``
     TRUTH = b"TRUTH"
 
-    #: Used by:
-    #:
-    #:  - ``VSIM``
-    WITHATTRIBS = b"WITHATTRIBS"
-
     #: Used by:
     #:
     #:  - ``VEMB``

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: coredis
-Version: 5.0.0
+Version: 5.0.0rc2
 Summary: Python async client for Redis key-value store
 Home-page: https://github.com/alisaifee/coredis
 Author: Ali-Akber Saifee
@@ -14,6 +14,7 @@ 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

{coredis-5.0.0 → coredis-5.0.0rc2}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-  "mypy==1.17.0",
+  "mypy==1.16.1",
   "packaging>=21,<26",
   "beartype>=0.20",
   "pympler>1,<2",

{coredis-5.0.0 → coredis-5.0.0rc2}/requirements/dev.txt

@@ -2,7 +2,7 @@
 -r publishing.txt
 -r recipes.txt
 ruff
-mypy==1.17.0; implementation_name!='pypy'
+mypy==1.16.1; implementation_name!='pypy'
 redis>=4.2.0
 twine
 types-deprecated

{coredis-5.0.0 → coredis-5.0.0rc2}/setup.py

@@ -147,6 +147,7 @@ setup(
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3.10",