Skip to content

Fix: Improve pipeline chaining type hints in typing.py #3919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gautamraj8044 wants to merge 2 commits into
base: master
Choose a base branch
from
+7 −1
Open

Fix: Improve pipeline chaining type hints in typing.py #3919

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea56adc
Fix pipeline chaining type hints
Gautam-XTI Jan 24, 2026
b26e052
Merge branch 'master' into fix/pipeline-chained-type-hints
petyaslavova Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion redis/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
PatternT = _StringLikeT # Patterns matched against keys, fields etc
FieldT = EncodableT # Fields within hash tables, streams and geo commands
KeysT = Union[KeyT, Iterable[KeyT]]
ResponseT = Union[Awaitable[Any], Any]
ResponseT = Union[Awaitable[Any], Any, "PipelineCommandsProtocol"]
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PipelineCommandsProtocol type is added to the ResponseT union, but this creates a semantic issue. ResponseT is used as the return type for all Redis command methods (e.g., set(), get()). Adding PipelineCommandsProtocol to this union means that when calling redis_client.get("key"), the type checker will infer the return type could be a PipelineCommandsProtocol, which is incorrect - a regular Redis client should never return a Pipeline.

The underlying issue is that command methods are shared between Redis and Pipeline classes, but they should have different return types. A more appropriate solution would involve using TypeVars or Self types to properly model this polymorphism, rather than adding Pipeline to the general response type union.

Copilot uses AI. Check for mistakes.
ChannelT = _StringLikeT
GroupT = _StringLikeT # Consumer group
ConsumerT = _StringLikeT # Consumer name
Expand All @@ -53,5 +53,11 @@ class CommandsProtocol(Protocol):
def execute_command(self, *args, **options) -> ResponseT: ...


class PipelineCommandsProtocol(Protocol):
def execute_command(self, *args, **options) -> ResponseT: ...
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PipelineCommandsProtocol is defined but never actually used as a type constraint anywhere in the codebase. No Pipeline class declares that it implements this protocol, nor is it used in any type annotations besides being added to the ResponseT union. For this protocol to be useful, Pipeline classes should either explicitly state they implement it, or it should be used as a type bound in relevant places. Additionally, the execute_command method in this protocol returns ResponseT, which creates a circular type reference since ResponseT now includes PipelineCommandsProtocol.

Suggested change
def execute_command(self, *args, **options) -> ResponseT: ...
def execute_command(self, *args, **options) -> Any: ...

Copilot uses AI. Check for mistakes.

def pipeline_execute_command(self, *args, **options) -> "PipelineCommandsProtocol": ...


class ClusterCommandsProtocol(CommandsProtocol):
encoder: "Encoder"
Loading