Skip to content

typing: accept single-key input for blpop and brpop#3990

Merged
petyaslavova merged 3 commits intoredis:masterfrom
mitre88:codex/issue-3986-blpop-brpop-typing
Mar 6, 2026
Merged

typing: accept single-key input for blpop and brpop#3990
petyaslavova merged 3 commits intoredis:masterfrom
mitre88:codex/issue-3986-blpop-brpop-typing

Conversation

@mitre88
Copy link
Copy Markdown
Contributor

@mitre88 mitre88 commented Mar 5, 2026

Description of change

  • update ListCommands.blpop and ListCommands.brpop type hints from List to KeysT
  • this matches actual runtime behavior (single key str is accepted via list_or_args)
  • also tweak docstrings to remove wording that implies only list input is valid

Closes #3986

Pull Request check-list

  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change?
  • Is the new or changed code fully tested?
  • Is there an example added to the examples folder (if applicable)?

Note

Low Risk
Low risk documentation-only change; no runtime behavior or command execution logic is modified.

Overview
Clarifies the ListCommands.blpop and ListCommands.brpop docstrings to remove wording that implies keys must be a list, aligning the docs with the existing ability to pass a single key.

Written by Cursor Bugbot for commit d336ca5. This will update automatically on new commits. Configure here.

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented Mar 5, 2026

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

@petyaslavova petyaslavova added the maintenance Maintenance (CI, Releases, etc) label Mar 6, 2026
@petyaslavova petyaslavova merged commit 11043df into redis:master Mar 6, 2026
120 of 122 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Maintenance (CI, Releases, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

blpop type annotation conflicts with documented behavior (str vs List[str])

2 participants