Add download bound method to the class ExternalReplyInfo (#144)

Author: SpEcHiDe

compiler/docs/compiler.py

@@ -760,6 +760,7 @@ def get_title_list(s: str) -> list:
             Message.pay
             Message.star
             UserGift.toggle
+            ExternalReplyInfo.download
         """,
         chat="""
         Chat

pyrogram/types/input_message_content/external_reply_info.py

@@ -338,3 +338,96 @@ async def _parse(
                 poll=poll,
                 venue=venue
             )
+
+
+    async def download(
+        self,
+        file_name: str = "",
+        in_memory: bool = False,
+        block: bool = True,
+        idx: int = None,
+        progress: Callable = None,
+        progress_args: tuple = ()
+    ) -> Optional[Union[str, "io.BytesIO", list[str], list["io.BytesIO"]]]:
+        """Bound method *download* of :obj:`~pyrogram.types.ExternalReplyInfo`.
+
+        Use as a shortcut for:
+
+        .. code-block:: python
+
+            await client.download_media(message.external_reply.document)
+
+        Example:
+            .. code-block:: python
+
+                await message.external_reply.download()
+
+        Parameters:
+            file_name (``str``, *optional*):
+                A custom *file_name* to be used instead of the one provided by Telegram.
+                By default, all files are downloaded in the *downloads* folder in your working directory.
+                You can also specify a path for downloading files in a custom location: paths that end with "/"
+                are considered directories. All non-existent folders will be created automatically.
+
+            in_memory (``bool``, *optional*):
+                Pass True to download the media in-memory.
+                A binary file-like object with its attribute ".name" set will be returned.
+                Defaults to False.
+
+            block (``bool``, *optional*):
+                Blocks the code execution until the file has been downloaded.
+                Defaults to True.
+
+            idx (``int``, *optional*):
+                In case of a :obj:`~pyrogram.types.PaidMediaInfo` with more than one ``paid_media``, the zero based index of the :obj:`~pyrogram.types.PaidMedia` to download. Raises ``IndexError`` if the index specified does not exist in the original ``message``.
+
+            progress (``Callable``, *optional*):
+                Pass a callback function to view the file transmission progress.
+                The function must take *(current, total)* as positional arguments (look at Other Parameters below for a
+                detailed description) and will be called back each time a new file chunk has been successfully
+                transmitted.
+
+            progress_args (``tuple``, *optional*):
+                Extra custom arguments for the progress callback function.
+                You can pass anything you need to be available in the progress callback scope; for example, a Message
+                object or a Client instance in order to edit the message with the updated progress status.
+
+        Other Parameters:
+            current (``int``):
+                The amount of bytes transmitted so far.
+
+            total (``int``):
+                The total size of the file.
+
+            *args (``tuple``, *optional*):
+                Extra custom arguments as defined in the ``progress_args`` parameter.
+                You can either keep ``*args`` or add every single extra argument in your function signature.
+
+        Returns:
+            ``str`` | ``None`` | :obj:`io.BytesIO`: On success, the absolute path of the downloaded file is returned,
+            otherwise, in case the download failed or was deliberately stopped with
+            :meth:`~pyrogram.Client.stop_transmission`, None is returned.
+            Otherwise, in case ``in_memory=True``, a binary file-like object with its attribute ".name" set is returned.
+            If the message is a :obj:`~pyrogram.types.PaidMediaInfo` with more than one ``paid_media`` containing ``minithumbnail`` and ``idx`` is not specified, then a list of paths or binary file-like objects is returned.
+
+        Raises:
+            RPCError: In case of a Telegram RPC error.
+            IndexError: In case of wrong value of ``idx``.
+            ValueError: If the message doesn't contain any downloadable media.
+
+        """
+        message = getattr(self, self.media.value, None)
+        if not message:
+            raise ValueError(
+                f"The reply doesn't contain any downloadable media"
+            )
+
+        return await self._client.download_media(
+            message=message,
+            file_name=file_name,
+            in_memory=in_memory,
+            block=block,
+            idx=idx,
+            progress=progress,
+            progress_args=progress_args,
+        )