[Bot API 4.4] Update stickers

- Add is_animated field to Sticker
- Remove send_animated_sticker (use send_sticker instead)
- Default to 512x512 in case size is unknown (instead of 0x0)

compiler/docs/compiler.py

@@ -146,7 +146,6 @@ def pyrogram_api():
             send_audio
             send_document
             send_sticker
-            send_animated_sticker
             send_video
             send_animation
             send_voice

pyrogram/client/methods/messages/__init__.py

@@ -33,7 +33,6 @@ from .get_messages import GetMessages
 from .iter_history import IterHistory
 from .read_history import ReadHistory
 from .retract_vote import RetractVote
-from .send_animated_sticker import SendAnimatedSticker
 from .send_animation import SendAnimation
 from .send_audio import SendAudio
 from .send_cached_media import SendCachedMedia
@@ -85,7 +84,6 @@ class Messages(
     IterHistory,
     SendCachedMedia,
     GetHistoryCount,
-    SendAnimatedSticker,
     ReadHistory,
     EditInlineText,
     EditInlineCaption,

pyrogram/client/methods/messages/send_animated_sticker.py

@@ -1,144 +0,0 @@
-# Pyrogram - Telegram MTProto API Client Library for Python
-# Copyright (C) 2017-2019 Dan Tès <https://github.com/delivrance>
-#
-# This file is part of Pyrogram.
-#
-# Pyrogram is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Pyrogram is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# 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 os
-from typing import Union
-
-import pyrogram
-from pyrogram.api import functions, types
-from pyrogram.client.ext import BaseClient, utils
-from pyrogram.errors import FilePartMissing
-
-
-class SendAnimatedSticker(BaseClient):
-    def send_animated_sticker(
-        self,
-        chat_id: Union[int, str],
-        animated_sticker: str,
-        disable_notification: bool = None,
-        reply_to_message_id: int = None,
-        reply_markup: Union[
-            "pyrogram.InlineKeyboardMarkup",
-            "pyrogram.ReplyKeyboardMarkup",
-            "pyrogram.ReplyKeyboardRemove",
-            "pyrogram.ForceReply"
-        ] = None,
-        progress: callable = None,
-        progress_args: tuple = ()
-    ) -> Union["pyrogram.Message", None]:
-        """Send .tgs animated stickers.
-
-        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).
-
-            animated_sticker (``str``):
-                Animated sticker to send.
-                Pass a file_id as string to send a animated sticker that exists on the Telegram servers,
-                pass an HTTP URL as a string for Telegram to get a .webp animated sticker file from the Internet, or
-                pass a file path as string to upload a new animated sticker that exists on your local machine.
-
-            disable_notification (``bool``, *optional*):
-                Sends the message silently.
-                Users will receive a notification with no sound.
-
-            reply_to_message_id (``int``, *optional*):
-                If the message is a reply, ID of the original message.
-
-            reply_markup (:obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply`, *optional*):
-                Additional interface options. An object for an inline keyboard, custom reply keyboard,
-                instructions to remove reply keyboard or to force a reply from the user.
-
-            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:
-            :obj:`Message` | ``None``: On success, the sent animated sticker message is returned, otherwise, in case the
-            upload is deliberately stopped with :meth:`~Client.stop_transmission`, None is returned.
-
-        Example:
-            .. code-block:: python
-
-                # Send animated sticker by uploading from local file
-                app.send_animated_sticker("me", "animated_sticker.tgs")
-        """
-        file = None
-
-        try:
-            if os.path.exists(animated_sticker):
-                file = self.save_file(animated_sticker, progress=progress, progress_args=progress_args)
-                media = types.InputMediaUploadedDocument(
-                    mime_type=self.guess_mime_type(animated_sticker) or "application/x-tgsticker",
-                    file=file,
-                    attributes=[
-                        types.DocumentAttributeFilename(file_name=os.path.basename(animated_sticker))
-                    ]
-                )
-            elif animated_sticker.startswith("http"):
-                media = types.InputMediaDocumentExternal(
-                    url=animated_sticker
-                )
-            else:
-                media = utils.get_input_media_from_file_id(animated_sticker, 5)
-
-            while True:
-                try:
-                    r = self.send(
-                        functions.messages.SendMedia(
-                            peer=self.resolve_peer(chat_id),
-                            media=media,
-                            silent=disable_notification or None,
-                            reply_to_msg_id=reply_to_message_id,
-                            random_id=self.rnd_id(),
-                            reply_markup=reply_markup.write() if reply_markup else None,
-                            message=""
-                        )
-                    )
-                except FilePartMissing as e:
-                    self.save_file(animated_sticker, file_id=file.id, file_part=e.x)
-                else:
-                    for i in r.updates:
-                        if isinstance(i, (types.UpdateNewMessage, types.UpdateNewChannelMessage)):
-                            return pyrogram.Message._parse(
-                                self, i.message,
-                                {i.id: i for i in r.users},
-                                {i.id: i for i in r.chats}
-                            )
-        except BaseClient.StopTransmission:
-            return None

pyrogram/client/methods/messages/send_sticker.py

@@ -41,7 +41,7 @@ class SendSticker(BaseClient):
         progress: callable = None,
         progress_args: tuple = ()
     ) -> Union["pyrogram.Message", None]:
-        """Send .webp stickers.
+        """Send static .webp or animated .tgs stickers.
 
         Parameters:
             chat_id (``int`` | ``str``):

pyrogram/client/types/messages_and_media/sticker.py

@@ -41,6 +41,9 @@ class Sticker(Object):
         height (``int``):
             Sticker height.
 
+        is_animated (``bool``):
+            True, if the sticker is animated
+
         file_name (``str``, *optional*):
             Sticker file name.
 
@@ -72,6 +75,7 @@ class Sticker(Object):
         file_id: str,
         width: int,
         height: int,
+        is_animated: bool,
         file_name: str = None,
         mime_type: str = None,
         file_size: int = None,
@@ -89,6 +93,7 @@ class Sticker(Object):
         self.date = date
         self.width = width
         self.height = height
+        self.is_animated = is_animated
         self.emoji = emoji
         self.set_name = set_name
         self.thumbs = thumbs
@@ -130,8 +135,9 @@ class Sticker(Object):
                     sticker.access_hash
                 )
             ),
-            width=image_size_attributes.w if image_size_attributes else 0,
+            width=image_size_attributes.w if image_size_attributes else 512,
-            height=image_size_attributes.h if image_size_attributes else 0,
+            height=image_size_attributes.h if image_size_attributes else 512,
+            is_animated=sticker.mime_type == "application/x-tgsticker",
             # TODO: mask_position
             set_name=set_name,
             emoji=sticker_attributes.alt or None,