Update thumbnail type to InputFile only (#1374)

* Update thumbnail type to InputFile only The thumbnail's type restriction has been changed in several methods and types. Previously, it accepted Union[InputFile, str], allowing both InputFile instances and strings. Now it's changed to accept only InputFile instances. This change enhances meaning of the thumbnail fields in due to Bot API accepts only InputFile instances. * Added changelog * Fixed typehints
aiogram · Nov 24, 2023 · c8dff11 · c8dff11
1 parent 09af2a1
commit c8dff11
Show file tree

Hide file tree

Showing 24 changed files with 106 additions and 51 deletions.
diff --git a/.butcher/methods/sendAnimation/replace.yml b/.butcher/methods/sendAnimation/replace.yml
@@ -3,3 +3,9 @@ annotations:
     value: UNSET_PARSE_MODE
   protect_content:
     value: UNSET_PROTECT_CONTENT
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
diff --git a/.butcher/methods/sendAudio/replace.yml b/.butcher/methods/sendAudio/replace.yml
@@ -3,3 +3,9 @@ annotations:
     value: UNSET_PARSE_MODE
   protect_content:
     value: UNSET_PROTECT_CONTENT
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
diff --git a/.butcher/methods/sendDocument/replace.yml b/.butcher/methods/sendDocument/replace.yml
@@ -3,3 +3,9 @@ annotations:
     value: UNSET_PARSE_MODE
   protect_content:
     value: UNSET_PROTECT_CONTENT
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
diff --git a/.butcher/methods/sendVideo/replace.yml b/.butcher/methods/sendVideo/replace.yml
@@ -3,3 +3,9 @@ annotations:
     value: UNSET_PARSE_MODE
   protect_content:
     value: UNSET_PROTECT_CONTENT
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
diff --git a/.butcher/methods/sendVideoNote/replace.yml b/.butcher/methods/sendVideoNote/replace.yml
@@ -1,3 +1,9 @@
 annotations:
   protect_content:
     value: UNSET_PROTECT_CONTENT
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
diff --git a/.butcher/types/InputMediaAnimation/replace.yml b/.butcher/types/InputMediaAnimation/replace.yml
@@ -9,5 +9,11 @@ annotations:
           references:
             category: types
             name: InputFile
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
   parse_mode:
     value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaAudio/replace.yml b/.butcher/types/InputMediaAudio/replace.yml
@@ -9,5 +9,11 @@ annotations:
           references:
             category: types
             name: InputFile
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
   parse_mode:
     value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaDocument/replace.yml b/.butcher/types/InputMediaDocument/replace.yml
@@ -9,5 +9,11 @@ annotations:
           references:
             category: types
             name: InputFile
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
   parse_mode:
     value: UNSET_PARSE_MODE
diff --git a/.butcher/types/InputMediaVideo/replace.yml b/.butcher/types/InputMediaVideo/replace.yml
@@ -9,5 +9,11 @@ annotations:
           references:
             category: types
             name: InputFile
+  thumbnail:
+    parsed_type:
+      type: entity
+      references:
+        category: types
+        name: InputFile
   parse_mode:
     value: UNSET_PARSE_MODE
diff --git a/CHANGES/1372.misc.rst b/CHANGES/1372.misc.rst
@@ -0,0 +1 @@
+Updated :code:`thumbnail` fields type to :code:`InputFile` only
diff --git a/aiogram/client/bot.py b/aiogram/client/bot.py
@@ -2120,7 +2120,7 @@ async def send_animation(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -2190,7 +2190,7 @@ async def send_audio(
         duration: Optional[int] = None,
         performer: Optional[str] = None,
         title: Optional[str] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,
@@ -2374,7 +2374,7 @@ async def send_document(
         chat_id: Union[int, str],
         document: Union[InputFile, str],
         message_thread_id: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -2966,7 +2966,7 @@ async def send_video(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -3035,7 +3035,7 @@ async def send_video_note(
         message_thread_id: Optional[int] = None,
         duration: Optional[int] = None,
         length: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,

diff --git a/aiogram/methods/send_animation.py b/aiogram/methods/send_animation.py
@@ -38,7 +38,7 @@ class SendAnimation(TelegramMethod[Message]):
     """Animation width"""
     height: Optional[int] = None
     """Animation height"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     caption: Optional[str] = None
     """Animation caption (may also be used when resending animation by *file_id*), 0-1024 characters after entities parsing"""
@@ -74,7 +74,7 @@ def __init__(
             duration: Optional[int] = None,
             width: Optional[int] = None,
             height: Optional[int] = None,
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             caption: Optional[str] = None,
             parse_mode: Optional[str] = UNSET_PARSE_MODE,
             caption_entities: Optional[List[MessageEntity]] = None,

diff --git a/aiogram/methods/send_audio.py b/aiogram/methods/send_audio.py
@@ -45,7 +45,7 @@ class SendAudio(TelegramMethod[Message]):
     """Performer"""
     title: Optional[str] = None
     """Track name"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     disable_notification: Optional[bool] = None
     """Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
@@ -76,7 +76,7 @@ def __init__(
             duration: Optional[int] = None,
             performer: Optional[str] = None,
             title: Optional[str] = None,
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             disable_notification: Optional[bool] = None,
             protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
             reply_to_message_id: Optional[int] = None,

diff --git a/aiogram/methods/send_document.py b/aiogram/methods/send_document.py
@@ -32,7 +32,7 @@ class SendDocument(TelegramMethod[Message]):
     """File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » <sending-files>`"""
     message_thread_id: Optional[int] = None
     """Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     caption: Optional[str] = None
     """Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing"""
@@ -65,7 +65,7 @@ def __init__(
             chat_id: Union[int, str],
             document: Union[InputFile, str],
             message_thread_id: Optional[int] = None,
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             caption: Optional[str] = None,
             parse_mode: Optional[str] = UNSET_PARSE_MODE,
             caption_entities: Optional[List[MessageEntity]] = None,

diff --git a/aiogram/methods/send_video.py b/aiogram/methods/send_video.py
@@ -38,7 +38,7 @@ class SendVideo(TelegramMethod[Message]):
     """Video width"""
     height: Optional[int] = None
     """Video height"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     caption: Optional[str] = None
     """Video caption (may also be used when resending videos by *file_id*), 0-1024 characters after entities parsing"""
@@ -76,7 +76,7 @@ def __init__(
             duration: Optional[int] = None,
             width: Optional[int] = None,
             height: Optional[int] = None,
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             caption: Optional[str] = None,
             parse_mode: Optional[str] = UNSET_PARSE_MODE,
             caption_entities: Optional[List[MessageEntity]] = None,

diff --git a/aiogram/methods/send_video_note.py b/aiogram/methods/send_video_note.py
@@ -34,7 +34,7 @@ class SendVideoNote(TelegramMethod[Message]):
     """Duration of sent video in seconds"""
     length: Optional[int] = None
     """Video width and height, i.e. diameter of the video message"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     disable_notification: Optional[bool] = None
     """Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
@@ -61,7 +61,7 @@ def __init__(
             message_thread_id: Optional[int] = None,
             duration: Optional[int] = None,
             length: Optional[int] = None,
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             disable_notification: Optional[bool] = None,
             protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
             reply_to_message_id: Optional[int] = None,

diff --git a/aiogram/types/chat_join_request.py b/aiogram/types/chat_join_request.py
@@ -279,7 +279,7 @@ def answer_animation(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -352,7 +352,7 @@ def answer_animation_pm(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -428,7 +428,7 @@ def answer_audio(
         duration: Optional[int] = None,
         performer: Optional[str] = None,
         title: Optional[str] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,
@@ -499,7 +499,7 @@ def answer_audio_pm(
         duration: Optional[int] = None,
         performer: Optional[str] = None,
         title: Optional[str] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,
@@ -680,7 +680,7 @@ def answer_document(
         self,
         document: Union[InputFile, str],
         message_thread_id: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -744,7 +744,7 @@ def answer_document_pm(
         self,
         document: Union[InputFile, str],
         message_thread_id: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -1963,7 +1963,7 @@ def answer_video(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -2039,7 +2039,7 @@ def answer_video_pm(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -2114,7 +2114,7 @@ def answer_video_note(
         message_thread_id: Optional[int] = None,
         duration: Optional[int] = None,
         length: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,
@@ -2172,7 +2172,7 @@ def answer_video_note_pm(
         message_thread_id: Optional[int] = None,
         duration: Optional[int] = None,
         length: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,

diff --git a/aiogram/types/chat_member_updated.py b/aiogram/types/chat_member_updated.py
@@ -201,7 +201,7 @@ def answer_animation(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -277,7 +277,7 @@ def answer_audio(
         duration: Optional[int] = None,
         performer: Optional[str] = None,
         title: Optional[str] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,
@@ -400,7 +400,7 @@ def answer_document(
         self,
         document: Union[InputFile, str],
         message_thread_id: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -1043,7 +1043,7 @@ def answer_video(
         duration: Optional[int] = None,
         width: Optional[int] = None,
         height: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         caption: Optional[str] = None,
         parse_mode: Optional[str] = UNSET_PARSE_MODE,
         caption_entities: Optional[List[MessageEntity]] = None,
@@ -1118,7 +1118,7 @@ def answer_video_note(
         message_thread_id: Optional[int] = None,
         duration: Optional[int] = None,
         length: Optional[int] = None,
-        thumbnail: Optional[Union[InputFile, str]] = None,
+        thumbnail: Optional[InputFile] = None,
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = UNSET_PROTECT_CONTENT,
         reply_to_message_id: Optional[int] = None,

diff --git a/aiogram/types/input_media_animation.py b/aiogram/types/input_media_animation.py
@@ -22,7 +22,7 @@ class InputMediaAnimation(InputMedia):
     """Type of the result, must be *animation*"""
     media: Union[str, InputFile]
     """File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`"""
-    thumbnail: Optional[Union[InputFile, str]] = None
+    thumbnail: Optional[InputFile] = None
     """*Optional*. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`"""
     caption: Optional[str] = None
     """*Optional*. Caption of the animation to be sent, 0-1024 characters after entities parsing"""
@@ -48,7 +48,7 @@ def __init__(
             *,
             type: Literal[InputMediaType.ANIMATION] = InputMediaType.ANIMATION,
             media: Union[str, InputFile],
-            thumbnail: Optional[Union[InputFile, str]] = None,
+            thumbnail: Optional[InputFile] = None,
             caption: Optional[str] = None,
             parse_mode: Optional[str] = UNSET_PARSE_MODE,
             caption_entities: Optional[List[MessageEntity]] = None,