Skip to content
Prev Previous commit
chore(pyromod): re-add user_id in `Message.{listen,ask,stop_listening…
…}` methods and cleanup chat_id and user_id typing hints
  • Loading branch information
alissonlauffer committed Jan 16, 2024
commit c67d0d3276d91e1027ae31859436d035632ea900
2 changes: 1 addition & 1 deletion hydrogram/methods/pyromod/ask.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ async def ask(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
*args,
Expand Down
4 changes: 2 additions & 2 deletions hydrogram/methods/pyromod/listen.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ async def listen(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
) -> Union["hydrogram.types.Message", "hydrogram.types.CallbackQuery"]:
Expand Down
4 changes: 2 additions & 2 deletions hydrogram/methods/pyromod/register_next_step_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ def register_next_step_handler(
filters: Optional[Filter] = None,
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
unallowed_click_alert: bool = True,
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down
4 changes: 2 additions & 2 deletions hydrogram/methods/pyromod/stop_listening.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ class StopListening:
async def stop_listening(
self: "hydrogram.Client",
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down
27 changes: 18 additions & 9 deletions hydrogram/types/messages_and_media/message.py
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ def __init__(

async def wait_for_click(
self,
from_user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
from_user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
timeout: Optional[int] = None,
filters=None,
alert: Union[str, bool] = True,
Expand Down Expand Up @@ -1037,6 +1037,7 @@ def listen(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand All @@ -1048,8 +1049,7 @@ def listen(
.. code-block:: python

await client.listen(
chat_id=chat_id,
user_id=user_id
chat_id=chat_id
)

Example:
Expand All @@ -1070,6 +1070,9 @@ def listen(
unallowed_click_alert (``bool``):
Whether to alert the user if they click on a button that is not intended for them. Defaults to ``True``.

user_id (``Optional[Union[int, str], List[Union[int, str]]]``):
The user ID(s) to listen for. Defaults to ``None``.

message_id (``Optional[Union[int, List[int]]]``):
The message ID(s) to listen for. Defaults to ``None``.

Expand All @@ -1085,7 +1088,7 @@ def listen(
listener_type=listener_type,
timeout=timeout,
unallowed_click_alert=unallowed_click_alert,
user_id=self.from_user.id if self.from_user else None,
user_id=user_id,
message_id=message_id,
inline_message_id=inline_message_id,
)
Expand All @@ -1097,6 +1100,7 @@ def ask(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
*args,
Expand All @@ -1111,7 +1115,6 @@ def ask(

await client.ask(
chat_id=chat_id,
user_id=user_id,
text=text
)

Expand All @@ -1137,6 +1140,9 @@ def ask(
unallowed_click_alert (``bool``):
Same as :meth:`hydrogram.Client.listen`.

user_id (``Optional[Union[int, str], List[Union[int, str]]]``):
The user ID(s) to listen for. Defaults to ``None``.

message_id (``Optional[Union[int, List[int]]]``):
The message ID(s) to listen for. Defaults to ``None``.

Expand All @@ -1159,7 +1165,7 @@ def ask(
listener_type=listener_type,
timeout=timeout,
unallowed_click_alert=unallowed_click_alert,
user_id=self.from_user.id if self.from_user else None,
user_id=user_id,
message_id=message_id,
inline_message_id=inline_message_id,
*args,
Expand All @@ -1169,6 +1175,7 @@ def ask(
def stop_listening(
self,
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand All @@ -1180,8 +1187,7 @@ def stop_listening(
.. code-block:: python

await client.stop_listening(
chat_id=chat_id,
user_id=user_id
chat_id=chat_id
)

Example:
Expand All @@ -1193,6 +1199,9 @@ def stop_listening(
listener_type (``ListenerTypes``):
The type of listener to stop listening for. Defaults to :attr:`hydrogram.types.ListenerTypes.MESSAGE`.

user_id (``Optional[Union[int, str], List[Union[int, str]]]``):
The user ID(s) to stop listening for. Defaults to ``None``.

message_id (``Optional[Union[int, List[int]]]``):
The message ID(s) to stop listening for. Defaults to ``None``.

Expand All @@ -1205,7 +1214,7 @@ def stop_listening(
return self._client.stop_listening(
chat_id=self.chat.id if self.chat else None,
listener_type=listener_type,
user_id=self.from_user.id if self.from_user else None,
user_id=user_id,
message_id=message_id,
inline_message_id=inline_message_id,
)
Expand Down
4 changes: 2 additions & 2 deletions hydrogram/types/pyromod/identifier.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
@dataclass
class Identifier:
inline_message_id: Optional[Union[str, list[str]]] = None
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None
message_id: Optional[Union[int, list[int]]] = None
from_user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None
from_user_id: Optional[Union[int, str, list[Union[int, str]]]] = None

def matches(self, update: "Identifier") -> bool:
# Compare each property of other with the corresponding property in self
Expand Down
6 changes: 3 additions & 3 deletions hydrogram/types/user_and_chats/chat.py
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ def listen(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down Expand Up @@ -475,7 +475,7 @@ def ask(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
*args,
Expand Down Expand Up @@ -550,7 +550,7 @@ def ask(
def stop_listening(
self,
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
user_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
user_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down
4 changes: 2 additions & 2 deletions hydrogram/types/user_and_chats/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ def listen(
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
timeout: Optional[int] = None,
unallowed_click_alert: bool = True,
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down Expand Up @@ -436,7 +436,7 @@ def ask(
def stop_listening(
self,
listener_type: ListenerTypes = ListenerTypes.MESSAGE,
chat_id: Optional[Union[Union[int, str], list[Union[int, str]]]] = None,
chat_id: Optional[Union[int, str, list[Union[int, str]]]] = None,
message_id: Optional[Union[int, list[int]]] = None,
inline_message_id: Optional[Union[str, list[str]]] = None,
):
Expand Down