Skip to content
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.

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

Python: add BLPOP and BRPOP commands #1369

Merged

Conversation

aaron-congo
Copy link
Collaborator

Issue #, if available:
N/A

Description of changes:
https://valkey.io/commands/blpop/
https://valkey.io/commands/brpop/

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@aaron-congo aaron-congo requested a review from a team as a code owner May 1, 2024 18:00
@aaron-congo aaron-congo added the python Python wrapper label May 1, 2024
@aaron-congo aaron-congo changed the title Python: add BLPOP and BRPOP commands (#196) Python: add BLPOP and BRPOP commands May 1, 2024

Notes:
1: BLPOP is a client blocking command, see https://github.com/aws/glide-for-redis/wiki/General-Concepts#blocking-commands for more details and best practices.
2: When in cluster mode, all keys must map to the same hash slot.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
2: When in cluster mode, all keys must map to the same hash slot.
2: When in cluster mode, all `keys` must map to the same hash slot.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've changed these docs to align with existing doc patterns. The patterns I've noticed and followed are:

  • use angle quotes only for argument names, unless the argument is plural (eg keys, members etc) or we are describing the arg itself in the "Args" section
  • do not use "Note" or "Notes" as this isn't used elsewhere, instead include the hash slot and/or blocking command warnings on their own separated lines in the doc

@Yury-Fridlyand Yury-Fridlyand merged commit a14e060 into valkey-io:main May 7, 2024
6 checks passed
@Yury-Fridlyand Yury-Fridlyand deleted the python/integ_acongo_blpop_brpop branch May 7, 2024 19:15
tjzhang-BQ pushed a commit to Bit-Quill/valkey-glide that referenced this pull request May 8, 2024
* Python: add BLPOP and BRPOP commands (#196)

Co-authored-by: Andrew Carbonetto <[email protected]>
cyip10 pushed a commit to Bit-Quill/valkey-glide that referenced this pull request Jun 24, 2024
* Python: add BLPOP and BRPOP commands (#196)

Co-authored-by: Andrew Carbonetto <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
python Python wrapper
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants