Skip to content

Commit

Permalink
refactor: updating typing for xreadgroup / xread / xadd
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
imnotjames committed Dec 7, 2024
1 parent e74cefa commit 4df31c1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 6 additions & 4 deletions valkey/commands/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
AsyncIterator,
Awaitable,
Callable,
Dict,
Iterable,
Iterator,
List,
Expand All @@ -24,7 +23,10 @@
from valkey.exceptions import ConnectionError, DataError, NoScriptError, ValkeyError
from valkey.typing import (
AbsExpiryT,
AnyEncodableT,
AnyKeyT,
AnyFieldT,
AnyStreamIdT,
BitfieldOffsetT,
ChannelT,
CommandsProtocol,
Expand Down Expand Up @@ -3508,7 +3510,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,
Expand Down Expand Up @@ -3933,7 +3935,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:
Expand Down Expand Up @@ -3973,7 +3975,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,
Expand Down
2 changes: 2 additions & 0 deletions valkey/typing.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]]]]

Expand Down

0 comments on commit 4df31c1

Please sign in to comment.