chore: change return types in docstrings

alissonlauffer · alissonlauffer · commit 2c16a40d1ab6 · 2023-12-02T20:36:02.000-03:00
diff --git a/hydrogram/handlers/callback_query_handler.py b/hydrogram/handlers/callback_query_handler.py
@@ -16,6 +16,7 @@
 #
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Hydrogram.  If not, see <http://www.gnu.org/licenses/>.
+
 from asyncio import iscoroutinefunction
 from typing import Callable, Tuple
 
diff --git a/hydrogram/handlers/message_handler.py b/hydrogram/handlers/message_handler.py
@@ -16,6 +16,7 @@
 #
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Hydrogram.  If not, see <http://www.gnu.org/licenses/>.
+
 from inspect import iscoroutinefunction
 from typing import Callable
 
diff --git a/hydrogram/methods/pyromod/ask.py b/hydrogram/methods/pyromod/ask.py
@@ -44,17 +44,17 @@ async def ask(
 
         :param chat_id: The chat ID(s) to wait for a message from. The first chat ID will be used to send the message.
         :param text: The text to send.
-        :param filters: Same as :meth:`pyromod.types.Client.listen`.
-        :param listener_type: Same as :meth:`pyromod.types.Client.listen`.
-        :param timeout: Same as :meth:`pyromod.types.Client.listen`.
-        :param unallowed_click_alert: Same as :meth:`pyromod.types.Client.listen`.
-        :param user_id: Same as :meth:`pyromod.types.Client.listen`.
-        :param message_id: Same as :meth:`pyromod.types.Client.listen`.
-        :param inline_message_id: Same as :meth:`pyromod.types.Client.listen`.
+        :param filters: Same as :meth:`hydrogram.Client.listen`.
+        :param listener_type: Same as :meth:`hydrogram.Client.listen`.
+        :param timeout: Same as :meth:`hydrogram.Client.listen`.
+        :param unallowed_click_alert: Same as :meth:`hydrogram.Client.listen`.
+        :param user_id: Same as :meth:`hydrogram.Client.listen`.
+        :param message_id: Same as :meth:`hydrogram.Client.listen`.
+        :param inline_message_id: Same as :meth:`hydrogram.Client.listen`.
         :param args: Additional arguments to pass to :meth:`hydrogram.Client.send_message`.
         :param kwargs: Additional keyword arguments to pass to :meth:`hydrogram.Client.send_message`.
         :return:
-            Same as :meth:`pyromod.types.Client.listen`. The sent message is returned as the attribute ``sent_message``.
+            Same as :meth:`hydrogram.Client.listen`. The sent message is returned as the attribute ``sent_message``.
         """
         sent_message = None
         if text.strip() != "":
diff --git a/hydrogram/methods/pyromod/get_listener_matching_with_data.py b/hydrogram/methods/pyromod/get_listener_matching_with_data.py
@@ -30,8 +30,8 @@ def get_listener_matching_with_data(
         """
         Gets a listener that matches the given data.
 
-        :param data: A :class:`pyromod.types.Identifier` to match against.
-        :param listener_type: The type of listener to get. Must be a value from :class:`pyromod.types.ListenerTypes`.
+        :param data: A :class:`hydrogram.types.Identifier` to match against.
+        :param listener_type: The type of listener to get. Must be a value from :class:`hydrogram.types.ListenerTypes`.
         :return: The listener that matches the given data or ``None`` if no listener matches.
         """
         matching = [
diff --git a/hydrogram/methods/pyromod/get_listener_matching_with_identifier_pattern.py b/hydrogram/methods/pyromod/get_listener_matching_with_identifier_pattern.py
@@ -30,12 +30,12 @@ def get_listener_matching_with_identifier_pattern(
         """
         Gets a listener that matches the given identifier pattern.
 
-        The difference from :meth:`pyromod.types.Client.get_listener_matching_with_data` is that this method
+        The difference from :meth:`hydrogram.Client.get_listener_matching_with_data` is that this method
         intends to get a listener by passing partial info of the listener identifier, while the other method
         intends to get a listener by passing the full info of the update data, which the listener should match with.
 
-        :param pattern: A :class:`pyromod.types.Identifier` to match against.
-        :param listener_type: The type of listener to get. Must be a value from :class:`pyromod.types.ListenerTypes`.
+        :param pattern: A :class:`hydrogram.types.Identifier` to match against.
+        :param listener_type: The type of listener to get. Must be a value from :class:`hydrogram.types.ListenerTypes`.
         :return: The listener that matches the given identifier pattern or ``None`` if no listener matches.
         """
         matching = [
diff --git a/hydrogram/methods/pyromod/get_many_listeners_matching_with_data.py b/hydrogram/methods/pyromod/get_many_listeners_matching_with_data.py
@@ -30,10 +30,10 @@ def get_many_listeners_matching_with_data(
         listener_type: ListenerTypes,
     ) -> List[Listener]:
         """
-        Same of :meth:`pyromod.types.Client.get_listener_matching_with_data` but returns a list of listeners instead of one.
+        Same of :meth:`hydrogram.Client.get_listener_matching_with_data` but returns a list of listeners instead of one.
 
-        :param data: Same as :meth:`pyromod.types.Client.get_listener_matching_with_data`.
-        :param listener_type: Same as :meth:`pyromod.types.Client.get_listener_matching_with_data`.
+        :param data: Same as :meth:`hydrogram.Client.get_listener_matching_with_data`.
+        :param listener_type: Same as :meth:`hydrogram.Client.get_listener_matching_with_data`.
         :return: A list of listeners that match the given data.
         """
         return [
diff --git a/hydrogram/methods/pyromod/get_many_listeners_matching_with_identifier_pattern.py b/hydrogram/methods/pyromod/get_many_listeners_matching_with_identifier_pattern.py
@@ -30,10 +30,10 @@ def get_many_listeners_matching_with_identifier_pattern(
         listener_type: ListenerTypes,
     ) -> List[Listener]:
         """
-        Same of :meth:`pyromod.types.Client.get_listener_matching_with_identifier_pattern` but returns a list of listeners instead of one.
+        Same of :meth:`hydrogram.Client.get_listener_matching_with_identifier_pattern` but returns a list of listeners instead of one.
 
-        :param pattern: Same as :meth:`pyromod.types.Client.get_listener_matching_with_identifier_pattern`.
-        :param listener_type: Same as :meth:`pyromod.types.Client.get_listener_matching_with_identifier_pattern`.
+        :param pattern: Same as :meth:`hydrogram.Client.get_listener_matching_with_identifier_pattern`.
+        :param listener_type: Same as :meth:`hydrogram.Client.get_listener_matching_with_identifier_pattern`.
         :return: A list of listeners that match the given identifier pattern.
         """
         return [
diff --git a/hydrogram/methods/pyromod/listen.py b/hydrogram/methods/pyromod/listen.py
@@ -46,7 +46,7 @@ async def listen(
         Creates a listener and waits for it to be fulfilled.
 
         :param filters: A filter to check if the listener should be fulfilled.
-        :param listener_type: The type of listener to create. Defaults to :attr:`pyromod.types.ListenerTypes.MESSAGE`.
+        :param listener_type: The type of listener to create. Defaults to :attr:`hydrogram.types.ListenerTypes.MESSAGE`.
         :param timeout: The maximum amount of time to wait for the listener to be fulfilled. Defaults to ``None``.
         :param unallowed_click_alert: Whether to alert the user if they click on a button that is not intended for them. Defaults to ``True``.
         :param chat_id: The chat ID(s) to listen for. Defaults to ``None``.
diff --git a/hydrogram/methods/pyromod/register_next_step_handler.py b/hydrogram/methods/pyromod/register_next_step_handler.py
@@ -40,13 +40,13 @@ def register_next_step_handler(
         Registers a listener with a callback to be called when the listener is fulfilled.
 
         :param callback: The callback to call when the listener is fulfilled.
-        :param filters: Same as :meth:`pyromod.types.Client.listen`.
-        :param listener_type: Same as :meth:`pyromod.types.Client.listen`.
-        :param unallowed_click_alert: Same as :meth:`pyromod.types.Client.listen`.
-        :param chat_id: Same as :meth:`pyromod.types.Client.listen`.
-        :param user_id: Same as :meth:`pyromod.types.Client.listen`.
-        :param message_id: Same as :meth:`pyromod.types.Client.listen`.
-        :param inline_message_id: Same as :meth:`pyromod.types.Client.listen`.
+        :param filters: Same as :meth:`hydrogram.Client.listen`.
+        :param listener_type: Same as :meth:`hydrogram.Client.listen`.
+        :param unallowed_click_alert: Same as :meth:`hydrogram.Client.listen`.
+        :param chat_id: Same as :meth:`hydrogram.Client.listen`.
+        :param user_id: Same as :meth:`hydrogram.Client.listen`.
+        :param message_id: Same as :meth:`hydrogram.Client.listen`.
+        :param inline_message_id: Same as :meth:`hydrogram.Client.listen`.
         :return: ``void``
         """
         pattern = Identifier(
diff --git a/hydrogram/methods/pyromod/remove_listener.py b/hydrogram/methods/pyromod/remove_listener.py
@@ -26,7 +26,7 @@
 class RemoveListener:
     def remove_listener(self: "hydrogram.Client", listener: Listener):
         """
-        Removes a listener from the :meth:`pyromod.types.Client.listeners` dictionary.
+        Removes a listener from the :meth:`hydrogram.Client.listeners` dictionary.
 
         :param listener: The listener to remove.
         :return: ``void``
diff --git a/hydrogram/methods/pyromod/stop_listener.py b/hydrogram/methods/pyromod/stop_listener.py
@@ -32,7 +32,7 @@ async def stop_listener(self: "hydrogram.Client", listener: Listener):
         """
         Stops a listener, calling stopped_handler if applicable or raising ListenerStopped if throw_exceptions is True.
 
-        :param listener: The :class:`pyromod.types.Listener` to stop.
+        :param listener: The :class:`hydrogram.types.Listener` to stop.
         :return: ``void``
         :raises ListenerStopped: If throw_exceptions is True.
         """
diff --git a/hydrogram/methods/pyromod/stop_listening.py b/hydrogram/methods/pyromod/stop_listening.py
@@ -34,9 +34,9 @@ async def stop_listening(
     ):
         """
         Stops all listeners that match the given identifier pattern.
-        Uses :meth:`pyromod.types.Client.get_many_listeners_matching_with_identifier_pattern`.
+        Uses :meth:`hydrogram.Client.get_many_listeners_matching_with_identifier_pattern`.
 
-        :param listener_type: The type of listener to stop. Must be a value from :class:`pyromod.types.ListenerTypes`.
+        :param listener_type: The type of listener to stop. Must be a value from :class:`hydrogram.types.ListenerTypes`.
         :param chat_id: The chat_id to match against.
         :param user_id: The user_id to match against.
         :param message_id: The message_id to match against.

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`#`
`17`	`17`	`# You should have received a copy of the GNU Lesser General Public License`
`18`	`18`	`# along with Hydrogram. If not, see <http://www.gnu.org/licenses/>.`
	`19`	`+`
`19`	`20`	`from asyncio import iscoroutinefunction`
`20`	`21`	`from typing import Callable, Tuple`
`21`	`22`