refactor: updating typing for xreadgroup / xread / xadd

the typing for these functions are invariant and cannot be used with a typed dict as easily because of that Signed-off-by: James Ward <[email protected]>
valkey-io · Dec 7, 2024 · eb14418 · eb14418
1 parent e74cefa
commit eb14418
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/valkey/commands/core.py b/valkey/commands/core.py
@@ -24,7 +24,10 @@
 from valkey.exceptions import ConnectionError, DataError, NoScriptError, ValkeyError
 from valkey.typing import (
     AbsExpiryT,
+    AnyEncodableT,
+    AnyFieldT,
     AnyKeyT,
+    AnyStreamIdT,
     BitfieldOffsetT,
     ChannelT,
     CommandsProtocol,
@@ -3508,7 +3511,7 @@ def xack(self, name: KeyT, groupname: GroupT, *ids: StreamIdT) -> ResponseT:
     def xadd(
         self,
         name: KeyT,
-        fields: Dict[FieldT, EncodableT],
+        fields: Mapping[AnyFieldT, AnyEncodableT],
         id: StreamIdT = "*",
         maxlen: Union[int, None] = None,
         approximate: bool = True,
@@ -3933,7 +3936,7 @@ def xrange(
 
     def xread(
         self,
-        streams: Dict[KeyT, StreamIdT],
+        streams: Mapping[AnyKeyT, AnyStreamIdT],
         count: Union[int, None] = None,
         block: Union[int, None] = None,
     ) -> ResponseT:
@@ -3973,7 +3976,7 @@ def xreadgroup(
         self,
         groupname: str,
         consumername: str,
-        streams: Dict[KeyT, StreamIdT],
+        streams: Mapping[AnyKeyT, AnyStreamIdT],
         count: Union[int, None] = None,
         block: Union[int, None] = None,
         noack: bool = False,

diff --git a/valkey/typing.py b/valkey/typing.py
@@ -47,6 +47,8 @@
 AnyKeyT = TypeVar("AnyKeyT", bytes, str, memoryview)
 AnyFieldT = TypeVar("AnyFieldT", bytes, str, memoryview)
 AnyChannelT = TypeVar("AnyChannelT", bytes, str, memoryview)
+AnyStreamIdT = TypeVar("AnyStreamIdT", int, bytes, str, memoryview)
+AnyEncodableT = TypeVar("AnyEncodableT", int, float, bytes, str, memoryview)
 
 ExceptionMappingT = Mapping[str, Union[Type[Exception], Mapping[str, Type[Exception]]]]