OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2025-01-18 15:20:42 +01:00
Code Issues Projects Releases Packages Wiki Activity

API 5.6 (#2835)

Browse source
This commit is contained in:
Harshil 2022-01-03 11:13:33 +04:00 committed by GitHub
parent c4b413ef9e
commit 98bf378c6e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 476 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.rst
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/
:alt: Supported Python versions
.. image:: https://img.shields.io/badge/Bot%20API-5.5-blue?logo=telegram
.. image:: https://img.shields.io/badge/Bot%20API-5.6-blue?logo=telegram
:target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions
@ -111,7 +111,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
Telegram API support
====================
All types and methods of the Telegram Bot API **5.5** are supported.
All types and methods of the Telegram Bot API **5.6** are supported.
==========
Installing

4
README_RAW.rst
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/
:alt: Supported Python versions
.. image:: https://img.shields.io/badge/Bot%20API-5.5-blue?logo=telegram
.. image:: https://img.shields.io/badge/Bot%20API-5.6-blue?logo=telegram
:target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions
@ -105,7 +105,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
Telegram API support
====================
All types and methods of the Telegram Bot API **5.5** are supported.
All types and methods of the Telegram Bot API **5.6** are supported.
==========
Installing

144
telegram/bot.py
View file

@ -306,10 +306,14 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> Union[bool, Message]:
if reply_to_message_id is not None:
data['reply_to_message_id'] = reply_to_message_id
if protect_content:
data['protect_content'] = protect_content
# We don't check if (DEFAULT_)None here, so that _put is able to insert the defaults
# correctly, if necessary
data['disable_notification'] = disable_notification
@ -463,6 +467,7 @@ class Bot(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> Message:
"""Use this method to send text messages.
@ -480,6 +485,10 @@ class Bot(TelegramObject):
this message.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of sent messages from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -519,6 +528,7 @@ class Bot(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -576,6 +586,7 @@ class Bot(TelegramObject):
disable_notification: DVInput[bool] = DEFAULT_NONE,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> Message:
"""Use this method to forward messages of any kind. Service messages can't be forwarded.
@ -595,6 +606,11 @@ class Bot(TelegramObject):
message_id (:obj:`int`): Message identifier in the chat specified in from_chat_id.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
the read timeout from the server (instead of the one specified during creation of
the connection pool).
@ -616,13 +632,13 @@ class Bot(TelegramObject):
data['from_chat_id'] = from_chat_id
if message_id:
data['message_id'] = message_id
return self._message( # type: ignore[return-value]
'forwardMessage',
data,
disable_notification=disable_notification,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -640,6 +656,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""Use this method to send photos.
@ -674,6 +691,11 @@ class Bot(TelegramObject):
:attr:`parse_mode`.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -713,6 +735,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -734,6 +757,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send audio files, if you want Telegram clients to display them in the
@ -778,6 +802,11 @@ class Bot(TelegramObject):
title (:obj:`str`, optional): Track name.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -834,6 +863,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -853,6 +883,7 @@ class Bot(TelegramObject):
disable_content_type_detection: bool = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send general files.
@ -891,6 +922,11 @@ class Bot(TelegramObject):
:attr:`parse_mode`.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -943,6 +979,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -956,6 +993,7 @@ class Bot(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""
Use this method to send static .WEBP or animated .TGS stickers.
@ -978,6 +1016,11 @@ class Bot(TelegramObject):
Accept :obj:`bytes` as input.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1007,6 +1050,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1029,6 +1073,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send video files, Telegram clients support mp4 videos
@ -1076,6 +1121,11 @@ class Bot(TelegramObject):
suitable for streaming.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1133,6 +1183,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1150,6 +1201,7 @@ class Bot(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long.
@ -1184,6 +1236,11 @@ class Bot(TelegramObject):
message.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1232,6 +1289,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1253,6 +1311,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
@ -1303,6 +1362,11 @@ class Bot(TelegramObject):
:attr:`parse_mode`.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1349,6 +1413,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1367,6 +1432,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send audio files, if you want Telegram clients to display the file
@ -1406,6 +1472,11 @@ class Bot(TelegramObject):
duration (:obj:`int`, optional): Duration of the voice message in seconds.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1447,6 +1518,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1461,6 +1533,7 @@ class Bot(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> List[Message]:
"""Use this method to send a group of photos or videos as an album.
@ -1472,6 +1545,11 @@ class Bot(TelegramObject):
describing messages to be sent, must include 2–10 items.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1503,6 +1581,9 @@ class Bot(TelegramObject):
if reply_to_message_id:
data['reply_to_message_id'] = reply_to_message_id
if protect_content:
data['protect_content'] = protect_content
result = self._post('sendMediaGroup', data, timeout=timeout, api_kwargs=api_kwargs)
return Message.de_list(result, self) # type: ignore
@ -1524,6 +1605,7 @@ class Bot(TelegramObject):
heading: int = None,
proximity_alert_radius: int = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""Use this method to send point on the map.
@ -1547,6 +1629,11 @@ class Bot(TelegramObject):
between 1 and 100000 if specified.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1601,6 +1688,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1761,6 +1849,7 @@ class Bot(TelegramObject):
google_place_id: str = None,
google_place_type: str = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""Use this method to send information about a venue.
@ -1790,6 +1879,11 @@ class Bot(TelegramObject):
venue (:class:`telegram.Venue`, optional): The venue to send.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1852,6 +1946,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1869,6 +1964,7 @@ class Bot(TelegramObject):
vcard: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""Use this method to send phone contacts.
@ -1887,6 +1983,11 @@ class Bot(TelegramObject):
contact (:class:`telegram.Contact`, optional): The contact to send.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1938,6 +2039,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -1951,6 +2053,7 @@ class Bot(TelegramObject):
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""Use this method to send a game.
@ -1960,6 +2063,11 @@ class Bot(TelegramObject):
for the game. Set up your games via `@BotFather <https://t.me/BotFather>`_.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -1991,6 +2099,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -3505,6 +3614,7 @@ class Bot(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
max_tip_amount: int = None,
suggested_tip_amounts: List[int] = None,
protect_content: bool = None,
) -> Message:
"""Use this method to send invoices.
@ -3579,6 +3689,11 @@ class Bot(TelegramObject):
the shipping method.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -3651,6 +3766,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -5021,6 +5137,7 @@ class Bot(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
explanation_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> Message:
"""
Use this method to send a native poll.
@ -5059,6 +5176,11 @@ class Bot(TelegramObject):
immediately closed. This can be useful for poll preview.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -5118,6 +5240,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -5177,6 +5300,7 @@ class Bot(TelegramObject):
emoji: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> Message:
"""
Use this method to send an animated emoji that will display a random value.
@ -5193,6 +5317,11 @@ class Bot(TelegramObject):
Added the "🎳" emoji.
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -5213,9 +5342,7 @@ class Bot(TelegramObject):
:class:`telegram.error.TelegramError`
"""
data: JSONDict = {
'chat_id': chat_id,
}
data: JSONDict = {'chat_id': chat_id}
if emoji:
data['emoji'] = emoji
@ -5229,6 +5356,7 @@ class Bot(TelegramObject):
reply_markup=reply_markup,
allow_sending_without_reply=allow_sending_without_reply,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
@log
@ -5454,6 +5582,7 @@ class Bot(TelegramObject):
reply_markup: ReplyMarkup = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> MessageId:
"""
Use this method to copy messages of any kind. Service messages and invoice messages can't
@ -5475,6 +5604,11 @@ class Bot(TelegramObject):
parse_mode
disable_notification (:obj:`bool`, optional): Sends the message silently. Users will
receive a notification with no sound.
protect_content (:obj:`bool`, optional): Protects the contents of the sent message from
forwarding and saving.
.. versionadded:: 13.10
reply_to_message_id (:obj:`int`, optional): If the message is a reply, ID of the
original message.
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
@ -5508,6 +5642,8 @@ class Bot(TelegramObject):
data['caption_entities'] = caption_entities
if reply_to_message_id:
data['reply_to_message_id'] = reply_to_message_id
if protect_content:
data['protect_content'] = protect_content
if reply_markup:
if isinstance(reply_markup, ReplyMarkup):
# We need to_json() instead of to_dict() here, because reply_markups may be

2
telegram/callbackquery.py
View file

@ -620,6 +620,7 @@ class CallbackQuery(TelegramObject):
reply_markup: ReplyMarkup = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -648,6 +649,7 @@ class CallbackQuery(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
MAX_ANSWER_TEXT_LENGTH: ClassVar[int] = constants.MAX_ANSWER_CALLBACK_QUERY_TEXT_LENGTH

38
telegram/chat.py
View file

@ -792,6 +792,7 @@ class Chat(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -815,6 +816,7 @@ class Chat(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def send_media_group(
@ -827,6 +829,7 @@ class Chat(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> List['Message']:
"""Shortcut for::
@ -846,6 +849,7 @@ class Chat(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_chat_action(
@ -887,6 +891,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -911,6 +916,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_contact(
@ -926,6 +932,7 @@ class Chat(TelegramObject):
vcard: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -950,6 +957,7 @@ class Chat(TelegramObject):
vcard=vcard,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_audio(
@ -969,6 +977,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -997,6 +1006,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_document(
@ -1014,6 +1024,7 @@ class Chat(TelegramObject):
disable_content_type_detection: bool = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1040,6 +1051,7 @@ class Chat(TelegramObject):
disable_content_type_detection=disable_content_type_detection,
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
protect_content=protect_content,
)
def send_dice(
@ -1051,6 +1063,7 @@ class Chat(TelegramObject):
emoji: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1071,6 +1084,7 @@ class Chat(TelegramObject):
emoji=emoji,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_game(
@ -1082,6 +1096,7 @@ class Chat(TelegramObject):
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1102,6 +1117,7 @@ class Chat(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_invoice(
@ -1133,6 +1149,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
max_tip_amount: int = None,
suggested_tip_amounts: List[int] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1181,6 +1198,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
max_tip_amount=max_tip_amount,
suggested_tip_amounts=suggested_tip_amounts,
protect_content=protect_content,
)
def send_location(
@ -1198,6 +1216,7 @@ class Chat(TelegramObject):
heading: int = None,
proximity_alert_radius: int = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1224,6 +1243,7 @@ class Chat(TelegramObject):
heading=heading,
proximity_alert_radius=proximity_alert_radius,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_animation(
@ -1243,6 +1263,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1271,6 +1292,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_sticker(
@ -1282,6 +1304,7 @@ class Chat(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1302,6 +1325,7 @@ class Chat(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_venue(
@ -1321,6 +1345,7 @@ class Chat(TelegramObject):
google_place_id: str = None,
google_place_type: str = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1349,6 +1374,7 @@ class Chat(TelegramObject):
google_place_id=google_place_id,
google_place_type=google_place_type,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_video(
@ -1369,6 +1395,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1398,6 +1425,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_video_note(
@ -1413,6 +1441,7 @@ class Chat(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1437,6 +1466,7 @@ class Chat(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
filename=filename,
protect_content=protect_content,
)
def send_voice(
@ -1453,6 +1483,7 @@ class Chat(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1478,6 +1509,7 @@ class Chat(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_poll(
@ -1501,6 +1533,7 @@ class Chat(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
explanation_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1532,6 +1565,7 @@ class Chat(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
explanation_entities=explanation_entities,
protect_content=protect_content,
)
def send_copy(
@ -1547,6 +1581,7 @@ class Chat(TelegramObject):
reply_markup: 'ReplyMarkup' = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1571,6 +1606,7 @@ class Chat(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def copy_message(
@ -1586,6 +1622,7 @@ class Chat(TelegramObject):
reply_markup: 'ReplyMarkup' = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1610,6 +1647,7 @@ class Chat(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def export_invite_link(

9
telegram/constants.py
View file

@ -21,7 +21,7 @@ The following constants were extracted from the
`Telegram Bots API <https://core.telegram.org/bots/api>`_.
Attributes:
BOT_API_VERSION (:obj:`str`): `5.5`. Telegram Bot API version supported by this
BOT_API_VERSION (:obj:`str`): `5.6`. Telegram Bot API version supported by this
version of `python-telegram-bot`. Also available as ``telegram.bot_api_version``.
.. versionadded:: 13.4
@ -141,6 +141,9 @@ Attributes:
MESSAGEENTITY_TEXT_MENTION (:obj:`str`): ``'text_mention'``
MESSAGEENTITY_UNDERLINE (:obj:`str`): ``'underline'``
MESSAGEENTITY_STRIKETHROUGH (:obj:`str`): ``'strikethrough'``
MESSAGEENTITY_SPOILER (:obj:`str`): ``'spoiler'``
.. versionadded:: 13.10
MESSAGEENTITY_ALL_TYPES (List[:obj:`str`]): List of all the types of message entity.
:class:`telegram.ParseMode`:
@ -244,7 +247,7 @@ Attributes:
"""
from typing import List
BOT_API_VERSION: str = '5.5'
BOT_API_VERSION: str = '5.6'
MAX_MESSAGE_LENGTH: int = 4096
MAX_CAPTION_LENGTH: int = 1024
ANONYMOUS_ADMIN_ID: int = 1087968824
@ -321,6 +324,7 @@ MESSAGEENTITY_TEXT_LINK: str = 'text_link'
MESSAGEENTITY_TEXT_MENTION: str = 'text_mention'
MESSAGEENTITY_UNDERLINE: str = 'underline'
MESSAGEENTITY_STRIKETHROUGH: str = 'strikethrough'
MESSAGEENTITY_SPOILER: str = 'spoiler'
MESSAGEENTITY_ALL_TYPES: List[str] = [
MESSAGEENTITY_MENTION,
MESSAGEENTITY_HASHTAG,
@ -337,6 +341,7 @@ MESSAGEENTITY_ALL_TYPES: List[str] = [
MESSAGEENTITY_TEXT_MENTION,
MESSAGEENTITY_UNDERLINE,
MESSAGEENTITY_STRIKETHROUGH,
MESSAGEENTITY_SPOILER,
]
PARSEMODE_MARKDOWN: str = 'Markdown'

4
telegram/ext/extbot.py
View file

@ -193,6 +193,7 @@ class ExtBot(telegram.bot.Bot):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> Union[bool, Message]:
# We override this method to call self._replace_keyboard and self._insert_callback_data.
# This covers most methods that have a reply_markup
@ -205,6 +206,7 @@ class ExtBot(telegram.bot.Bot):
allow_sending_without_reply=allow_sending_without_reply,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
if isinstance(result, Message):
self._insert_callback_data(result)
@ -299,6 +301,7 @@ class ExtBot(telegram.bot.Bot):
reply_markup: ReplyMarkup = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> MessageId:
# We override this method to call self._replace_keyboard
return super().copy_message(
@ -314,6 +317,7 @@ class ExtBot(telegram.bot.Bot):
reply_markup=self._replace_keyboard(reply_markup),
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def get_chat(

100
telegram/message.py
View file

@ -769,6 +769,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -799,6 +800,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def reply_markdown(
@ -813,6 +815,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -853,6 +856,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def reply_markdown_v2(
@ -867,6 +871,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -903,6 +908,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def reply_html(
@ -917,6 +923,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -953,6 +960,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def reply_media_group(
@ -966,6 +974,7 @@ class Message(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> List['Message']:
"""Shortcut for::
@ -994,6 +1003,7 @@ class Message(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_photo(
@ -1010,6 +1020,7 @@ class Message(TelegramObject):
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1041,6 +1052,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def reply_audio(
@ -1061,6 +1073,7 @@ class Message(TelegramObject):
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1096,6 +1109,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def reply_document(
@ -1114,6 +1128,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1147,6 +1162,7 @@ class Message(TelegramObject):
disable_content_type_detection=disable_content_type_detection,
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
protect_content=protect_content,
)
def reply_animation(
@ -1167,6 +1183,7 @@ class Message(TelegramObject):
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1202,6 +1219,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def reply_sticker(
@ -1214,6 +1232,7 @@ class Message(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1241,6 +1260,7 @@ class Message(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_video(
@ -1262,6 +1282,7 @@ class Message(TelegramObject):
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1298,6 +1319,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def reply_video_note(
@ -1314,6 +1336,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1345,6 +1368,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
filename=filename,
protect_content=protect_content,
)
def reply_voice(
@ -1362,6 +1386,7 @@ class Message(TelegramObject):
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1394,6 +1419,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def reply_location(
@ -1412,6 +1438,7 @@ class Message(TelegramObject):
proximity_alert_radius: int = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1445,6 +1472,7 @@ class Message(TelegramObject):
heading=heading,
proximity_alert_radius=proximity_alert_radius,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_venue(
@ -1465,6 +1493,7 @@ class Message(TelegramObject):
google_place_type: str = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1500,6 +1529,7 @@ class Message(TelegramObject):
google_place_id=google_place_id,
google_place_type=google_place_type,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_contact(
@ -1516,6 +1546,7 @@ class Message(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1547,6 +1578,7 @@ class Message(TelegramObject):
vcard=vcard,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_poll(
@ -1570,6 +1602,7 @@ class Message(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
explanation_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1608,6 +1641,7 @@ class Message(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
explanation_entities=explanation_entities,
protect_content=protect_content,
)
def reply_dice(
@ -1620,6 +1654,7 @@ class Message(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1647,6 +1682,7 @@ class Message(TelegramObject):
emoji=emoji,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_chat_action(
@ -1684,6 +1720,7 @@ class Message(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
quote: bool = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1713,6 +1750,7 @@ class Message(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def reply_invoice(
@ -1745,6 +1783,7 @@ class Message(TelegramObject):
quote: bool = None,
max_tip_amount: int = None,
suggested_tip_amounts: List[int] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1802,6 +1841,7 @@ class Message(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
max_tip_amount=max_tip_amount,
suggested_tip_amounts=suggested_tip_amounts,
protect_content=protect_content,
)
def forward(
@ -1810,6 +1850,7 @@ class Message(TelegramObject):
disable_notification: DVInput[bool] = DEFAULT_NONE,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1840,6 +1881,7 @@ class Message(TelegramObject):
disable_notification=disable_notification,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def copy(
@ -1854,6 +1896,7 @@ class Message(TelegramObject):
reply_markup: ReplyMarkup = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1882,6 +1925,7 @@ class Message(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def reply_copy(
@ -1898,6 +1942,7 @@ class Message(TelegramObject):
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
quote: bool = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1935,6 +1980,7 @@ class Message(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def edit_text(
@ -2531,6 +2577,8 @@ class Message(TelegramObject):
insert = '<u>' + text + '</u>'
elif entity.type == MessageEntity.STRIKETHROUGH:
insert = '<s>' + text + '</s>'
elif entity.type == MessageEntity.SPOILER:
insert = f'<span class="tg-spoiler">{text}</span>'
else:
insert = text
@ -2583,6 +2631,9 @@ class Message(TelegramObject):
Use this if you want to retrieve the message text with the entities formatted as HTML in
the same way the original message was formatted.
.. versionchanged:: 13.10
Spoiler entities are now formatted as HTML.
Returns:
:obj:`str`: Message text with entities formatted as HTML.
@ -2596,6 +2647,9 @@ class Message(TelegramObject):
Use this if you want to retrieve the message text with the entities formatted as HTML.
This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink.
.. versionchanged:: 13.10
Spoiler entities are now formatted as HTML.
Returns:
:obj:`str`: Message text with entities formatted as HTML.
@ -2610,9 +2664,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message caption with the caption entities formatted as
HTML in the same way the original message was formatted.
.. versionchanged:: 13.10
Spoiler entities are now formatted as HTML.
Returns:
:obj:`str`: Message caption with caption entities formatted as HTML.
"""
return self._parse_html(self.caption, self.parse_caption_entities(), urled=False)
@ -2624,9 +2680,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message caption with the caption entities formatted as
HTML. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink.
.. versionchanged:: 13.10
Spoiler entities are now formatted as HTML.
Returns:
:obj:`str`: Message caption with caption entities formatted as HTML.
"""
return self._parse_html(self.caption, self.parse_caption_entities(), urled=True)
@ -2735,6 +2793,12 @@ class Message(TelegramObject):
'Strikethrough entities are not supported for Markdown ' 'version 1'
)
insert = '~' + text + '~'
elif entity.type == MessageEntity.SPOILER:
if version == 1:
raise ValueError(
"Spoiler entities are not supported for Markdown version 1"
)
insert = f"||{text}||"
else:
insert = text
@ -2804,6 +2868,10 @@ class Message(TelegramObject):
Returns:
:obj:`str`: Message text with entities formatted as Markdown.
Raises:
:exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested
entities.
"""
return self._parse_markdown(self.text, self.parse_entities(), urled=False)
@ -2815,9 +2883,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message text with the entities formatted as Markdown
in the same way the original message was formatted.
.. versionchanged:: 13.10
Spoiler entities are now formatted as Markdown V2.
Returns:
:obj:`str`: Message text with entities formatted as Markdown.
"""
return self._parse_markdown(self.text, self.parse_entities(), urled=False, version=2)
@ -2836,6 +2906,10 @@ class Message(TelegramObject):
Returns:
:obj:`str`: Message text with entities formatted as Markdown.
Raises:
:exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested
entities.
"""
return self._parse_markdown(self.text, self.parse_entities(), urled=True)
@ -2847,9 +2921,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message text with the entities formatted as Markdown.
This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink.
.. versionchanged:: 13.10
Spoiler entities are now formatted as Markdown V2.
Returns:
:obj:`str`: Message text with entities formatted as Markdown.
"""
return self._parse_markdown(self.text, self.parse_entities(), urled=True, version=2)
@ -2868,6 +2944,10 @@ class Message(TelegramObject):
Returns:
:obj:`str`: Message caption with caption entities formatted as Markdown.
Raises:
:exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested
entities.
"""
return self._parse_markdown(self.caption, self.parse_caption_entities(), urled=False)
@ -2879,9 +2959,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message caption with the caption entities formatted as
Markdown in the same way the original message was formatted.
.. versionchanged:: 13.10
Spoiler entities are now formatted as Markdown V2.
Returns:
:obj:`str`: Message caption with caption entities formatted as Markdown.
"""
return self._parse_markdown(
self.caption, self.parse_caption_entities(), urled=False, version=2
@ -2902,6 +2984,10 @@ class Message(TelegramObject):
Returns:
:obj:`str`: Message caption with caption entities formatted as Markdown.
Raises:
:exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested
entities.
"""
return self._parse_markdown(self.caption, self.parse_caption_entities(), urled=True)
@ -2913,9 +2999,11 @@ class Message(TelegramObject):
Use this if you want to retrieve the message caption with the caption entities formatted as
Markdown. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink.
.. versionchanged:: 13.10
Spoiler entities are now formatted as Markdown V2.
Returns:
:obj:`str`: Message caption with caption entities formatted as Markdown.
"""
return self._parse_markdown(
self.caption, self.parse_caption_entities(), urled=True, version=2

14
telegram/messageentity.py
View file

@ -36,10 +36,11 @@ class MessageEntity(TelegramObject):
considered equal, if their :attr:`type`, :attr:`offset` and :attr:`length` are equal.
Args:
type (:obj:`str`): Type of the entity. Can be mention (@username), hashtag, bot_command,
url, email, phone_number, bold (bold text), italic (italic text), strikethrough,
code (monowidth string), pre (monowidth block), text_link (for clickable text URLs),
text_mention (for users without usernames).
type (:obj:`str`): Type of the entity. Currently, can be mention (@username), hashtag,
bot_command, url, email, phone_number, bold (bold text), italic (italic text),
strikethrough, spoiler (spoiler message), code (monowidth string), pre
(monowidth block), text_link (for clickable text URLs), text_mention
(for users without usernames).
offset (:obj:`int`): Offset in UTF-16 code units to the start of the entity.
length (:obj:`int`): Length of the entity in UTF-16 code units.
url (:obj:`str`, optional): For :attr:`TEXT_LINK` only, url that will be opened after
@ -124,6 +125,11 @@ class MessageEntity(TelegramObject):
""":const:`telegram.constants.MESSAGEENTITY_UNDERLINE`"""
STRIKETHROUGH: ClassVar[str] = constants.MESSAGEENTITY_STRIKETHROUGH
""":const:`telegram.constants.MESSAGEENTITY_STRIKETHROUGH`"""
SPOILER: ClassVar[str] = constants.MESSAGEENTITY_SPOILER
""":const:`telegram.constants.MESSAGEENTITY_SPOILER`
.. versionadded:: 13.10
"""
ALL_TYPES: ClassVar[List[str]] = constants.MESSAGEENTITY_ALL_TYPES
""":const:`telegram.constants.MESSAGEENTITY_ALL_TYPES`\n
List of all the types"""

38
telegram/user.py
View file

@ -338,6 +338,7 @@ class User(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -361,6 +362,7 @@ class User(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
entities=entities,
protect_content=protect_content,
)
def send_photo(
@ -376,6 +378,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -400,6 +403,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_media_group(
@ -412,6 +416,7 @@ class User(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> List['Message']:
"""Shortcut for::
@ -431,6 +436,7 @@ class User(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_audio(
@ -450,6 +456,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -478,6 +485,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_chat_action(
@ -519,6 +527,7 @@ class User(TelegramObject):
vcard: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -543,6 +552,7 @@ class User(TelegramObject):
vcard=vcard,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_dice(
@ -554,6 +564,7 @@ class User(TelegramObject):
emoji: str = None,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -574,6 +585,7 @@ class User(TelegramObject):
emoji=emoji,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_document(
@ -591,6 +603,7 @@ class User(TelegramObject):
disable_content_type_detection: bool = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -617,6 +630,7 @@ class User(TelegramObject):
disable_content_type_detection=disable_content_type_detection,
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
protect_content=protect_content,
)
def send_game(
@ -628,6 +642,7 @@ class User(TelegramObject):
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -648,6 +663,7 @@ class User(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_invoice(
@ -679,6 +695,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
max_tip_amount: int = None,
suggested_tip_amounts: List[int] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -727,6 +744,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
max_tip_amount=max_tip_amount,
suggested_tip_amounts=suggested_tip_amounts,
protect_content=protect_content,
)
def send_location(
@ -744,6 +762,7 @@ class User(TelegramObject):
heading: int = None,
proximity_alert_radius: int = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -770,6 +789,7 @@ class User(TelegramObject):
heading=heading,
proximity_alert_radius=proximity_alert_radius,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_animation(
@ -789,6 +809,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -817,6 +838,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_sticker(
@ -828,6 +850,7 @@ class User(TelegramObject):
timeout: DVInput[float] = DEFAULT_20,
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -848,6 +871,7 @@ class User(TelegramObject):
timeout=timeout,
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_video(
@ -868,6 +892,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -897,6 +922,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_venue(
@ -916,6 +942,7 @@ class User(TelegramObject):
google_place_id: str = None,
google_place_type: str = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -944,6 +971,7 @@ class User(TelegramObject):
google_place_id=google_place_id,
google_place_type=google_place_type,
allow_sending_without_reply=allow_sending_without_reply,
protect_content=protect_content,
)
def send_video_note(
@ -959,6 +987,7 @@ class User(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -983,6 +1012,7 @@ class User(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
filename=filename,
protect_content=protect_content,
)
def send_voice(
@ -999,6 +1029,7 @@ class User(TelegramObject):
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
filename: str = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1024,6 +1055,7 @@ class User(TelegramObject):
allow_sending_without_reply=allow_sending_without_reply,
caption_entities=caption_entities,
filename=filename,
protect_content=protect_content,
)
def send_poll(
@ -1047,6 +1079,7 @@ class User(TelegramObject):
api_kwargs: JSONDict = None,
allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE,
explanation_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
protect_content: bool = None,
) -> 'Message':
"""Shortcut for::
@ -1078,6 +1111,7 @@ class User(TelegramObject):
api_kwargs=api_kwargs,
allow_sending_without_reply=allow_sending_without_reply,
explanation_entities=explanation_entities,
protect_content=protect_content,
)
def send_copy(
@ -1093,6 +1127,7 @@ class User(TelegramObject):
reply_markup: 'ReplyMarkup' = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1117,6 +1152,7 @@ class User(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def copy_message(
@ -1132,6 +1168,7 @@ class User(TelegramObject):
reply_markup: 'ReplyMarkup' = None,
timeout: ODVInput[float] = DEFAULT_NONE,
api_kwargs: JSONDict = None,
protect_content: bool = None,
) -> 'MessageId':
"""Shortcut for::
@ -1156,6 +1193,7 @@ class User(TelegramObject):
reply_markup=reply_markup,
timeout=timeout,
api_kwargs=api_kwargs,
protect_content=protect_content,
)
def approve_join_request(

2
tests/test_animation.py
View file

@ -89,6 +89,7 @@ class TestAnimation:
caption=self.caption,
parse_mode='Markdown',
disable_notification=False,
protect_content=True,
thumb=thumb_file,
)
@ -102,6 +103,7 @@ class TestAnimation:
assert message.animation.file_size == animation.file_size
assert message.animation.thumb.width == self.width
assert message.animation.thumb.height == self.height
assert message.has_protected_content
@flaky(3, 1)
def test_send_animation_custom_filename(self, bot, chat_id, animation_file, monkeypatch):

2
tests/test_audio.py
View file

@ -95,6 +95,7 @@ class TestAudio:
performer=self.performer,
title=self.title,
disable_notification=False,
protect_content=True,
parse_mode='Markdown',
thumb=thumb_file,
)
@ -115,6 +116,7 @@ class TestAudio:
assert message.audio.thumb.file_size == self.thumb_file_size
assert message.audio.thumb.width == self.thumb_width
assert message.audio.thumb.height == self.thumb_height
assert message.has_protected_content
@flaky(3, 1)
def test_send_audio_custom_filename(self, bot, chat_id, audio_file, monkeypatch):

38
tests/test_bot.py
View file

@ -324,6 +324,20 @@ class TestBot:
assert forward_message.forward_from.username == message.from_user.username
assert isinstance(forward_message.forward_date, dtm.datetime)
def test_forward_protected_message(self, bot, message, chat_id):
to_forward_protected = bot.send_message(chat_id, 'cant forward me', protect_content=True)
assert to_forward_protected.has_protected_content
with pytest.raises(BadRequest, match="can't be forwarded"):
to_forward_protected.forward(chat_id)
to_forward_unprotected = bot.send_message(chat_id, 'forward me', protect_content=False)
assert not to_forward_unprotected.has_protected_content
forwarded_but_now_protected = to_forward_unprotected.forward(chat_id, protect_content=True)
assert forwarded_but_now_protected.has_protected_content
with pytest.raises(BadRequest, match="can't be forwarded"):
forwarded_but_now_protected.forward(chat_id)
@flaky(3, 1)
def test_delete_message(self, bot, chat_id):
message = bot.send_message(chat_id, text='will be deleted')
@ -360,6 +374,7 @@ class TestBot:
longitude=longitude,
foursquare_id=foursquare_id,
foursquare_type=foursquare_type,
protect_content=True,
)
assert message.venue
@ -371,6 +386,7 @@ class TestBot:
assert message.venue.foursquare_type == foursquare_type
assert message.venue.google_place_id is None
assert message.venue.google_place_type is None
assert message.has_protected_content
message = bot.send_venue(
chat_id=chat_id,
@ -380,6 +396,7 @@ class TestBot:
longitude=longitude,
google_place_id=google_place_id,
google_place_type=google_place_type,
protect_content=True,
)
assert message.venue
@ -391,6 +408,7 @@ class TestBot:
assert message.venue.google_place_type == google_place_type
assert message.venue.foursquare_id is None
assert message.venue.foursquare_type is None
assert message.has_protected_content
@flaky(3, 1)
@pytest.mark.xfail(raises=RetryAfter)
@ -402,13 +420,18 @@ class TestBot:
first_name = 'Leandro'
last_name = 'Toledo'
message = bot.send_contact(
chat_id=chat_id, phone_number=phone_number, first_name=first_name, last_name=last_name
chat_id=chat_id,
phone_number=phone_number,
first_name=first_name,
last_name=last_name,
protect_content=True,
)
assert message.contact
assert message.contact.phone_number == phone_number
assert message.contact.first_name == first_name
assert message.contact.last_name == last_name
assert message.has_protected_content
# TODO: Add bot to group to test polls too
@ -435,6 +458,7 @@ class TestBot:
is_anonymous=False,
allows_multiple_answers=True,
timeout=60,
protect_content=True,
)
assert message.poll
@ -446,6 +470,7 @@ class TestBot:
assert message.poll.allows_multiple_answers
assert not message.poll.is_closed
assert message.poll.type == Poll.REGULAR
assert message.has_protected_content
# Since only the poll and not the complete message is returned, we can't check that the
# reply_markup is correct. So we just test that sending doesn't give an error.
@ -664,9 +689,10 @@ class TestBot:
@flaky(3, 1)
@pytest.mark.parametrize('emoji', Dice.ALL_EMOJI + [None])
def test_send_dice(self, bot, chat_id, emoji):
message = bot.send_dice(chat_id, emoji=emoji)
message = bot.send_dice(chat_id, emoji=emoji, protect_content=True)
assert message.dice
assert message.has_protected_content
if emoji is None:
assert message.dice.emoji == Dice.DICE
else:
@ -1414,7 +1440,7 @@ class TestBot:
@flaky(3, 1)
def test_send_game(self, bot, chat_id):
game_short_name = 'test_game'
message = bot.send_game(chat_id, game_short_name)
message = bot.send_game(chat_id, game_short_name, protect_content=True)
assert message.game
assert message.game.description == (
@ -1424,6 +1450,7 @@ class TestBot:
# We added some test bots later and for some reason the file size is not the same for them
# so we accept three different sizes here. Shouldn't be too much of
assert message.game.photo[0].file_size in [851, 4928, 850]
assert message.has_protected_content
@flaky(3, 1)
@pytest.mark.parametrize(
@ -1980,11 +2007,12 @@ class TestBot:
@flaky(3, 1)
def test_send_message_entities(self, bot, chat_id):
test_string = 'Italic Bold Code'
test_string = 'Italic Bold Code Spoiler'
entities = [
MessageEntity(MessageEntity.ITALIC, 0, 6),
MessageEntity(MessageEntity.ITALIC, 7, 4),
MessageEntity(MessageEntity.ITALIC, 12, 4),
MessageEntity(MessageEntity.SPOILER, 17, 7),
]
message = bot.send_message(chat_id=chat_id, text=test_string, entities=entities)
assert message.text == test_string
@ -2150,6 +2178,7 @@ class TestBot:
assert data["reply_markup"] == keyboard.to_json()
assert data["disable_notification"] is True
assert data["caption_entities"] == [MessageEntity(MessageEntity.BOLD, 0, 4)]
assert data['protect_content'] is True
return data
monkeypatch.setattr(bot.request, 'post', post)
@ -2163,6 +2192,7 @@ class TestBot:
reply_to_message_id=media_message.message_id,
reply_markup=keyboard.to_json() if json_keyboard else keyboard,
disable_notification=True,
protect_content=True,
)
@flaky(3, 1)

2
tests/test_document.py
View file

@ -83,6 +83,7 @@ class TestDocument:
document=document_file,
caption=self.caption,
disable_notification=False,
protect_content=True,
filename='telegram_custom.png',
parse_mode='Markdown',
thumb=thumb_file,
@ -100,6 +101,7 @@ class TestDocument:
assert message.caption == self.caption.replace('*', '')
assert message.document.thumb.width == self.thumb_width
assert message.document.thumb.height == self.thumb_height
assert message.has_protected_content
@flaky(3, 1)
def test_get_and_download(self, bot, document):

7
tests/test_inputmedia.py
View file

@ -462,7 +462,11 @@ class TestSendMediaGroup:
def test_send_media_group_all_args(self, bot, chat_id, media_group):
m1 = bot.send_message(chat_id, text="test")
messages = bot.send_media_group(
chat_id, media_group, disable_notification=True, reply_to_message_id=m1.message_id
chat_id,
media_group,
disable_notification=True,
reply_to_message_id=m1.message_id,
protect_content=True,
)
assert isinstance(messages, list)
assert len(messages) == 3
@ -472,6 +476,7 @@ class TestSendMediaGroup:
assert all(
mes.caption_entities == [MessageEntity(MessageEntity.BOLD, 0, 5)] for mes in messages
)
assert all(mes.has_protected_content for mes in messages)
@flaky(3, 1)
def test_send_media_group_custom_filename(

5
tests/test_invoice.py
View file

@ -127,6 +127,8 @@ class TestInvoice:
send_phone_number_to_provider=True,
send_email_to_provider=True,
is_flexible=True,
disable_notification=True,
protect_content=True,
)
assert message.invoice.currency == self.currency
@ -134,6 +136,7 @@ class TestInvoice:
assert message.invoice.description == self.description
assert message.invoice.title == self.title
assert message.invoice.total_amount == self.total_amount
assert message.has_protected_content
# We do this next one as safety guard to make sure that we pass all of the optional
# parameters correctly because #2526 went unnoticed for 3 years …
@ -188,6 +191,8 @@ class TestInvoice:
send_phone_number_to_provider='send_phone_number_to_provider',
send_email_to_provider='send_email_to_provider',
is_flexible='is_flexible',
disable_notification=True,
protect_content=True,
)
def test_send_object_as_provider_data(self, monkeypatch, bot, chat_id, provider_token):

2
tests/test_location.py
View file

@ -80,6 +80,7 @@ class TestLocation:
horizontal_accuracy=50,
heading=90,
proximity_alert_radius=1000,
protect_content=True,
)
assert message.location
assert pytest.approx(52.223880, message.location.latitude)
@ -88,6 +89,7 @@ class TestLocation:
assert message.location.horizontal_accuracy == 50
assert message.location.heading == 90
assert message.location.proximity_alert_radius == 1000
assert message.has_protected_content
message2 = bot.edit_message_live_location(
message.chat_id,

88
tests/test_message.py
View file

@ -285,10 +285,11 @@ class TestMessage:
{'length': 29, 'offset': 91, 'type': 'bold'},
{'length': 9, 'offset': 101, 'type': 'strikethrough'},
{'length': 10, 'offset': 129, 'type': 'pre', 'language': 'python'},
{'length': 7, 'offset': 141, 'type': 'spoiler'},
]
test_text_v2 = (
r'Test for <bold, ita_lic, \`code, links, text-mention and `\pre. '
'http://google.com and bold nested in strk>trgh nested in italic. Python pre.'
'http://google.com and bold nested in strk>trgh nested in italic. Python pre. Spoiled.'
)
test_message = Message(
message_id=1,
@ -389,6 +390,7 @@ class TestMessage:
r'<pre>`\pre</pre>. http://google.com '
'and <i>bold <b>nested in <s>strk&gt;trgh</s> nested in</b> italic</i>. '
'<pre><code class="python">Python pre</code></pre>. '
'<span class="tg-spoiler">Spoiled</span>.'
)
text_html = self.test_message_v2.text_html
assert text_html == test_html_string
@ -407,6 +409,7 @@ class TestMessage:
r'<pre>`\pre</pre>. <a href="http://google.com">http://google.com</a> '
'and <i>bold <b>nested in <s>strk&gt;trgh</s> nested in</b> italic</i>. '
'<pre><code class="python">Python pre</code></pre>. '
'<span class="tg-spoiler">Spoiled</span>.'
)
text_html = self.test_message_v2.text_html_urled
assert text_html == test_html_string
@ -427,7 +430,7 @@ class TestMessage:
'[links](http://github.com/abc\\\\\\)def), '
'[text\\-mention](tg://user?id=123456789) and ```\\`\\\\pre```\\. '
r'http://google\.com and _bold *nested in ~strk\>trgh~ nested in* italic_\. '
'```python\nPython pre```\\.'
'```python\nPython pre```\\. ||Spoiled||\\.'
)
text_markdown = self.test_message_v2.text_markdown_v2
assert text_markdown == test_md_string
@ -449,6 +452,10 @@ class TestMessage:
with pytest.raises(ValueError):
message.text_markdown
message.entities = [MessageEntity(MessageEntity.SPOILER, offset=0, length=4)]
with pytest.raises(ValueError):
message.text_markdown
message.entities = []
def test_text_markdown_empty(self, message):
@ -473,7 +480,7 @@ class TestMessage:
'[links](http://github.com/abc\\\\\\)def), '
'[text\\-mention](tg://user?id=123456789) and ```\\`\\\\pre```\\. '
r'[http://google\.com](http://google.com) and _bold *nested in ~strk\>trgh~ '
'nested in* italic_\\. ```python\nPython pre```\\.'
'nested in* italic_\\. ```python\nPython pre```\\. ||Spoiled||\\.'
)
text_markdown = self.test_message_v2.text_markdown_v2_urled
assert text_markdown == test_md_string
@ -505,6 +512,7 @@ class TestMessage:
r'<pre>`\pre</pre>. http://google.com '
'and <i>bold <b>nested in <s>strk&gt;trgh</s> nested in</b> italic</i>. '
'<pre><code class="python">Python pre</code></pre>. '
'<span class="tg-spoiler">Spoiled</span>.'
)
caption_html = self.test_message_v2.caption_html
assert caption_html == test_html_string
@ -523,6 +531,7 @@ class TestMessage:
r'<pre>`\pre</pre>. <a href="http://google.com">http://google.com</a> '
'and <i>bold <b>nested in <s>strk&gt;trgh</s> nested in</b> italic</i>. '
'<pre><code class="python">Python pre</code></pre>. '
'<span class="tg-spoiler">Spoiled</span>.'
)
caption_html = self.test_message_v2.caption_html_urled
assert caption_html == test_html_string
@ -543,7 +552,7 @@ class TestMessage:
'[links](http://github.com/abc\\\\\\)def), '
'[text\\-mention](tg://user?id=123456789) and ```\\`\\\\pre```\\. '
r'http://google\.com and _bold *nested in ~strk\>trgh~ nested in* italic_\. '
'```python\nPython pre```\\.'
'```python\nPython pre```\\. ||Spoiled||\\.'
)
caption_markdown = self.test_message_v2.caption_markdown_v2
assert caption_markdown == test_md_string
@ -570,7 +579,7 @@ class TestMessage:
'[links](http://github.com/abc\\\\\\)def), '
'[text\\-mention](tg://user?id=123456789) and ```\\`\\\\pre```\\. '
r'[http://google\.com](http://google.com) and _bold *nested in ~strk\>trgh~ '
'nested in* italic_\\. ```python\nPython pre```\\.'
'nested in* italic_\\. ```python\nPython pre```\\. ||Spoiled||\\.'
)
caption_markdown = self.test_message_v2.caption_markdown_v2_urled
assert caption_markdown == test_md_string
@ -726,7 +735,7 @@ class TestMessage:
'[links](http://github.com/abc\\\\\\)def), '
'[text\\-mention](tg://user?id=123456789) and ```\\`\\\\pre```\\. '
r'http://google\.com and _bold *nested in ~strk\>trgh~ nested in* italic_\. '
'```python\nPython pre```\\.'
'```python\nPython pre```\\. ||Spoiled||\\.'
)
def make_assertion(*_, **kwargs):
@ -766,6 +775,7 @@ class TestMessage:
r'<pre>`\pre</pre>. http://google.com '
'and <i>bold <b>nested in <s>strk&gt;trgh</s> nested in</b> italic</i>. '
'<pre><code class="python">Python pre</code></pre>. '
'<span class="tg-spoiler">Spoiled</span>.'
)
def make_assertion(*_, **kwargs):
@ -1136,14 +1146,15 @@ class TestMessage:
quote=True,
)
@pytest.mark.parametrize('disable_notification', [False, True])
def test_forward(self, monkeypatch, message, disable_notification):
@pytest.mark.parametrize('disable_notification,protected', [(False, True), (True, False)])
def test_forward(self, monkeypatch, message, disable_notification, protected):
def make_assertion(*_, **kwargs):
chat_id = kwargs['chat_id'] == 123456
from_chat = kwargs['from_chat_id'] == message.chat_id
message_id = kwargs['message_id'] == message.message_id
notification = kwargs['disable_notification'] == disable_notification
return chat_id and from_chat and message_id and notification
protected_cont = kwargs['protect_content'] == protected
return chat_id and from_chat and message_id and notification and protected_cont
assert check_shortcut_signature(
Message.forward, Bot.forward_message, ['from_chat_id', 'message_id'], []
@ -1152,11 +1163,13 @@ class TestMessage:
assert check_defaults_handling(message.forward, message.bot)
monkeypatch.setattr(message.bot, 'forward_message', make_assertion)
assert message.forward(123456, disable_notification=disable_notification)
assert message.forward(
123456, disable_notification=disable_notification, protect_content=protected
)
assert not message.forward(635241)
@pytest.mark.parametrize('disable_notification', [True, False])
def test_copy(self, monkeypatch, message, disable_notification):
@pytest.mark.parametrize('disable_notification,protected', [(True, False), (False, True)])
def test_copy(self, monkeypatch, message, disable_notification, protected):
keyboard = [[1, 2]]
def make_assertion(*_, **kwargs):
@ -1164,11 +1177,19 @@ class TestMessage:
from_chat = kwargs['from_chat_id'] == message.chat_id
message_id = kwargs['message_id'] == message.message_id
notification = kwargs['disable_notification'] == disable_notification
protected_cont = kwargs['protect_content'] == protected
if kwargs.get('reply_markup') is not None:
reply_markup = kwargs['reply_markup'] is keyboard
else:
reply_markup = True
return chat_id and from_chat and message_id and notification and reply_markup
return (
chat_id
and from_chat
and message_id
and notification
and reply_markup
and protected_cont
)
assert check_shortcut_signature(
Message.copy, Bot.copy_message, ['from_chat_id', 'message_id'], []
@ -1177,14 +1198,19 @@ class TestMessage:
assert check_defaults_handling(message.copy, message.bot)
monkeypatch.setattr(message.bot, 'copy_message', make_assertion)
assert message.copy(123456, disable_notification=disable_notification)
assert message.copy(
123456, reply_markup=keyboard, disable_notification=disable_notification
123456, disable_notification=disable_notification, protect_content=protected
)
assert message.copy(
123456,
reply_markup=keyboard,
disable_notification=disable_notification,
protect_content=protected,
)
assert not message.copy(635241)
@pytest.mark.parametrize('disable_notification', [True, False])
def test_reply_copy(self, monkeypatch, message, disable_notification):
@pytest.mark.parametrize('disable_notification,protected', [(True, False), (False, True)])
def test_reply_copy(self, monkeypatch, message, disable_notification, protected):
keyboard = [[1, 2]]
def make_assertion(*_, **kwargs):
@ -1192,6 +1218,7 @@ class TestMessage:
from_chat = kwargs['chat_id'] == message.chat_id
message_id = kwargs['message_id'] == 456789
notification = kwargs['disable_notification'] == disable_notification
is_protected = kwargs['protect_content'] == protected
if kwargs.get('reply_markup') is not None:
reply_markup = kwargs['reply_markup'] is keyboard
else:
@ -1200,7 +1227,15 @@ class TestMessage:
reply = kwargs['reply_to_message_id'] == message.message_id
else:
reply = True
return chat_id and from_chat and message_id and notification and reply_markup and reply
return (
chat_id
and from_chat
and message_id
and notification
and reply_markup
and reply
and is_protected
)
assert check_shortcut_signature(
Message.reply_copy, Bot.copy_message, ['chat_id'], ['quote']
@ -1209,12 +1244,22 @@ class TestMessage:
assert check_defaults_handling(message.copy, message.bot)
monkeypatch.setattr(message.bot, 'copy_message', make_assertion)
assert message.reply_copy(123456, 456789, disable_notification=disable_notification)
assert message.reply_copy(
123456, 456789, reply_markup=keyboard, disable_notification=disable_notification
123456, 456789, disable_notification=disable_notification, protect_content=protected
)
assert message.reply_copy(
123456, 456789, quote=True, disable_notification=disable_notification
123456,
456789,
reply_markup=keyboard,
disable_notification=disable_notification,
protect_content=protected,
)
assert message.reply_copy(
123456,
456789,
quote=True,
disable_notification=disable_notification,
protect_content=protected,
)
assert message.reply_copy(
123456,
@ -1222,6 +1267,7 @@ class TestMessage:
quote=True,
reply_to_message_id=message.message_id,
disable_notification=disable_notification,
protect_content=protected,
)
def test_edit_text(self, monkeypatch, message):

4
tests/test_messageentity.py
View file

@ -31,9 +31,9 @@ def message_entity(request):
if type_ == MessageEntity.TEXT_MENTION:
user = User(1, 'test_user', False)
language = None
if type == MessageEntity.PRE:
if type_ == MessageEntity.PRE:
language = "python"
return MessageEntity(type, 1, 3, url=url, user=user, language=language)
return MessageEntity(type_, 1, 3, url=url, user=user, language=language)
class TestMessageEntity:

2
tests/test_photo.py
View file

@ -103,6 +103,7 @@ class TestPhoto:
photo_file,
caption=self.caption,
disable_notification=False,
protect_content=True,
parse_mode='Markdown',
)
@ -125,6 +126,7 @@ class TestPhoto:
assert message.photo[1].file_size == photo.file_size
assert message.caption == TestPhoto.caption.replace('*', '')
assert message.has_protected_content
@flaky(3, 1)
def test_send_photo_custom_filename(self, bot, chat_id, photo_file, monkeypatch):

5
tests/test_sticker.py
View file

@ -106,7 +106,9 @@ class TestSticker:
@flaky(3, 1)
def test_send_all_args(self, bot, chat_id, sticker_file, sticker):
message = bot.send_sticker(chat_id, sticker=sticker_file, disable_notification=False)
message = bot.send_sticker(
chat_id, sticker=sticker_file, disable_notification=False, protect_content=True
)
assert isinstance(message.sticker, Sticker)
assert isinstance(message.sticker.file_id, str)
@ -126,6 +128,7 @@ class TestSticker:
assert message.sticker.thumb.width == sticker.thumb.width
assert message.sticker.thumb.height == sticker.thumb.height
assert message.sticker.thumb.file_size == sticker.thumb.file_size
assert message.has_protected_content
@flaky(3, 1)
def test_get_and_download(self, bot, sticker):

2
tests/test_video.py
View file

@ -98,6 +98,7 @@ class TestVideo:
caption=self.caption,
supports_streaming=self.supports_streaming,
disable_notification=False,
protect_content=True,
width=video.width,
height=video.height,
parse_mode='Markdown',
@ -121,6 +122,7 @@ class TestVideo:
assert message.video.thumb.height == self.thumb_height
assert message.video.file_name == self.file_name
assert message.has_protected_content
@flaky(3, 1)
def test_send_video_custom_filename(self, bot, chat_id, video_file, monkeypatch):

2
tests/test_videonote.py
View file

@ -88,6 +88,7 @@ class TestVideoNote:
duration=self.duration,
length=self.length,
disable_notification=False,
protect_content=True,
thumb=thumb_file,
)
@ -103,6 +104,7 @@ class TestVideoNote:
assert message.video_note.thumb.file_size == self.thumb_file_size
assert message.video_note.thumb.width == self.thumb_width
assert message.video_note.thumb.height == self.thumb_height
assert message.has_protected_content
@flaky(3, 1)
def test_send_video_note_custom_filename(self, bot, chat_id, video_note_file, monkeypatch):

2
tests/test_voice.py
View file

@ -81,6 +81,7 @@ class TestVoice:
duration=self.duration,
caption=self.caption,
disable_notification=False,
protect_content=True,
parse_mode='Markdown',
)
@ -93,6 +94,7 @@ class TestVoice:
assert message.voice.mime_type == voice.mime_type
assert message.voice.file_size == voice.file_size
assert message.caption == self.caption.replace('*', '')
assert message.has_protected_content
@flaky(3, 1)
def test_send_voice_custom_filename(self, bot, chat_id, voice_file, monkeypatch):