fix: return type of Client.download_media

Author: penggrin12

pyrogram/methods/messages/download_media.py

@@ -18,6 +18,7 @@
 
 import os
 from datetime import datetime
+from io import BytesIO
 from typing import Union, Optional, Callable, BinaryIO, List, Literal, overload
 
 import pyrogram
@@ -137,7 +138,7 @@ async def download_media(
         block: bool = True,
         progress: Optional[Callable] = None,
         progress_args: tuple = ()
-    ) -> Union[str, BinaryIO, List[str], List[BinaryIO], None]:
+    ) -> Union[str, BytesIO, List[str], List[BytesIO], None]:
         """Download the media from a message.
 
         .. include:: /_includes/usable-by/users-bots.rst
@@ -185,7 +186,7 @@ async def download_media(
                 You can either keep ``*args`` or add every single extra argument in your function signature.
 
         Returns:
-            ``str`` | ``None`` | ``BinaryIO`` | ``List[str]`` | ``List[BinaryIO]``: On success, the absolute path of the downloaded file is returned,
+            ``str`` | ``None`` | ``BytesIO`` | ``List[str]`` | ``List[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.

pyrogram/types/messages_and_media/message.py

@@ -20,6 +20,7 @@
 import logging
 from datetime import datetime
 from functools import partial
+from io import BytesIO
 from typing import BinaryIO, Callable, Dict, List, Match, Optional, Union
 
 import pyrogram
@@ -9308,7 +9309,7 @@ async def download(
         block: bool = True,
         progress: Callable = None,
         progress_args: tuple = ()
-    ) -> str:
+    ) -> Union[str, BytesIO, List[str], List[BytesIO], None]:
         """Shortcut for method :obj:`~pyrogram.Client.download_media` will automatically fill method attributes:
 
         * message
@@ -9352,7 +9353,11 @@ async def download(
                 You can either keep ``*args`` or add every single extra argument in your function signature.
 
         Returns:
-            On success, the absolute path of the downloaded file as string is returned, None otherwise.
+            ``str`` | ``None`` | ``BytesIO`` | ``List[str]`` | ``List[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 contains multiple media (purchased paid media), a list of paths or binary file-like objects is returned.
 
         Raises:
             RPCError: In case of a Telegram RPC error.

pyrogram/types/messages_and_media/story.py

@@ -17,6 +17,7 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 from datetime import datetime
+from io import BytesIO
 from typing import BinaryIO, Callable, Dict, List, Optional, Union
 
 import pyrogram
@@ -2064,7 +2065,7 @@ async def download(
         block: bool = True,
         progress: Callable = None,
         progress_args: tuple = ()
-    ) -> Optional[Union[str, BinaryIO]]:
+    ) -> Optional[Union[str, BytesIO]]:
         """Bound method *download* of :obj:`~pyrogram.types.Story`.
 
         Use as a shortcut for:
@@ -2117,7 +2118,10 @@ async def download(
                 You can either keep ``*args`` or add every single extra argument in your function signature.
 
         Returns:
-            On success, the absolute path of the downloaded file as string is returned, None otherwise.
+            ``str`` | ``None`` | ``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.
 
         Raises:
             RPCError: In case of a Telegram RPC error.