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.

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

Python: fix transaction publish documentation and typing #1809

Merged
merged 2 commits into from
Jul 7, 2024
Merged

Python: fix transaction publish documentation and typing #1809

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f04bdd
Python: fix transaction publish documentation and typing
shohamazon Jul 4, 2024
ca1c808
Update python/python/glide/async_commands/transaction.py
shohamazon Jul 7, 2024
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
42 changes: 20 additions & 22 deletions python/python/glide/async_commands/transaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4676,14 +4676,14 @@ def select(self, index: int) -> "Transaction":
return self.append_command(RequestType.Select, [str(index)])

def sort(
self: TTransaction,
self,
key: TEncodable,
by_pattern: Optional[TEncodable] = None,
limit: Optional[Limit] = None,
get_patterns: Optional[List[TEncodable]] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "Transaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and returns the result.
The `sort` command can be used to sort elements based on different criteria and apply transformations on sorted elements.
Expand Down Expand Up @@ -4723,14 +4723,14 @@ def sort(
return self.append_command(RequestType.Sort, args)

def sort_ro(
self: TTransaction,
self,
key: TEncodable,
by_pattern: Optional[TEncodable] = None,
limit: Optional[Limit] = None,
get_patterns: Optional[List[TEncodable]] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "Transaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and returns the result.
The `sort_ro` command can be used to sort elements based on different criteria and apply transformations on sorted elements.
Expand Down Expand Up @@ -4772,15 +4772,15 @@ def sort_ro(
return self.append_command(RequestType.SortReadOnly, args)

def sort_store(
self: TTransaction,
self,
key: TEncodable,
destination: TEncodable,
by_pattern: Optional[TEncodable] = None,
limit: Optional[Limit] = None,
get_patterns: Optional[List[TEncodable]] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "Transaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and stores the result in `store`.
The `sort` command can be used to sort elements based on different criteria, apply transformations on sorted elements, and store the result in a new key.
Expand Down Expand Up @@ -4823,12 +4823,12 @@ def sort_store(
return self.append_command(RequestType.Sort, args)

def copy(
self: TTransaction,
self,
source: TEncodable,
destination: TEncodable,
destinationDB: Optional[int] = None,
replace: Optional[bool] = None,
) -> TTransaction:
) -> "Transaction":
"""
Copies the value stored at the `source` to the `destination` key. If `destinationDB`
is specified, the value will be copied to the database specified by `destinationDB`,
Expand Down Expand Up @@ -4856,9 +4856,7 @@ def copy(

return self.append_command(RequestType.Copy, args)

def publish(
self: TTransaction, message: TEncodable, channel: TEncodable
) -> TTransaction:
def publish(self, message: TEncodable, channel: TEncodable) -> "Transaction":
"""
Publish a message on pubsub channel.
See https://valkey.io/commands/publish for more details.
Expand All @@ -4868,7 +4866,7 @@ def publish(
channel (TEncodable): Channel to publish the message on.

Returns:
TOK: a simple `OK` response.
int: Number of subscriptions in that shard that received the message.

"""
return self.append_command(RequestType.Publish, [channel, message])
Expand All @@ -4884,12 +4882,12 @@ class ClusterTransaction(BaseTransaction):
"""

def sort(
self: TTransaction,
self,
key: TEncodable,
limit: Optional[Limit] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "ClusterTransaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and returns the result.
This command is routed to primary only.
Expand All @@ -4912,12 +4910,12 @@ def sort(
return self.append_command(RequestType.Sort, args)

def sort_ro(
self: TTransaction,
self,
key: TEncodable,
limit: Optional[Limit] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "ClusterTransaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and returns the result.
The `sort_ro` command can be used to sort elements based on different criteria and apply transformations on sorted elements.
Expand All @@ -4942,13 +4940,13 @@ def sort_ro(
return self.append_command(RequestType.SortReadOnly, args)

def sort_store(
self: TTransaction,
self,
key: TEncodable,
destination: TEncodable,
limit: Optional[Limit] = None,
order: Optional[OrderBy] = None,
alpha: Optional[bool] = None,
) -> TTransaction:
) -> "ClusterTransaction":
"""
Sorts the elements in the list, set, or sorted set at `key` and stores the result in `store`.
When in cluster mode, `key` and `store` must map to the same hash slot.
Expand All @@ -4972,11 +4970,11 @@ def sort_store(
return self.append_command(RequestType.Sort, args)

def copy(
self: TTransaction,
self,
source: TEncodable,
destination: TEncodable,
replace: Optional[bool] = None,
) -> TTransaction:
) -> "ClusterTransaction":
"""
Copies the value stored at the `source` to the `destination` key. When `replace` is True,
removes the `destination` key first if it already exists, otherwise performs no action.
Expand All @@ -5000,8 +4998,8 @@ def copy(
return self.append_command(RequestType.Copy, args)

def publish(
self: TTransaction, message: str, channel: str, sharded: bool = False
) -> TTransaction:
self, message: str, channel: str, sharded: bool = False
) -> "ClusterTransaction":
"""
Publish a message on pubsub channel.
This command aggregates PUBLISH and SPUBLISH commands functionalities.
Expand Down
Loading