This commit is contained in:
Harshil 2022-02-03 00:05:46 +04:00 committed by GitHub
parent ade1529986
commit a35ecf4065
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 249 additions and 61 deletions

View file

@ -20,7 +20,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr
:target: https://pypi.org/project/python-telegram-bot/ :target: https://pypi.org/project/python-telegram-bot/
:alt: Supported Python versions :alt: Supported Python versions
.. image:: https://img.shields.io/badge/Bot%20API-5.6-blue?logo=telegram .. image:: https://img.shields.io/badge/Bot%20API-5.7-blue?logo=telegram
:target: https://core.telegram.org/bots/api-changelog :target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions :alt: Supported Bot API versions
@ -111,7 +111,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
Telegram API support Telegram API support
==================== ====================
All types and methods of the Telegram Bot API **5.6** are supported. All types and methods of the Telegram Bot API **5.7** are supported.
========== ==========
Installing Installing

View file

@ -20,7 +20,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr
:target: https://pypi.org/project/python-telegram-bot-raw/ :target: https://pypi.org/project/python-telegram-bot-raw/
:alt: Supported Python versions :alt: Supported Python versions
.. image:: https://img.shields.io/badge/Bot%20API-5.6-blue?logo=telegram .. image:: https://img.shields.io/badge/Bot%20API-5.7-blue?logo=telegram
:target: https://core.telegram.org/bots/api-changelog :target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions :alt: Supported Bot API versions
@ -105,7 +105,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
Telegram API support Telegram API support
==================== ====================
All types and methods of the Telegram Bot API **5.6** are supported. All types and methods of the Telegram Bot API **5.7** are supported.
========== ==========
Installing Installing

View file

@ -996,7 +996,7 @@ class Bot(TelegramObject):
protect_content: bool = None, protect_content: bool = None,
) -> Message: ) -> Message:
""" """
Use this method to send static .WEBP or animated .TGS stickers. Use this method to send static ``.WEBP``, animated ``.TGS``, or video ``.WEBM`` stickers.
Note: Note:
The sticker argument can be either a file_id, an URL or a file from disk The sticker argument can be either a file_id, an URL or a file from disk
@ -4753,7 +4753,7 @@ class Bot(TelegramObject):
api_kwargs: JSONDict = None, api_kwargs: JSONDict = None,
) -> File: ) -> File:
""" """
Use this method to upload a .png file with a sticker for later use in Use this method to upload a ``.PNG`` file with a sticker for later use in
:meth:`create_new_sticker_set` and :meth:`add_sticker_to_set` methods (can be used multiple :meth:`create_new_sticker_set` and :meth:`add_sticker_to_set` methods (can be used multiple
times). times).
@ -4764,9 +4764,8 @@ class Bot(TelegramObject):
Args: Args:
user_id (:obj:`int`): User identifier of sticker file owner. user_id (:obj:`int`): User identifier of sticker file owner.
png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`): png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`):
Png image with the sticker, **PNG** image with the sticker, must be up to 512 kilobytes in size,
must be up to 512 kilobytes in size, dimensions must not exceed 512px, dimensions must not exceed 512px, and either width or height must be exactly 512px.
and either width or height must be exactly 512px.
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.
@ -4802,11 +4801,13 @@ class Bot(TelegramObject):
timeout: DVInput[float] = DEFAULT_20, timeout: DVInput[float] = DEFAULT_20,
tgs_sticker: FileInput = None, tgs_sticker: FileInput = None,
api_kwargs: JSONDict = None, api_kwargs: JSONDict = None,
webm_sticker: FileInput = None,
) -> bool: ) -> bool:
""" """
Use this method to create new sticker set owned by a user. Use this method to create new sticker set owned by a user.
The bot will be able to edit the created sticker set. The bot will be able to edit the created sticker set.
You must use exactly one of the fields ``png_sticker`` or ``tgs_sticker``. You must use exactly one of the fields ``png_sticker``, ``tgs_sticker``, or
``webm_sticker``.
Warning: Warning:
As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the
@ -4826,7 +4827,7 @@ class Bot(TelegramObject):
1-64 characters. 1-64 characters.
title (:obj:`str`): Sticker set title, 1-64 characters. title (:obj:`str`): Sticker set title, 1-64 characters.
png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \ png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \
optional): Png image with the sticker, optional): **PNG** image with the sticker,
must be up to 512 kilobytes in size, dimensions must not exceed 512px, must be up to 512 kilobytes in size, dimensions must not exceed 512px,
and either width or height must be exactly 512px. Pass a file_id as a String to and either width or height must be exactly 512px. Pass a file_id as a String to
send a file that already exists on the Telegram servers, pass an HTTP URL as a send a file that already exists on the Telegram servers, pass an HTTP URL as a
@ -4836,13 +4837,19 @@ class Bot(TelegramObject):
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.
tgs_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \ tgs_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \
optional): TGS animation with the sticker, optional): **TGS** animation with the sticker, uploaded using multipart/form-data.
uploaded using multipart/form-data. See See https://core.telegram.org/stickers#animated-sticker-requirements for technical
https://core.telegram.org/animated_stickers#technical-requirements for technical
requirements. requirements.
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.
webm_sticker (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path`,\
optional): **WEBM** video with the sticker, uploaded using multipart/form-data.
See https://core.telegram.org/stickers#video-sticker-requirements for
technical requirements.
.. versionadded:: 13.11
emojis (:obj:`str`): One or more emoji corresponding to the sticker. emojis (:obj:`str`): One or more emoji corresponding to the sticker.
contains_masks (:obj:`bool`, optional): Pass :obj:`True`, if a set of mask stickers contains_masks (:obj:`bool`, optional): Pass :obj:`True`, if a set of mask stickers
should be created. should be created.
@ -4867,6 +4874,8 @@ class Bot(TelegramObject):
data['png_sticker'] = parse_file_input(png_sticker) data['png_sticker'] = parse_file_input(png_sticker)
if tgs_sticker is not None: if tgs_sticker is not None:
data['tgs_sticker'] = parse_file_input(tgs_sticker) data['tgs_sticker'] = parse_file_input(tgs_sticker)
if webm_sticker is not None:
data['webm_sticker'] = parse_file_input(webm_sticker)
if contains_masks is not None: if contains_masks is not None:
data['contains_masks'] = contains_masks data['contains_masks'] = contains_masks
if mask_position is not None: if mask_position is not None:
@ -4889,12 +4898,14 @@ class Bot(TelegramObject):
timeout: DVInput[float] = DEFAULT_20, timeout: DVInput[float] = DEFAULT_20,
tgs_sticker: FileInput = None, tgs_sticker: FileInput = None,
api_kwargs: JSONDict = None, api_kwargs: JSONDict = None,
webm_sticker: FileInput = None,
) -> bool: ) -> bool:
""" """
Use this method to add a new sticker to a set created by the bot. Use this method to add a new sticker to a set created by the bot.
You must use exactly one of the fields ``png_sticker`` or ``tgs_sticker``. Animated You **must** use exactly one of the fields ``png_sticker``, ``tgs_sticker`` or
stickers can be added to animated sticker sets and only to them. Animated sticker sets can ``webm_sticker``. Animated stickers can be added to animated sticker sets and only to them.
have up to 50 stickers. Static sticker sets can have up to 120 stickers. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120
stickers.
Warning: Warning:
As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the
@ -4910,7 +4921,7 @@ class Bot(TelegramObject):
name (:obj:`str`): Sticker set name. name (:obj:`str`): Sticker set name.
png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \ png_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \
optional): PNG image with the sticker, optional): **PNG** image with the sticker,
must be up to 512 kilobytes in size, dimensions must not exceed 512px, must be up to 512 kilobytes in size, dimensions must not exceed 512px,
and either width or height must be exactly 512px. Pass a file_id as a String to and either width or height must be exactly 512px. Pass a file_id as a String to
send a file that already exists on the Telegram servers, pass an HTTP URL as a send a file that already exists on the Telegram servers, pass an HTTP URL as a
@ -4920,13 +4931,18 @@ class Bot(TelegramObject):
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.
tgs_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \ tgs_sticker (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \
optional): TGS animation with the sticker, optional): **TGS** animation with the sticker, uploaded using multipart/form-data.
uploaded using multipart/form-data. See See https://core.telegram.org/stickers#animated-sticker-requirements for technical
https://core.telegram.org/animated_stickers#technical-requirements for technical
requirements. requirements.
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.
webm_sticker (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path`,\
optional): **WEBM** video with the sticker, uploaded using multipart/form-data.
See https://core.telegram.org/stickers#video-sticker-requirements for
technical requirements.
.. versionadded:: 13.11
emojis (:obj:`str`): One or more emoji corresponding to the sticker. emojis (:obj:`str`): One or more emoji corresponding to the sticker.
mask_position (:class:`telegram.MaskPosition`, optional): Position where the mask mask_position (:class:`telegram.MaskPosition`, optional): Position where the mask
should be placed on faces. should be placed on faces.
@ -4949,6 +4965,8 @@ class Bot(TelegramObject):
data['png_sticker'] = parse_file_input(png_sticker) data['png_sticker'] = parse_file_input(png_sticker)
if tgs_sticker is not None: if tgs_sticker is not None:
data['tgs_sticker'] = parse_file_input(tgs_sticker) data['tgs_sticker'] = parse_file_input(tgs_sticker)
if webm_sticker is not None:
data['webm_sticker'] = parse_file_input(webm_sticker)
if mask_position is not None: if mask_position is not None:
# We need to_json() instead of to_dict() here, because we're sending a media # We need to_json() instead of to_dict() here, because we're sending a media
# message here, which isn't json dumped by utils.request # message here, which isn't json dumped by utils.request
@ -5032,7 +5050,8 @@ class Bot(TelegramObject):
api_kwargs: JSONDict = None, api_kwargs: JSONDict = None,
) -> bool: ) -> bool:
"""Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set """Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set
for animated sticker sets only. for animated sticker sets only. Video thumbnails can be set only for video sticker sets
only.
Note: Note:
The thumb can be either a file_id, an URL or a file from disk ``open(filename, 'rb')`` The thumb can be either a file_id, an URL or a file from disk ``open(filename, 'rb')``
@ -5041,14 +5060,17 @@ class Bot(TelegramObject):
name (:obj:`str`): Sticker set name name (:obj:`str`): Sticker set name
user_id (:obj:`int`): User identifier of created sticker set owner. user_id (:obj:`int`): User identifier of created sticker set owner.
thumb (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \ thumb (:obj:`str` | `filelike object` | :obj:`bytes` | :class:`pathlib.Path`, \
optional): A PNG image with the thumbnail, must optional): A **PNG** image with the thumbnail, must
be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS be up to 128 kilobytes in size and have width and height exactly 100px, or a
animation with the thumbnail up to 32 kilobytes in size; see **TGS** animation with the thumbnail up to 32 kilobytes in size; see
https://core.telegram.org/animated_stickers#technical-requirements for animated https://core.telegram.org/stickers#animated-sticker-requirements for animated
sticker technical requirements. Pass a file_id as a String to send a file that sticker technical requirements, or a **WEBM** video with the thumbnail up to 32
kilobytes in size; see
https://core.telegram.org/stickers#video-sticker-requirements for video sticker
technical requirements. Pass a file_id as a String to send a file that
already exists on the Telegram servers, pass an HTTP URL as a String for Telegram already exists on the Telegram servers, 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. to get a file from the Internet, or upload a new one using multipart/form-data.
Animated sticker set thumbnail can't be uploaded via HTTP URL. Animated sticker set thumbnails can't be uploaded via HTTP URL.
.. versionchanged:: 13.2 .. versionchanged:: 13.2
Accept :obj:`bytes` as input. Accept :obj:`bytes` as input.

View file

@ -21,7 +21,7 @@ The following constants were extracted from the
`Telegram Bots API <https://core.telegram.org/bots/api>`_. `Telegram Bots API <https://core.telegram.org/bots/api>`_.
Attributes: Attributes:
BOT_API_VERSION (:obj:`str`): `5.6`. Telegram Bot API version supported by this BOT_API_VERSION (:obj:`str`): `5.7`. Telegram Bot API version supported by this
version of `python-telegram-bot`. Also available as ``telegram.bot_api_version``. version of `python-telegram-bot`. Also available as ``telegram.bot_api_version``.
.. versionadded:: 13.4 .. versionadded:: 13.4
@ -247,7 +247,7 @@ Attributes:
""" """
from typing import List from typing import List
BOT_API_VERSION: str = '5.6' BOT_API_VERSION: str = '5.7'
MAX_MESSAGE_LENGTH: int = 4096 MAX_MESSAGE_LENGTH: int = 4096
MAX_CAPTION_LENGTH: int = 1024 MAX_CAPTION_LENGTH: int = 1024
ANONYMOUS_ADMIN_ID: int = 1087968824 ANONYMOUS_ADMIN_ID: int = 1087968824

View file

@ -34,6 +34,11 @@ class Sticker(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`file_unique_id` is equal. considered equal, if their :attr:`file_unique_id` is equal.
Note:
As of v13.11 ``is_video`` is a required argument and therefore the order of the
arguments had to be changed. Use keyword arguments to make sure that the arguments are
passed correctly.
Args: Args:
file_id (:obj:`str`): Identifier for this file, which can be used to download file_id (:obj:`str`): Identifier for this file, which can be used to download
or reuse the file. or reuse the file.
@ -43,6 +48,9 @@ class Sticker(TelegramObject):
width (:obj:`int`): Sticker width. width (:obj:`int`): Sticker width.
height (:obj:`int`): Sticker height. height (:obj:`int`): Sticker height.
is_animated (:obj:`bool`): :obj:`True`, if the sticker is animated. is_animated (:obj:`bool`): :obj:`True`, if the sticker is animated.
is_video (:obj:`bool`): :obj:`True`, if the sticker is a video sticker.
.. versionadded:: 13.11
thumb (:class:`telegram.PhotoSize`, optional): Sticker thumbnail in the .WEBP or .JPG thumb (:class:`telegram.PhotoSize`, optional): Sticker thumbnail in the .WEBP or .JPG
format. format.
emoji (:obj:`str`, optional): Emoji associated with the sticker emoji (:obj:`str`, optional): Emoji associated with the sticker
@ -62,6 +70,9 @@ class Sticker(TelegramObject):
width (:obj:`int`): Sticker width. width (:obj:`int`): Sticker width.
height (:obj:`int`): Sticker height. height (:obj:`int`): Sticker height.
is_animated (:obj:`bool`): :obj:`True`, if the sticker is animated. is_animated (:obj:`bool`): :obj:`True`, if the sticker is animated.
is_video (:obj:`bool`): :obj:`True`, if the sticker is a video sticker.
.. versionadded:: 13.11
thumb (:class:`telegram.PhotoSize`): Optional. Sticker thumbnail in the .webp or .jpg thumb (:class:`telegram.PhotoSize`): Optional. Sticker thumbnail in the .webp or .jpg
format. format.
emoji (:obj:`str`): Optional. Emoji associated with the sticker. emoji (:obj:`str`): Optional. Emoji associated with the sticker.
@ -78,6 +89,7 @@ class Sticker(TelegramObject):
'width', 'width',
'file_id', 'file_id',
'is_animated', 'is_animated',
'is_video',
'file_size', 'file_size',
'thumb', 'thumb',
'set_name', 'set_name',
@ -95,6 +107,7 @@ class Sticker(TelegramObject):
width: int, width: int,
height: int, height: int,
is_animated: bool, is_animated: bool,
is_video: bool,
thumb: PhotoSize = None, thumb: PhotoSize = None,
emoji: str = None, emoji: str = None,
file_size: int = None, file_size: int = None,
@ -109,6 +122,7 @@ class Sticker(TelegramObject):
self.width = int(width) self.width = int(width)
self.height = int(height) self.height = int(height)
self.is_animated = is_animated self.is_animated = is_animated
self.is_video = is_video
# Optionals # Optionals
self.thumb = thumb self.thumb = thumb
self.emoji = emoji self.emoji = emoji
@ -155,28 +169,40 @@ class StickerSet(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`name` is equal. considered equal, if their :attr:`name` is equal.
Attributes: Note:
name (:obj:`str`): Sticker set name. As of v13.11 ``is_video`` is a required argument and therefore the order of the
title (:obj:`str`): Sticker set title. arguments had to be changed. Use keyword arguments to make sure that the arguments are
is_animated (:obj:`bool`): :obj:`True`, if the sticker set contains animated stickers. passed correctly.
contains_masks (:obj:`bool`): :obj:`True`, if the sticker set contains masks.
stickers (List[:class:`telegram.Sticker`]): List of all set stickers.
thumb (:class:`telegram.PhotoSize`): Optional. Sticker set thumbnail in the .WEBP or .TGS
format.
Args: Args:
name (:obj:`str`): Sticker set name. name (:obj:`str`): Sticker set name.
title (:obj:`str`): Sticker set title. title (:obj:`str`): Sticker set title.
is_animated (:obj:`bool`): :obj:`True`, if the sticker set contains animated stickers. is_animated (:obj:`bool`): :obj:`True`, if the sticker set contains animated stickers.
is_video (:obj:`bool`): :obj:`True`, if the sticker set contains video stickers.
.. versionadded:: 13.11
contains_masks (:obj:`bool`): :obj:`True`, if the sticker set contains masks. contains_masks (:obj:`bool`): :obj:`True`, if the sticker set contains masks.
stickers (List[:class:`telegram.Sticker`]): List of all set stickers. stickers (List[:class:`telegram.Sticker`]): List of all set stickers.
thumb (:class:`telegram.PhotoSize`, optional): Sticker set thumbnail in the .WEBP or .TGS thumb (:class:`telegram.PhotoSize`, optional): Sticker set thumbnail in the ``.WEBP``,
format. ``.TGS``, or ``.WEBM`` format.
Attributes:
name (:obj:`str`): Sticker set name.
title (:obj:`str`): Sticker set title.
is_animated (:obj:`bool`): :obj:`True`, if the sticker set contains animated stickers.
is_video (:obj:`bool`): :obj:`True`, if the sticker set contains video stickers.
.. versionadded:: 13.11
contains_masks (:obj:`bool`): :obj:`True`, if the sticker set contains masks.
stickers (List[:class:`telegram.Sticker`]): List of all set stickers.
thumb (:class:`telegram.PhotoSize`): Optional. Sticker set thumbnail in the ``.WEBP``,
``.TGS`` or ``.WEBM`` format.
""" """
__slots__ = ( __slots__ = (
'is_animated', 'is_animated',
'is_video',
'contains_masks', 'contains_masks',
'thumb', 'thumb',
'title', 'title',
@ -192,12 +218,14 @@ class StickerSet(TelegramObject):
is_animated: bool, is_animated: bool,
contains_masks: bool, contains_masks: bool,
stickers: List[Sticker], stickers: List[Sticker],
is_video: bool,
thumb: PhotoSize = None, thumb: PhotoSize = None,
**_kwargs: Any, **_kwargs: Any,
): ):
self.name = name self.name = name
self.title = title self.title = title
self.is_animated = is_animated self.is_animated = is_animated
self.is_video = is_video
self.contains_masks = contains_masks self.contains_masks = contains_masks
self.stickers = stickers self.stickers = stickers
# Optionals # Optionals

Binary file not shown.

View file

@ -1429,11 +1429,11 @@ class TestBot:
assert chat_member.user.first_name == 'PTB' assert chat_member.user.first_name == 'PTB'
assert chat_member.user.last_name == 'Test user' assert chat_member.user.last_name == 'Test user'
@pytest.mark.skip(reason="Not implemented yet.") @pytest.mark.skip(reason="Not implemented since we need a supergroup with many members")
def test_set_chat_sticker_set(self): def test_set_chat_sticker_set(self):
pass pass
@pytest.mark.skip(reason="Not implemented yet.") @pytest.mark.skip(reason="Not implemented since we need a supergroup with many members")
def test_delete_chat_sticker_set(self): def test_delete_chat_sticker_set(self):
pass pass

View file

@ -272,7 +272,7 @@ class TestHelpers:
test_message.text = None test_message.text = None
test_message = build_test_message( test_message = build_test_message(
sticker=Sticker('sticker_id', 'unique_id', 50, 50, False) sticker=Sticker('sticker_id', 'unique_id', 50, 50, False, False)
) )
assert helpers.effective_message_type(test_message) == 'sticker' assert helpers.effective_message_type(test_message) == 'sticker'
test_message.sticker = None test_message.sticker = None

View file

@ -105,7 +105,7 @@ def message(bot):
) )
}, },
{'photo': [PhotoSize('photo_id', 'unique_id', 50, 50)], 'caption': 'photo_file'}, {'photo': [PhotoSize('photo_id', 'unique_id', 50, 50)], 'caption': 'photo_file'},
{'sticker': Sticker('sticker_id', 'unique_id', 50, 50, True)}, {'sticker': Sticker('sticker_id', 'unique_id', 50, 50, True, False)},
{'video': Video('video_id', 'unique_id', 12, 12, 12), 'caption': 'video_file'}, {'video': Video('video_id', 'unique_id', 12, 12, 12), 'caption': 'video_file'},
{'voice': Voice('voice_id', 'unique_id', 5)}, {'voice': Voice('voice_id', 'unique_id', 5)},
{'video_note': VideoNote('video_note_id', 'unique_id', 20, 12)}, {'video_note': VideoNote('video_note_id', 'unique_id', 20, 12)},

View file

@ -473,7 +473,7 @@ class TestPhoto:
b = PhotoSize('', photo.file_unique_id, self.width, self.height) b = PhotoSize('', photo.file_unique_id, self.width, self.height)
c = PhotoSize(photo.file_id, photo.file_unique_id, 0, 0) c = PhotoSize(photo.file_id, photo.file_unique_id, 0, 0)
d = PhotoSize('', '', self.width, self.height) d = PhotoSize('', '', self.width, self.height)
e = Sticker(photo.file_id, photo.file_unique_id, self.width, self.height, False) e = Sticker(photo.file_id, photo.file_unique_id, self.width, self.height, False, False)
assert a == b assert a == b
assert hash(a) == hash(b) assert hash(a) == hash(b)

View file

@ -54,6 +54,18 @@ def animated_sticker(bot, chat_id):
return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker
@pytest.fixture(scope='function')
def video_sticker_file():
with open('tests/data/telegram_video_sticker.webm', 'rb') as f:
yield f
@pytest.fixture(scope='class')
def video_sticker(bot, chat_id):
with open('tests/data/telegram_video_sticker.webm', 'rb') as f:
return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker
class TestSticker: class TestSticker:
# sticker_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.webp' # sticker_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.webp'
# Serving sticker from gh since our server sends wrong content_type # Serving sticker from gh since our server sends wrong content_type
@ -66,6 +78,7 @@ class TestSticker:
width = 510 width = 510
height = 512 height = 512
is_animated = False is_animated = False
is_video = False
file_size = 39518 file_size = 39518
thumb_width = 319 thumb_width = 319
thumb_height = 320 thumb_height = 320
@ -99,6 +112,7 @@ class TestSticker:
assert sticker.width == self.width assert sticker.width == self.width
assert sticker.height == self.height assert sticker.height == self.height
assert sticker.is_animated == self.is_animated assert sticker.is_animated == self.is_animated
assert sticker.is_video == self.is_video
assert sticker.file_size == self.file_size assert sticker.file_size == self.file_size
assert sticker.thumb.width == self.thumb_width assert sticker.thumb.width == self.thumb_width
assert sticker.thumb.height == self.thumb_height assert sticker.thumb.height == self.thumb_height
@ -118,6 +132,7 @@ class TestSticker:
assert message.sticker.width == sticker.width assert message.sticker.width == sticker.width
assert message.sticker.height == sticker.height assert message.sticker.height == sticker.height
assert message.sticker.is_animated == sticker.is_animated assert message.sticker.is_animated == sticker.is_animated
assert message.sticker.is_video == sticker.is_video
assert message.sticker.file_size == sticker.file_size assert message.sticker.file_size == sticker.file_size
assert isinstance(message.sticker.thumb, PhotoSize) assert isinstance(message.sticker.thumb, PhotoSize)
@ -169,6 +184,7 @@ class TestSticker:
assert message.sticker.width == sticker.width assert message.sticker.width == sticker.width
assert message.sticker.height == sticker.height assert message.sticker.height == sticker.height
assert message.sticker.is_animated == sticker.is_animated assert message.sticker.is_animated == sticker.is_animated
assert message.sticker.is_video == sticker.is_video
assert message.sticker.file_size == sticker.file_size assert message.sticker.file_size == sticker.file_size
assert isinstance(message.sticker.thumb, PhotoSize) assert isinstance(message.sticker.thumb, PhotoSize)
@ -187,6 +203,7 @@ class TestSticker:
'width': self.width, 'width': self.width,
'height': self.height, 'height': self.height,
'is_animated': self.is_animated, 'is_animated': self.is_animated,
'is_video': self.is_video,
'thumb': sticker.thumb.to_dict(), 'thumb': sticker.thumb.to_dict(),
'emoji': self.emoji, 'emoji': self.emoji,
'file_size': self.file_size, 'file_size': self.file_size,
@ -198,6 +215,7 @@ class TestSticker:
assert json_sticker.width == self.width assert json_sticker.width == self.width
assert json_sticker.height == self.height assert json_sticker.height == self.height
assert json_sticker.is_animated == self.is_animated assert json_sticker.is_animated == self.is_animated
assert json_sticker.is_video == self.is_video
assert json_sticker.emoji == self.emoji assert json_sticker.emoji == self.emoji
assert json_sticker.file_size == self.file_size assert json_sticker.file_size == self.file_size
assert json_sticker.thumb == sticker.thumb assert json_sticker.thumb == sticker.thumb
@ -268,6 +286,7 @@ class TestSticker:
assert sticker_dict['width'] == sticker.width assert sticker_dict['width'] == sticker.width
assert sticker_dict['height'] == sticker.height assert sticker_dict['height'] == sticker.height
assert sticker_dict['is_animated'] == sticker.is_animated assert sticker_dict['is_animated'] == sticker.is_animated
assert sticker_dict['is_video'] == sticker.is_video
assert sticker_dict['file_size'] == sticker.file_size assert sticker_dict['file_size'] == sticker.file_size
assert sticker_dict['thumb'] == sticker.thumb.to_dict() assert sticker_dict['thumb'] == sticker.thumb.to_dict()
@ -287,11 +306,18 @@ class TestSticker:
def test_equality(self, sticker): def test_equality(self, sticker):
a = Sticker( a = Sticker(
sticker.file_id, sticker.file_unique_id, self.width, self.height, self.is_animated sticker.file_id,
sticker.file_unique_id,
self.width,
self.height,
self.is_animated,
self.is_video,
) )
b = Sticker('', sticker.file_unique_id, self.width, self.height, self.is_animated) b = Sticker(
c = Sticker(sticker.file_id, sticker.file_unique_id, 0, 0, False) '', sticker.file_unique_id, self.width, self.height, self.is_animated, self.is_video
d = Sticker('', '', self.width, self.height, self.is_animated) )
c = Sticker(sticker.file_id, sticker.file_unique_id, 0, 0, False, True)
d = Sticker('', '', self.width, self.height, self.is_animated, self.is_video)
e = PhotoSize( e = PhotoSize(
sticker.file_id, sticker.file_unique_id, self.width, self.height, self.is_animated sticker.file_id, sticker.file_unique_id, self.width, self.height, self.is_animated
) )
@ -338,6 +364,20 @@ def animated_sticker_set(bot):
return ss return ss
@pytest.fixture(scope='function')
def video_sticker_set(bot):
ss = bot.get_sticker_set(f'video_test_by_{bot.username}')
if len(ss.stickers) > 100:
try:
for i in range(1, 50):
bot.delete_sticker_from_set(ss.stickers[-i].file_id)
except BadRequest as e:
if e.message == 'Stickerset_not_modified':
return ss
raise Exception('stickerset is growing too large.')
return ss
@pytest.fixture(scope='function') @pytest.fixture(scope='function')
def sticker_set_thumb_file(): def sticker_set_thumb_file():
f = open('tests/data/sticker_set_thumb.png', 'rb') f = open('tests/data/sticker_set_thumb.png', 'rb')
@ -348,8 +388,9 @@ def sticker_set_thumb_file():
class TestStickerSet: class TestStickerSet:
title = 'Test stickers' title = 'Test stickers'
is_animated = True is_animated = True
is_video = True
contains_masks = False contains_masks = False
stickers = [Sticker('file_id', 'file_un_id', 512, 512, True)] stickers = [Sticker('file_id', 'file_un_id', 512, 512, True, True)]
name = 'NOTAREALNAME' name = 'NOTAREALNAME'
def test_de_json(self, bot, sticker): def test_de_json(self, bot, sticker):
@ -358,6 +399,7 @@ class TestStickerSet:
'name': name, 'name': name,
'title': self.title, 'title': self.title,
'is_animated': self.is_animated, 'is_animated': self.is_animated,
'is_video': self.is_video,
'contains_masks': self.contains_masks, 'contains_masks': self.contains_masks,
'stickers': [x.to_dict() for x in self.stickers], 'stickers': [x.to_dict() for x in self.stickers],
'thumb': sticker.thumb.to_dict(), 'thumb': sticker.thumb.to_dict(),
@ -367,14 +409,58 @@ class TestStickerSet:
assert sticker_set.name == name assert sticker_set.name == name
assert sticker_set.title == self.title assert sticker_set.title == self.title
assert sticker_set.is_animated == self.is_animated assert sticker_set.is_animated == self.is_animated
assert sticker_set.is_video == self.is_video
assert sticker_set.contains_masks == self.contains_masks assert sticker_set.contains_masks == self.contains_masks
assert sticker_set.stickers == self.stickers assert sticker_set.stickers == self.stickers
assert sticker_set.thumb == sticker.thumb assert sticker_set.thumb == sticker.thumb
def test_create_sticker_set(
self, bot, chat_id, sticker_file, animated_sticker_file, video_sticker_file
):
"""Creates the sticker set (if needed) which is required for tests. Make sure that this
test comes before the tests that actually use the sticker sets!
"""
test_by = f"test_by_{bot.username}"
for sticker_set in [test_by, f'animated_{test_by}', f'video_{test_by}']:
try:
bot.get_sticker_set(sticker_set)
except BadRequest as e:
if not e.message == "Stickerset_invalid":
raise e
if sticker_set.startswith(test_by):
s = bot.create_new_sticker_set(
chat_id,
name=sticker_set,
title="Sticker Test",
png_sticker=sticker_file,
emojis='😄',
)
assert s
elif sticker_set.startswith("animated"):
a = bot.create_new_sticker_set(
chat_id,
name=sticker_set,
title="Animated Test",
tgs_sticker=animated_sticker_file,
emojis='😄',
)
assert a
elif sticker_set.startswith("video"):
v = bot.create_new_sticker_set(
chat_id,
name=sticker_set,
title="Video Test",
webm_sticker=video_sticker_file,
emojis='🤔',
)
assert v
@flaky(3, 1) @flaky(3, 1)
def test_bot_methods_1_png(self, bot, chat_id, sticker_file): def test_bot_methods_1_png(self, bot, chat_id, sticker_file):
with open('tests/data/telegram_sticker.png', 'rb') as f: with open('tests/data/telegram_sticker.png', 'rb') as f:
file = bot.upload_sticker_file(95205500, f) # chat_id was hardcoded as 95205500 but it stopped working for some reason
file = bot.upload_sticker_file(chat_id, f)
assert file assert file
assert bot.add_sticker_to_set( assert bot.add_sticker_to_set(
chat_id, f'test_by_{bot.username}', png_sticker=file.file_id, emojis='😄' chat_id, f'test_by_{bot.username}', png_sticker=file.file_id, emojis='😄'
@ -397,6 +483,13 @@ class TestStickerSet:
emojis='😄', emojis='😄',
) )
@flaky(3, 1)
def test_bot_methods_1_webm(self, bot, chat_id):
with open('tests/data/telegram_video_sticker.webm', 'rb') as f:
assert bot.add_sticker_to_set(
chat_id, f'video_test_by_{bot.username}', webm_sticker=f, emojis='🤔'
)
def test_sticker_set_to_dict(self, sticker_set): def test_sticker_set_to_dict(self, sticker_set):
sticker_set_dict = sticker_set.to_dict() sticker_set_dict = sticker_set.to_dict()
@ -404,6 +497,7 @@ class TestStickerSet:
assert sticker_set_dict['name'] == sticker_set.name assert sticker_set_dict['name'] == sticker_set.name
assert sticker_set_dict['title'] == sticker_set.title assert sticker_set_dict['title'] == sticker_set.title
assert sticker_set_dict['is_animated'] == sticker_set.is_animated assert sticker_set_dict['is_animated'] == sticker_set.is_animated
assert sticker_set_dict['is_video'] == sticker_set.is_video
assert sticker_set_dict['contains_masks'] == sticker_set.contains_masks assert sticker_set_dict['contains_masks'] == sticker_set.contains_masks
assert sticker_set_dict['stickers'][0] == sticker_set.stickers[0].to_dict() assert sticker_set_dict['stickers'][0] == sticker_set.stickers[0].to_dict()
@ -417,6 +511,11 @@ class TestStickerSet:
file_id = animated_sticker_set.stickers[0].file_id file_id = animated_sticker_set.stickers[0].file_id
assert bot.set_sticker_position_in_set(file_id, 1) assert bot.set_sticker_position_in_set(file_id, 1)
@flaky(3, 1)
def test_bot_methods_2_webm(self, bot, video_sticker_set):
file_id = video_sticker_set.stickers[0].file_id
assert bot.set_sticker_position_in_set(file_id, 1)
@flaky(10, 1) @flaky(10, 1)
def test_bot_methods_3_png(self, bot, chat_id, sticker_set_thumb_file): def test_bot_methods_3_png(self, bot, chat_id, sticker_set_thumb_file):
sleep(1) sleep(1)
@ -427,12 +526,19 @@ class TestStickerSet:
@flaky(10, 1) @flaky(10, 1)
def test_bot_methods_3_tgs(self, bot, chat_id, animated_sticker_file, animated_sticker_set): def test_bot_methods_3_tgs(self, bot, chat_id, animated_sticker_file, animated_sticker_set):
sleep(1) sleep(1)
assert bot.set_sticker_set_thumb( animated_test = f'animated_test_by_{bot.username}'
f'animated_test_by_{bot.username}', chat_id, animated_sticker_file assert bot.set_sticker_set_thumb(animated_test, chat_id, animated_sticker_file)
)
file_id = animated_sticker_set.stickers[-1].file_id file_id = animated_sticker_set.stickers[-1].file_id
# also test with file input and mask # also test with file input and mask
assert bot.set_sticker_set_thumb(f'animated_test_by_{bot.username}', chat_id, file_id) assert bot.set_sticker_set_thumb(animated_test, chat_id, file_id)
# TODO: Try the below by creating a custom .webm and not by downloading another pack's thumb
@pytest.mark.skip(
"Skipped for now since Telegram throws a 'File is too big' error "
"regardless of the .webm file size."
)
def test_bot_methods_3_webm(self, bot, chat_id, video_sticker_file, video_sticker_set):
pass
@flaky(10, 1) @flaky(10, 1)
def test_bot_methods_4_png(self, bot, sticker_set): def test_bot_methods_4_png(self, bot, sticker_set):
@ -446,6 +552,12 @@ class TestStickerSet:
file_id = animated_sticker_set.stickers[-1].file_id file_id = animated_sticker_set.stickers[-1].file_id
assert bot.delete_sticker_from_set(file_id) assert bot.delete_sticker_from_set(file_id)
@flaky(10, 1)
def test_bot_methods_4_webm(self, bot, video_sticker_set):
sleep(1)
file_id = video_sticker_set.stickers[-1].file_id
assert bot.delete_sticker_from_set(file_id)
def test_upload_sticker_file_local_files(self, monkeypatch, bot, chat_id): def test_upload_sticker_file_local_files(self, monkeypatch, bot, chat_id):
# For just test that the correct paths are passed as we have no local bot API set up # For just test that the correct paths are passed as we have no local bot API set up
test_flag = False test_flag = False
@ -469,11 +581,21 @@ class TestStickerSet:
def make_assertion(_, data, *args, **kwargs): def make_assertion(_, data, *args, **kwargs):
nonlocal test_flag nonlocal test_flag
test_flag = data.get('png_sticker') == expected and data.get('tgs_sticker') == expected test_flag = (
data.get('png_sticker') == expected
and data.get('tgs_sticker') == expected
and data.get('webm_sticker') == expected
)
monkeypatch.setattr(bot, '_post', make_assertion) monkeypatch.setattr(bot, '_post', make_assertion)
bot.create_new_sticker_set( bot.create_new_sticker_set(
chat_id, 'name', 'title', 'emoji', png_sticker=file, tgs_sticker=file chat_id,
'name',
'title',
'emoji',
png_sticker=file,
tgs_sticker=file,
webm_sticker=file,
) )
assert test_flag assert test_flag
monkeypatch.delattr(bot, '_post') monkeypatch.delattr(bot, '_post')
@ -520,10 +642,26 @@ class TestStickerSet:
assert sticker.get_file() assert sticker.get_file()
def test_equality(self): def test_equality(self):
a = StickerSet(self.name, self.title, self.is_animated, self.contains_masks, self.stickers) a = StickerSet(
b = StickerSet(self.name, self.title, self.is_animated, self.contains_masks, self.stickers) self.name,
c = StickerSet(self.name, None, None, None, None) self.title,
d = StickerSet('blah', self.title, self.is_animated, self.contains_masks, self.stickers) self.is_animated,
self.contains_masks,
self.stickers,
self.is_video,
)
b = StickerSet(
self.name,
self.title,
self.is_animated,
self.contains_masks,
self.stickers,
self.is_video,
)
c = StickerSet(self.name, None, None, None, None, None)
d = StickerSet(
'blah', self.title, self.is_animated, self.contains_masks, self.stickers, self.is_video
)
e = Audio(self.name, '', 0, None, None) e = Audio(self.name, '', 0, None, None)
assert a == b assert a == b