rewrite get_messages, again

Closes #150
- Removed occurrence of ChannelPrivate when clicking bot callback button
- Fixed conditions for Iterable, in some of the places

Author: SpEcHiDe

compiler/docs/compiler.py

@@ -210,6 +210,9 @@ def get_title_list(s: str) -> list:
             get_chat_history_count
             read_chat_history
             get_messages
+            get_chat_pinned_message
+            get_callback_query_message
+            get_replied_message
             view_messages
             get_discussion_message
             get_discussion_replies

docs/source/releases/changes-in-this-fork.rst

@@ -15,7 +15,6 @@ Breaking Changes in this Fork
 ==============================
 
 - In :meth:`~pyrogram.Client.download_media`, if the message is a :obj:`~pyrogram.types.PaidMediaInfo` with more than one ``paid_media`` **and** ``idx`` was not specified, then a list of paths or binary file-like objects is returned.
-- Make :meth:`~pyrogram.Client.get_messages` accept only keyword-only arguments. `48d4230 <https://github.com/TelegramPlayGround/pyrogram/commit/48d42304f3ee51034d515919320634935e6b2c83>`_
 - PR `#115 <https://github.com/TelegramPlayGround/pyrogram/pull/115>`_ This `change <https://github.com/pyrogram/pyrogram/pull/966#issuecomment-1108858881>`_ breaks some usages with offset-naive and offset-aware datetimes.
 - PR from upstream: `#1411 <https://github.com/pyrogram/pyrogram/pull/1411>`_ without attribution.
 
@@ -32,9 +31,9 @@ Changes in this Fork
 | Scheme layer used: 198 |
 +------------------------+
 
+- Splitted the :meth:`~pyrogram.Client.get_messages` into :meth:`~pyrogram.Client.get_chat_pinned_message`, :meth:`~pyrogram.Client.get_callback_query_message`, and :meth:`~pyrogram.Client.get_replied_message`.
 - Updated :doc:`Message Identifiers <../../topics/text-formatting>`.
 - Added ``message.content`` property.
-- Added the parameter ``pinned`` and made the parameter ``chat_id`` optional in :meth:`~pyrogram.Client.get_messages`. **NOTE**: Please be aware about using the correct :doc:`Message Identifiers <../../topics/message-identifiers>`, when using this method.
 - Added the ``cover`` and ``start_timestamp`` parameters in :meth:`~pyrogram.Client.send_video` and :obj:`~pyrogram.types.InputPaidMediaVideo`.
 - Added the ``video_start_timestamp`` and renamed the ``send_copy`` and ``remove_caption`` parameters in :meth:`~pyrogram.Client.forward_messages` and :meth:`~pyrogram.types.Message.forward`.
 - Added the ``gift_count`` to the :obj:`~pyrogram.types.Chat`.

pyrogram/methods/chat_topics/get_forum_topic.py

@@ -17,7 +17,8 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
-from typing import Union, Iterable
+from collections.abc import Iterable
+from typing import Union
 
 import pyrogram
 from pyrogram import raw
@@ -59,7 +60,8 @@ async def get_forum_topic(
         Raises:
             ValueError: In case of invalid arguments.
         """
-        is_iterable = not isinstance(message_thread_ids, int)
+
+        is_iterable = isinstance(message_thread_ids, Iterable)
         ids = list(message_thread_ids) if is_iterable else [message_thread_ids]
 
         r = await self.invoke(

pyrogram/methods/messages/forward_messages.py

@@ -16,8 +16,9 @@
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
+from collections.abc import Iterable
 from datetime import datetime
-from typing import Union, Iterable
+from typing import Union
 
 import pyrogram
 from pyrogram import raw, utils
@@ -104,7 +105,7 @@ async def forward_messages(
                 await app.forward_messages(to_chat, from_chat, [1, 2, 3])
         """
 
-        is_iterable = not isinstance(message_ids, int)
+        is_iterable = isinstance(message_ids, Iterable)
         message_ids = list(message_ids) if is_iterable else [message_ids]
 
         r = await self.invoke(

pyrogram/methods/messages/get_messages.py

@@ -17,7 +17,8 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
-from typing import Union, Iterable
+from collections.abc import Iterable
+from typing import Optional, Union
 
 import pyrogram
 from pyrogram import raw, types, utils
@@ -29,11 +30,8 @@
 class GetMessages:
     async def get_messages(
         self: "pyrogram.Client",
-        *,
         chat_id: Union[int, str] = None,
         message_ids: Union[int, Iterable[int]] = None,
-        reply_to_message_ids: Union[int, Iterable[int]] = None,
-        pinned: bool = False,
         replies: int = 1,
         is_scheduled: bool = False,
         link: str = None,
@@ -46,7 +44,7 @@ async def get_messages(
 
         .. include:: /_includes/usable-by/users-bots.rst
 
-        You must use exactly one of ``message_ids`` OR ``reply_to_message_ids`` OR (``chat_id``, ``message_ids``) OR (``chat_id``, ``reply_to_message_ids``) OR (``chat_id``, ``pinned``) OR ``link``.
+        You must use exactly one of ``message_ids`` OR (``chat_id``, ``message_ids``) OR ``link``.
 
         Parameters:
             chat_id (``int`` | ``str``, *optional*):
@@ -58,14 +56,6 @@ async def get_messages(
                 Pass a single message identifier or an iterable of message ids (as integers) to get the content of the
                 message themselves.
 
-            reply_to_message_ids (``int`` | Iterable of ``int``, *optional*):
-                Pass a single message identifier or an iterable of message ids (as integers) to get the content of
-                the previous message you replied to using this message.
-
-            pinned (``bool``, *optional*):
-                Returns information about the newest pinned message in the specified ``chat_id``. Other parameters are ignored when this is set.
-                Use :meth:`~pyrogram.Client.search_messages` to return all the pinned messages.
-
             replies (``int``, *optional*):
                 The number of subsequent replies to get for each message.
                 Pass 0 for no reply at all or -1 for unlimited replies.
@@ -98,22 +88,13 @@ async def get_messages(
                 # Get message with all chained replied-to messages
                 await app.get_messages(chat_id=chat_id, message_ids=message_id, replies=-1)
 
-                # Get the replied-to message of a message
-                await app.get_messages(chat_id=chat_id, reply_to_message_ids=message_id)
-
         Raises:
             ValueError: In case of invalid arguments.
         """
 
-        if message_ids or reply_to_message_ids:
-            ids, ids_type = (
-                (message_ids, raw.types.InputMessageID) if message_ids
-                else (reply_to_message_ids, raw.types.InputMessageReplyTo) if reply_to_message_ids
-                else (None, None)
-            )
-
-            is_iterable = not isinstance(ids, int)
-            ids = list(ids) if is_iterable else [ids]
+        if message_ids:
+            is_iterable = isinstance(message_ids, Iterable)
+            ids = list(message_ids) if is_iterable else [message_ids]
 
             if replies < 0:
                 replies = (1 << 31) - 1
@@ -126,7 +107,7 @@ async def get_messages(
                     id=ids
                 )
             else:
-                ids = [ids_type(id=i) for i in ids]
+                ids = [raw.types.InputMessageID(id=i) for i in ids]
                 if chat_id and isinstance(peer, raw.types.InputPeerChannel):
                     rpc = raw.functions.channels.GetMessages(channel=peer, id=ids)
                 else:
@@ -143,18 +124,6 @@ async def get_messages(
 
             return messages if is_iterable else messages[0] if messages else None
 
-        if chat_id and pinned:
-            peer = await self.resolve_peer(chat_id)
-            rpc = raw.functions.channels.GetMessages(channel=peer, id=[raw.types.InputMessagePinned()])
-            r = await self.invoke(rpc, sleep_threshold=-1)
-            messages = await utils.parse_messages(
-                self,
-                r,
-                is_scheduled=False,
-                replies=replies
-            )
-            return messages[0] if messages else None
-
         if link:
             linkps = link.split("/")
             raw_chat_id, message_thread_id, message_id = None, None, None
@@ -234,3 +203,148 @@ async def get_messages(
             )
 
         raise ValueError("No valid argument supplied. https://telegramplayground.github.io/pyrogram/api/methods/get_messages")
+
+
+    async def get_chat_pinned_message(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        replies: int = 1
+    ) -> Optional["types.Message"]:
+        """Returns information about a newest pinned message in the chat.
+        Use :meth:`~pyrogram.Client.search_messages` to return all the pinned messages.
+
+        .. include:: /_includes/usable-by/users-bots.rst
+        
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+                For your personal cloud (Saved Messages) you can simply use "me" or "self".
+                For a contact that exists in your Telegram address book you can use his phone number (str).
+
+            replies (``int``, *optional*):
+                The number of subsequent replies to get for each message.
+                Pass 0 for no reply at all or -1 for unlimited replies.
+                Defaults to 1.
+
+        """
+
+        peer = await self.resolve_peer(chat_id)
+        if not isinstance(peer, raw.types.InputPeerChannel):
+            raise ValueError("chat_id must belong to a supergroup or channel.")
+        rpc = raw.functions.channels.GetMessages(channel=peer, id=[raw.types.InputMessagePinned()])
+        r = await self.invoke(rpc, sleep_threshold=-1)
+        if replies < 0:
+            replies = (1 << 31) - 1
+        messages = await utils.parse_messages(
+            self,
+            r,
+            is_scheduled=False,
+            replies=replies
+        )
+        return messages[0] if messages else None
+
+
+    async def get_callback_query_message(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        message_id: int,
+        callback_query_id: int,
+        replies: int = 1
+    ) -> Optional["types.Message"]:
+        """Returns information about a message with the callback button that originated a callback query.
+
+        .. include:: /_includes/usable-by/bots.rst
+
+        Parameters:
+            chat_id (``int`` | ``str``, *optional*):
+                Unique identifier (int) or username (str) of the target chat.
+                For your personal cloud (Saved Messages) you can simply use "me" or "self".
+                For a contact that exists in your Telegram address book you can use his phone number (str).
+
+            message_id (``int``):
+                Message identifier.
+
+            callback_query_id (``int``):
+                Identifier of the callback query.
+
+            replies (``int``, *optional*):
+                The number of subsequent replies to get for each message.
+                Pass 0 for no reply at all or -1 for unlimited replies.
+                Defaults to 1.
+
+        """
+
+        peer = await self.resolve_peer(chat_id)
+        ids = [raw.types.InputMessageCallbackQuery(id=message_id, query_id=callback_query_id)]
+        if isinstance(peer, raw.types.InputPeerChannel):
+            rpc = raw.functions.channels.GetMessages(channel=peer, id=ids)
+        else:
+            rpc = raw.functions.messages.GetMessages(id=ids)
+        r = await self.invoke(rpc, sleep_threshold=-1)
+        if replies < 0:
+            replies = (1 << 31) - 1
+        messages = await utils.parse_messages(
+            self,
+            r,
+            is_scheduled=False,
+            replies=replies
+        )
+        return messages[0] if messages else None
+
+
+    async def get_replied_message(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        message_ids: Union[int, Iterable[int]],
+        replies: int = 1
+    ) -> Optional["types.Message"]:
+        """Returns information about a non-bundled message that is replied by a given message.
+
+        .. include:: /_includes/usable-by/users-bots.rst
+
+        Also, returns the pinned message, the game message, the invoice message,
+        the message with a previously set same background, the giveaway message, and the topic creation message for messages of the types
+        messagePinMessage, messageGameScore, messagePaymentSuccessful, messageChatSetBackground, messageGiveawayCompleted and topic messages
+        without non-bundled replied message respectively.
+
+        Parameters:
+            chat_id (``int`` | ``str``):
+                Unique identifier (int) or username (str) of the target chat.
+                For your personal cloud (Saved Messages) you can simply use "me" or "self".
+                For a contact that exists in your Telegram address book you can use his phone number (str).
+
+            message_ids (``int`` | Iterable of ``int``):
+                Pass a single message identifier or an iterable of message ids (as integers) to get the content of
+                the previous message you replied to using this message.
+
+            replies (``int``, *optional*):
+                The number of subsequent replies to get for each message.
+                Pass 0 for no reply at all or -1 for unlimited replies.
+                Defaults to 1.
+
+        Example:
+            .. code-block:: python
+
+                # Get the replied-to message of a message
+                await app.get_replied_message(chat_id=chat_id, message_ids=message_id)
+
+        """
+
+        peer = await self.resolve_peer(chat_id)
+        is_iterable = isinstance(message_ids, Iterable)
+        ids = list(message_ids) if is_iterable else [message_ids]
+        ids = [raw.types.InputMessageReplyTo(id=i) for i in ids]
+        if isinstance(peer, raw.types.InputPeerChannel):
+            rpc = raw.functions.channels.GetMessages(channel=peer, id=ids)
+        else:
+            rpc = raw.functions.messages.GetMessages(id=ids)
+        r = await self.invoke(rpc, sleep_threshold=-1)
+        if replies < 0:
+            replies = (1 << 31) - 1
+        messages = await utils.parse_messages(
+            self,
+            r,
+            is_scheduled=False,
+            replies=replies
+        )
+        return messages if is_iterable else messages[0] if messages else None

pyrogram/methods/stories/get_stories.py

@@ -16,7 +16,8 @@
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
-from typing import Union, Iterable
+from collections.abc import Iterable
+from typing import Union
 
 import pyrogram
 from pyrogram import raw, types
@@ -56,7 +57,8 @@ async def get_stories(
                 for story in stories:
                     print(story)
         """
-        is_iterable = not isinstance(story_ids, int)
+
+        is_iterable = isinstance(story_ids, Iterable)
         ids = list(story_ids) if is_iterable else [story_ids]
 
         peer = await self.resolve_peer(story_sender_chat_id)

pyrogram/methods/users/get_users.py

@@ -17,7 +17,8 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import asyncio
-from typing import Union, Iterable
+from collections.abc import Iterable
+from typing import Union
 
 import pyrogram
 from pyrogram import raw
@@ -53,7 +54,7 @@ async def get_users(
                 await app.get_users([user_id1, user_id2, user_id3])
         """
 
-        is_iterable = not isinstance(user_ids, (int, str))
+        is_iterable = isinstance(user_ids, Iterable)
         user_ids = list(user_ids) if is_iterable else [user_ids]
         user_ids = await asyncio.gather(*[self.resolve_peer(i) for i in user_ids])
 

pyrogram/types/bots_and_keyboards/callback_query.py

@@ -16,6 +16,7 @@
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
+
 import re
 from typing import Union, Optional
 
@@ -98,14 +99,13 @@ async def _parse(client: "pyrogram.Client", callback_query, users, chats) -> "Ca
             message_id = callback_query.msg_id
 
             message = client.message_cache[(chat_id, message_id)]
-
             if not message:
-                try:
-                    message = await client.get_messages(
-                        chat_id=chat_id,
-                        message_ids=message_id
-                    )
-                except ChannelPrivate:
+                message = await client.get_callback_query_message(
+                    chat_id=chat_id,
+                    message_id=message_id,
+                    callback_query_id=callback_query.query_id
+                )
+                if not message:
                     channel = chats.get(peer_id, None)
                     if channel:
                         message = types.Message(