Python: add PubSub commands #2043
Conversation
Signed-off-by: Shoham Elias <[email protected]>
shohamazon
changed the title
shohamazon
force-pushed
the
proto-pubsub
branch
2 times, most recently
from
98aae8d
to
5ca1b6c
Compare
Signed-off-by: Shoham Elias <[email protected]>
| See https://valkey.io/commands/pubsub-shardnumsub for details. | ||
|
|
||
| Args: | ||
| channels (Optional[List[str]]): The list of shard channels to query for the number of subscribers. |
There was a problem hiding this comment.
channels type differs from the prototype
There was a problem hiding this comment.
same comments as the non-transaction
python/python/tests/test_pubsub.py
Outdated
| client = await create_client(request, cluster_mode) | ||
| # Assert no channels exists yet | ||
| assert await client.pubsub_channels() == [] | ||
| await client.close() |
There was a problem hiding this comment.
why is it important to close the client?
There was a problem hiding this comment.
I am pretty sure it shows like we have an open task (similar to what we had with node)
There was a problem hiding this comment.
but you have the cleanups towards the end of the func?
There was a problem hiding this comment.
True it doesn't matter where the close is
Signed-off-by: Shoham Elias <[email protected]>
Signed-off-by: Shoham Elias <[email protected]>
Signed-off-by: Shoham Elias <[email protected]>
Signed-off-by: Shoham Elias <[email protected]>
| """ | ||
| Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified shard channels. | ||
|
|
||
| Note that it is valid to call this command without channels. In this case, it will just return an empty map. |
There was a problem hiding this comment.
This duplicates Returns section
| """ | ||
| Returns the number of unique patterns that are subscribed to by clients. | ||
|
|
||
| Note: This is the total number of unique patterns all the clients are subscribed to, |
There was a problem hiding this comment.
Should be "Notes:" followed by the list
There was a problem hiding this comment.
Note is a verb here, not subject
|
|
||
| Note: This is the total number of unique patterns all the clients are subscribed to, | ||
| not the count of clients subscribed to patterns. | ||
| The command is routed to all nodes, and aggregates the response the sum of all pattern subscriptions. |
There was a problem hiding this comment.
Routing is not applicable to valkey's numpat command, so or remove that or describe how it became applicable there.
There was a problem hiding this comment.
no need, to describe the whys here. it is described in the 'concepts' section of the docs
| ) -> List[bytes]: | ||
| """ | ||
| Lists the currently active channels. | ||
| The command is routed to all nodes, and aggregates the response to a single array. |
There was a problem hiding this comment.
Routing is not applicable to valkey's channels command, so or remove that or describe how it became applicable there.
| Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels. | ||
|
|
||
| Note that it is valid to call this command without channels. In this case, it will just return an empty map. | ||
| The command is routed to all nodes, and aggregates the response to a single map of the channels and their number of subscriptions. |
There was a problem hiding this comment.
Routing is not applicable to valkey's numsub command, so or remove that or describe how it became applicable there.
| """ | ||
| Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels. | ||
|
|
||
| Note that it is valid to call this command without channels. In this case, it will just return an empty map. |
There was a problem hiding this comment.
This duplicates Returns section - remove
| """ | ||
| Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels. | ||
|
|
||
| Note that it is valid to call this command without channels. In this case, it will just return an empty map. |
| @@ -2257,3 +2257,492 @@ async def test_pubsub_context_with_no_callback_raise_error( | |||
|
|
|||
| with pytest.raises(ConfigurationError): | |||
| await create_two_clients_with_pubsub(request, cluster_mode, pub_sub_exact) | |||
|
|
|||
There was a problem hiding this comment.
You are missing cross slot tests for all commands
No description provided.