Fix up type hints,

Replace BinaryIO with BytesIO

Follow-Up: 7b85393

Co-authored-by: Ryuk <[email protected]>

Author: SpEcHiDe

pyrogram/methods/advanced/save_file.py

@@ -25,7 +25,7 @@
 import os
 from hashlib import md5
 from pathlib import PurePath
-from typing import Union, BinaryIO, Callable
+from typing import Union, Callable
 
 import pyrogram
 from pyrogram import StopTransmission
@@ -38,7 +38,7 @@
 class SaveFile:
     async def save_file(
         self: "pyrogram.Client",
-        path: Union[str, BinaryIO],
+        path: Union[str, "io.BytesIO"],
         file_id: int = None,
         file_part: int = 0,
         progress: Callable = None,
@@ -54,7 +54,7 @@ async def save_file(
             available yet in the Client class as an easy-to-use method).
 
         Parameters:
-            path (``str`` | ``BinaryIO``):
+            path (``str`` | :obj:`io.BytesIO`):
                 The path of the file you want to upload that exists on your local machine or a binary file-like object
                 with its attribute ".name" set for in-memory uploads.
 

pyrogram/methods/chats/set_chat_photo.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/>.
 
+import io
 import os
-from typing import Union, BinaryIO
+from typing import Union
 
 import pyrogram
 from pyrogram import raw, types, utils
@@ -29,8 +30,8 @@ async def set_chat_photo(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
         *,
-        photo: Union[str, BinaryIO] = None,
-        video: Union[str, BinaryIO] = None,
+        photo: Union[str, "io.BytesIO"] = None,
+        video: Union[str, "io.BytesIO"] = None,
         video_start_ts: float = None,
     ) -> Union["types.Message", bool]:
         """Set a new chat photo or video (H.264/MPEG-4 AVC video, max 5 seconds).
@@ -46,12 +47,12 @@ async def set_chat_photo(
             chat_id (``int`` | ``str``):
                 Unique identifier (int) or username (str) of the target chat.
 
-            photo (``str`` | ``BinaryIO``, *optional*):
+            photo (``str`` | :obj:`io.BytesIO`, *optional*):
                 New chat photo. You can pass a :obj:`~pyrogram.types.Photo` file_id, a file path to upload a new photo
                 from your local machine or a binary file-like object with its attribute
                 ".name" set for in-memory uploads.
 
-            video (``str`` | ``BinaryIO``, *optional*):
+            video (``str`` | :obj:`io.BytesIO`, *optional*):
                 New chat video. You can pass a :obj:`~pyrogram.types.Video` file_id, a file path to upload a new video
                 from your local machine or a binary file-like object with its attribute
                 ".name" set for in-memory uploads.

pyrogram/methods/messages/download_media.py

@@ -17,9 +17,10 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import asyncio
+import io
 import os
 from datetime import datetime
-from typing import Union, Optional, Callable, BinaryIO
+from typing import Union, Optional, Callable
 
 import pyrogram
 from pyrogram import types, enums
@@ -37,7 +38,7 @@ async def download_media(
         block: bool = True,
         progress: Callable = None,
         progress_args: tuple = ()
-    ) -> Optional[Union[str, BinaryIO]]:
+    ) -> Optional[Union[str, "io.BytesIO"]]:
         """Download the media from a message.
 
         .. include:: /_includes/usable-by/users-bots.rst
@@ -85,7 +86,7 @@ async def download_media(
                 You can either keep ``*args`` or add every single extra argument in your function signature.
 
         Returns:
-            ``str`` | ``None`` | ``BinaryIO``: On success, the absolute path of the downloaded file is returned,
+            ``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.

pyrogram/methods/messages/send_animation.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import Union, BinaryIO, List, Optional, Callable
+from typing import Union, List, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, enums, raw, types, utils
@@ -35,7 +36,7 @@ class SendAnimation:
     async def send_animation(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        animation: Union[str, BinaryIO],
+        animation: Union[str, "io.BytesIO"],
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
@@ -45,7 +46,7 @@ async def send_animation(
         duration: int = 0,
         width: int = 0,
         height: int = 0,
-        thumb: Union[str, BinaryIO] = None,
+        thumb: Union[str, "io.BytesIO"] = None,
         file_name: str = None,
         disable_notification: bool = None,
         reply_parameters: "types.ReplyParameters" = None,
@@ -77,7 +78,7 @@ async def send_animation(
                 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).
 
-            animation (``str`` | ``BinaryIO``):
+            animation (``str`` | :obj:`io.BytesIO`):
                 Animation to send.
                 Pass a file_id as string to send an animation that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get an animation from the Internet,
@@ -113,7 +114,7 @@ async def send_animation(
             height (``int``, *optional*):
                 Animation height.
 
-            thumb (``str`` | ``BinaryIO``, *optional*):
+            thumb (``str`` | :obj:`io.BytesIO`, *optional*):
                 Thumbnail of the animation file sent.
                 The thumbnail should be in JPEG format and less than 200 KB in size.
                 A thumbnail's width and height should not exceed 320 pixels.

pyrogram/methods/messages/send_audio.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import Union, BinaryIO, List, Optional, Callable
+from typing import Union, List, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, enums, raw, types, utils
@@ -35,14 +36,14 @@ class SendAudio:
     async def send_audio(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        audio: Union[str, BinaryIO],
+        audio: Union[str, "io.BytesIO"],
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
         duration: int = 0,
         performer: str = None,
         title: str = None,
-        thumb: Union[str, BinaryIO] = None,
+        thumb: Union[str, "io.BytesIO"] = None,
         file_name: str = None,
         disable_notification: bool = None,
         reply_parameters: "types.ReplyParameters" = None,
@@ -75,7 +76,7 @@ async def send_audio(
                 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).
 
-            audio (``str`` | ``BinaryIO``):
+            audio (``str`` | :obj:`io.BytesIO`):
                 Audio file to send.
                 Pass a file_id as string to send an audio file that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get an audio file from the Internet,
@@ -101,7 +102,7 @@ async def send_audio(
             title (``str``, *optional*):
                 Track name.
 
-            thumb (``str`` | ``BinaryIO``, *optional*):
+            thumb (``str`` | :obj:`io.BytesIO`, *optional*):
                 Thumbnail of the music file album cover.
                 The thumbnail should be in JPEG format and less than 200 KB in size.
                 A thumbnail's width and height should not exceed 320 pixels.

pyrogram/methods/messages/send_document.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import Union, BinaryIO, List, Optional, Callable
+from typing import Union, List, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, enums, raw, types, utils
@@ -35,8 +36,8 @@ class SendDocument:
     async def send_document(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        document: Union[str, BinaryIO],
-        thumb: Union[str, BinaryIO] = None,
+        document: Union[str, "io.BytesIO"],
+        thumb: Union[str, "io.BytesIO"] = None,
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
@@ -72,14 +73,14 @@ async def send_document(
                 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).
 
-            document (``str`` | ``BinaryIO``):
+            document (``str`` | :obj:`io.BytesIO`):
                 File to send.
                 Pass a file_id as string to send a file that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get a file from the Internet,
                 pass a file path as string to upload a new file that exists on your local machine, or
                 pass a binary file-like object with its attribute ".name" set for in-memory uploads.
 
-            thumb (``str`` | ``BinaryIO``, *optional*):
+            thumb (``str`` | :obj:`io.BytesIO`, *optional*):
                 Thumbnail of the file sent.
                 The thumbnail should be in JPEG format and less than 200 KB in size.
                 A thumbnail's width and height should not exceed 320 pixels.

pyrogram/methods/messages/send_photo.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import Union, BinaryIO, List, Optional, Callable
+from typing import Union, List, Optional, Callable
 
 import pyrogram
 from pyrogram import raw, enums, types, utils
@@ -35,7 +36,7 @@ class SendPhoto:
     async def send_photo(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        photo: Union[str, BinaryIO],
+        photo: Union[str, "io.BytesIO"],
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
@@ -72,7 +73,7 @@ async def send_photo(
                 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).
 
-            photo (``str`` | ``BinaryIO``):
+            photo (``str`` | :obj:`io.BytesIO`):
                 Photo to send.
                 Pass a file_id as string to send a photo that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get a photo from the Internet,

pyrogram/methods/messages/send_sticker.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import List, Union, BinaryIO, Optional, Callable
+from typing import List, Union, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, raw, types, utils
@@ -35,7 +36,7 @@ class SendSticker:
     async def send_sticker(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        sticker: Union[str, BinaryIO],
+        sticker: Union[str, "io.BytesIO"],
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
@@ -69,7 +70,7 @@ async def send_sticker(
                 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).
 
-            sticker (``str`` | ``BinaryIO``):
+            sticker (``str`` | :obj:`io.BytesIO`):
                 Sticker to send.
                 Pass a file_id as string to send a sticker that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get a .webp sticker file from the Internet,

pyrogram/methods/messages/send_video.py

@@ -17,10 +17,11 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 import re
 from datetime import datetime
-from typing import Union, BinaryIO, List, Optional, Callable
+from typing import Union, List, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, enums, raw, types, utils
@@ -35,15 +36,15 @@ class SendVideo:
     async def send_video(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        video: Union[str, BinaryIO],
+        video: Union[str, "io.BytesIO"],
         caption: str = "",
         parse_mode: Optional["enums.ParseMode"] = None,
         caption_entities: List["types.MessageEntity"] = None,
         show_caption_above_media: bool = None,
         duration: int = 0,
         width: int = 0,
         height: int = 0,
-        thumb: Union[str, BinaryIO] = None,
+        thumb: Union[str, "io.BytesIO"] = None,
         has_spoiler: bool = None,
         supports_streaming: bool = True,
         disable_notification: bool = None,
@@ -79,7 +80,7 @@ async def send_video(
                 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).
 
-            video (``str`` | ``BinaryIO``):
+            video (``str`` | :obj:`io.BytesIO`):
                 Video to send.
                 Pass a file_id as string to send a video that exists on the Telegram servers,
                 pass an HTTP URL as a string for Telegram to get a video from the Internet,
@@ -108,7 +109,7 @@ async def send_video(
             height (``int``, *optional*):
                 Video height.
 
-            thumb (``str`` | ``BinaryIO``, *optional*):
+            thumb (``str`` | :obj:`io.BytesIO`, *optional*):
                 Thumbnail of the video sent.
                 The thumbnail should be in JPEG format and less than 200 KB in size.
                 A thumbnail's width and height should not exceed 320 pixels.

pyrogram/methods/messages/send_video_note.py

@@ -17,9 +17,10 @@
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
 import logging
+import io
 import os
 from datetime import datetime
-from typing import List, Union, BinaryIO, Optional, Callable
+from typing import List, Union, Optional, Callable
 
 import pyrogram
 from pyrogram import StopTransmission, raw, types, utils
@@ -34,10 +35,10 @@ class SendVideoNote:
     async def send_video_note(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        video_note: Union[str, BinaryIO],
+        video_note: Union[str, "io.BytesIO"],
         duration: int = 0,
         length: int = 1,
-        thumb: Union[str, BinaryIO] = None,
+        thumb: Union[str, "io.BytesIO"] = None,
         disable_notification: bool = None,
         protect_content: bool = None,
         allow_paid_broadcast: bool = None,
@@ -72,7 +73,7 @@ async def send_video_note(
                 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).
 
-            video_note (``str`` | ``BinaryIO``):
+            video_note (``str`` | :obj:`io.BytesIO`):
                 Video note to send.
                 Pass a file_id as string to send a video note that exists on the Telegram servers,
                 pass a file path as string to upload a new video note that exists on your local machine, or
@@ -85,7 +86,7 @@ async def send_video_note(
             length (``int``, *optional*):
                 Video width and height.
 
-            thumb (``str`` | ``BinaryIO``, *optional*):
+            thumb (``str`` | :obj:`io.BytesIO`, *optional*):
                 Thumbnail of the video sent.
                 The thumbnail should be in JPEG format and less than 200 KB in size.
                 A thumbnail's width and height should not exceed 320 pixels.