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 2024-10-23 17:36:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Bump Version to v20.8

Browse source
This commit is contained in:
Hinrich Mahler 2024-02-08 18:36:28 +01:00
parent 04d86deb58
commit 680dc2b6b8
41 changed files with 432 additions and 363 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
CHANGES.rst
View file

@ -4,6 +4,75 @@
Changelog
=========
Version 20.8
============
*Released 2024-02-08*
This is the technical changelog for version 20.8. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`__.
Major Changes
-------------
- API 7.0 (:pr:`4034` closes :issue:`4033`, :pr:`4038` by `@aelkheir <https://github.com/aelkheir>`__)
Minor Changes
-------------
- Fix Type Hint for ``filters`` Parameter of ``MessageHandler`` (:pr:`4039` by `@Palaptin <https://github.com/Palaptin>`__)
- Deprecate ``filters.CHAT`` (:pr:`4083` closes :issue:`4062`)
- Improve Error Handling in Built-In Webhook Handler (:pr:`3987` closes :issue:`3979`)
New Features
------------
- Add Parameter ``pattern`` to ``PreCheckoutQueryHandler`` and ``filters.SuccessfulPayment`` (:pr:`4005` by `@aelkheir <https://github.com/aelkheir>`__ closes :issue:`3752`)
- Add Missing Conversions of ``type`` to Corresponding Enum from ``telegram.constants`` (:pr:`4067`)
- Add Support for Unix Sockets to ``Updater.start_webhook`` (:pr:`3986` closes :issue:`3978`)
- Add ``Bot.do_api_request`` (:pr:`4084` closes :issue:`4053`)
- Add ``AsyncContextManager`` as Parent Class to ``BaseUpdateProcessor`` (:pr:`4001`)
Documentation Improvements
--------------------------
- Documentation Improvements (:pr:`3919`)
- Add Docstring to Dunder Methods (:pr:`3929` closes :issue:`3926`)
- Documentation Improvements (:pr:`4002`, :pr:`4079` by `@kenjitagawa <https://github.com/kenjitagawa>`__, :pr:`4104` by `@xTudoS <https://github.com/xTudoS>`__)
Internal Changes
----------------
- Drop Usage of DeepSource (:pr:`4100`)
- Improve Type Completeness & Corresponding Workflow (:pr:`4035`)
- Bump ``ruff`` and Remove ``sort-all`` (:pr:`4075`)
- Move Handler Files to ``_handlers`` Subdirectory (:pr:`4064` by `@lucasmolinari <https://github.com/lucasmolinari>`__ closes :issue:`4060`)
- Introduce ``sort-all`` Hook for ``pre-commit`` (:pr:`4052`)
- Use Recommended ``pre-commit`` Mirror for ``black`` (:pr:`4051`)
- Remove Unused ``DEFAULT_20`` (:pr:`3997`)
- Migrate From ``setup.cfg`` to ``pyproject.toml`` Where Possible (:pr:`4088`)
Dependency Updates
------------------
- Bump ``black`` and ``ruff`` (:pr:`4089`)
- Bump ``srvaroa/labeler`` from 1.8.0 to 1.10.0 (:pr:`4048`)
- Update ``tornado`` requirement from ~=6.3.3 to ~=6.4 (:pr:`3992`)
- Bump ``actions/stale`` from 8 to 9 (:pr:`4046`)
- Bump ``actions/setup-python`` from 4 to 5 (:pr:`4047`)
- ``pre-commit`` autoupdate (:pr:`4101`)
- Bump ``actions/upload-artifact`` from 3 to 4 (:pr:`4045`)
- ``pre-commit`` autoupdate (:pr:`3996`)
- Bump ``furo`` from 2023.9.10 to 2024.1.29 (:pr:`4094`)
- ``pre-commit`` autoupdate (:pr:`4043`)
- Bump ``codecov/codecov-action`` from 3 to 4 (:pr:`4091`)
- Bump ``EndBug/add-and-commit`` from 9.1.3 to 9.1.4 (:pr:`4090`)
- Update ``httpx`` requirement from ~=0.25.2 to ~=0.26.0 (:pr:`4024`)
- Bump ``pytest`` from 7.4.3 to 7.4.4 (:pr:`4056`)
- Bump ``srvaroa/labeler`` from 1.7.0 to 1.8.0 (:pr:`3993`)
- Bump ``test-summary/action`` from 2.1 to 2.2 (:pr:`4044`)
- Bump ``dessant/lock-threads`` from 4.0.1 to 5.0.1 (:pr:`3994`)
Version 20.7
============

4
docs/source/conf.py
View file

@ -21,9 +21,9 @@ author = "Leandro Toledo"
# built documents.
#
# The short X.Y version.
version = "20.7" # telegram.__version__[:3]
version = "20.8" # telegram.__version__[:3]
# The full version, including alpha/beta/rc tags.
release = "20.7" # telegram.__version__
release = "20.8" # telegram.__version__
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = "6.1.3"

2
docs/source/telegram.chatboost.rst
View file

@ -1,7 +1,7 @@
ChatBoost
=========
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoost
:members:

2
docs/source/telegram.chatboostremoved.rst
View file

@ -1,7 +1,7 @@
ChatBoostRemoved
================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostRemoved
:members:

2
docs/source/telegram.chatboostsource.rst
View file

@ -1,7 +1,7 @@
ChatBoostSource
===============
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostSource
:members:

2
docs/source/telegram.chatboostsourcegiftcode.rst
View file

@ -1,7 +1,7 @@
ChatBoostSourceGiftCode
=======================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostSourceGiftCode
:members:

2
docs/source/telegram.chatboostsourcegiveaway.rst
View file

@ -1,7 +1,7 @@
ChatBoostSourceGiveaway
=======================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostSourceGiveaway
:members:

2
docs/source/telegram.chatboostsourcepremium.rst
View file

@ -1,7 +1,7 @@
ChatBoostSourcePremium
======================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostSourcePremium
:members:

2
docs/source/telegram.chatboostupdated.rst
View file

@ -1,7 +1,7 @@
ChatBoostUpdated
================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ChatBoostUpdated
:members:

2
docs/source/telegram.ext.chatboosthandler.rst
View file

@ -1,7 +1,7 @@
ChatBoostHandler
================
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.ext.ChatBoostHandler
:members:

2
docs/source/telegram.userchatboosts.rst
View file

@ -1,7 +1,7 @@
UserChatBoosts
==============
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. autoclass:: telegram.UserChatBoosts
:members:

204
telegram/_bot.py
View file

@ -818,7 +818,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
* The only exception is :class:`telegram.ext.Defaults.tzinfo`, which will be correctly
applied to :class:`datetime.datetime` objects.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
endpoint (:obj:`str`): The API endpoint to use, e.g. ``getMe`` or ``get_me``.
@ -955,17 +955,17 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
options for the message. Mutually exclusive with
:paramref:`disable_web_page_preview`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in
this message. Mutually exclusive with :paramref:`link_preview_options`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`link_preview_options` replacing this
argument. PTB will automatically convert this argument to that one, but
for advanced options, please use :paramref:`link_preview_options` directly.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
In future versions, this argument will become a keyword-only argument.
disable_notification (:obj:`bool`, optional): |disable_notification|
@ -975,19 +975,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -999,7 +999,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.0
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent message is returned.
@ -1109,7 +1109,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
Use this method to delete multiple messages simultaneously. If some of the specified
messages can't be found, they are skipped.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|
@ -1222,7 +1222,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
found or forwarded, they are skipped. Service messages and messages with protected content
can't be forwarded. Album grouping is kept for forwarded messages.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|
@ -1329,19 +1329,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -1354,7 +1354,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.0
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the photo, when uploading a
@ -1473,19 +1473,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -1498,7 +1498,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.2
reply_parameters (:obj:`ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the audio, when uploading a
@ -1617,19 +1617,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -1642,7 +1642,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.2
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the document, when uploading a
@ -1737,19 +1737,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -1758,7 +1758,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent Message is returned.
@ -1873,19 +1873,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -1902,7 +1902,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.2
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the video, when uploading a
@ -2015,19 +2015,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -2040,7 +2040,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.2
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the video note, when uploading a
@ -2158,19 +2158,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -2187,7 +2187,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.2
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the animation, when uploading a
@ -2306,19 +2306,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -2327,7 +2327,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
filename (:obj:`str`, optional): Custom file name for the voice, when uploading a
@ -2426,24 +2426,24 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
caption (:obj:`str`, optional): Caption that will be added to the
@ -2593,19 +2593,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -2614,7 +2614,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
location (:class:`telegram.Location`, optional): The location to send.
@ -2871,19 +2871,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -2892,7 +2892,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
venue (:class:`telegram.Venue`, optional): The venue to send.
@ -3003,19 +3003,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -3024,7 +3024,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Keyword Args:
contact (:class:`telegram.Contact`, optional): The contact to send.
@ -3113,19 +3113,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
.. versionadded:: 20.0
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new
@ -3133,7 +3133,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
shown. If not empty, the first button must launch the game.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent Message is returned.
@ -3827,17 +3827,17 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
options for the message. Mutually exclusive with
:paramref:`disable_web_page_preview`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in
this message. Mutually exclusive with :paramref:`link_preview_options`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`link_preview_options` replacing this
argument. PTB will automatically convert this argument to that one, but
for advanced options, please use :paramref:`link_preview_options` directly.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
In future versions, this argument will become keyword only.
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
@ -4887,19 +4887,19 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
@ -4907,7 +4907,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
shown. If not empty, the first button must be a Pay button.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent Message is returned.
@ -6872,19 +6872,19 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
.. versionadded:: 20.0
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -6893,7 +6893,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent Message is returned.
@ -7009,10 +7009,10 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -7037,10 +7037,10 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
protect_content (:obj:`bool`, optional): |protect_content|
@ -7051,7 +7051,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
.. versionadded:: 20.0
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, the sent Message is returned.
@ -7452,19 +7452,19 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
|keyword_only_arg|
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
@ -7473,7 +7473,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
keyboard, instructions to remove reply keyboard or to force a reply from the user.
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.MessageId`: On success
@ -7548,7 +7548,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
:meth:`forward_messages`, but the copied messages don't have a link to the original
message. Album grouping is kept for copied messages.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|
@ -8654,7 +8654,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
Use this method to get the list of boosts added to a chat by a user. Requires
administrator rights in the chat.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|
@ -8700,7 +8700,7 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
reacted to. Automatically forwarded messages from a channel to its discussion group have
the same available reactions as messages in the channel.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|

28
telegram/_callbackquery.py
View file

@ -75,7 +75,7 @@ class CallbackQuery(TelegramObject):
message (:class:`telegram.MaybeInaccessibleMessage`, optional): Message sent by the bot
with the callback button that originated the query.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Accept objects of type :class:`telegram.MaybeInaccessibleMessage` since Bot API 7.0.
data (:obj:`str`, optional): Data associated with the callback button. Be aware that the
message, which originated the query, can contain no callback buttons with this data.
@ -92,7 +92,7 @@ class CallbackQuery(TelegramObject):
message (:class:`telegram.MaybeInaccessibleMessage`): Optional. Message sent by the bot
with the callback button that originated the query.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Objects maybe be of type :class:`telegram.MaybeInaccessibleMessage` since Bot API
7.0.
data (:obj:`str` | :obj:`object`): Optional. Data associated with the callback button.
@ -233,7 +233,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.edit_message_text` and :meth:`telegram.Message.edit_text`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -301,7 +301,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.edit_message_caption` and :meth:`telegram.Message.edit_caption`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -363,7 +363,7 @@ class CallbackQuery(TelegramObject):
:meth:`telegram.Bot.edit_message_reply_markup` and
:meth:`telegram.Message.edit_reply_markup`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -419,7 +419,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.edit_message_media` and :meth:`telegram.Message.edit_media`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -483,7 +483,7 @@ class CallbackQuery(TelegramObject):
:meth:`telegram.Bot.edit_message_live_location` and
:meth:`telegram.Message.edit_live_location`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -551,7 +551,7 @@ class CallbackQuery(TelegramObject):
:meth:`telegram.Bot.stop_message_live_location` and
:meth:`telegram.Message.stop_live_location`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -609,7 +609,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.set_game_score` and :meth:`telegram.Message.set_game_score`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -671,7 +671,7 @@ class CallbackQuery(TelegramObject):
:meth:`telegram.Bot.get_game_high_scores` and
:meth:`telegram.Message.get_game_high_scores`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -717,7 +717,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Message.delete`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -751,7 +751,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Message.pin`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -784,7 +784,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Message.unpin`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:
@ -832,7 +832,7 @@ class CallbackQuery(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Message.copy`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Raises :exc:`TypeError` if :attr:`message` is not accessible.
Returns:

40
telegram/_chat.py
View file

@ -134,7 +134,7 @@ class Chat(TelegramObject):
access to old messages; available only to chat administrators. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
sticker_set_name (:obj:`str`, optional): For supergroups, name of group sticker set.
Returned only in :meth:`telegram.Bot.get_chat`.
can_set_sticker_set (:obj:`bool`, optional): :obj:`True`, if the bot can change group the
@ -174,30 +174,30 @@ class Chat(TelegramObject):
:const:`telegram.constants.ReactionEmoji` are allowed. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
accent_color_id (:obj:`int`, optional): Identifier of the
:class:`accent color <telegram.constants.AccentColor>` for the chat name and
backgrounds of the chat photo, reply header, and link preview. See `accent colors`_
for more details. Returned only in :meth:`telegram.Bot.get_chat`. Always returned in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
background_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of emoji chosen
by the chat for the reply header and link preview background. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
profile_accent_color_id (:obj:`int`, optional): Identifier of the
:class:`accent color <telegram.constants.ProfileAccentColor>` for the chat's profile
background. See profile `accent colors`_ for more details. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
profile_background_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of
the emoji chosen by the chat for its profile background. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
emoji_status_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of emoji
status of the chat or the other party in a private chat. Returned only in
:meth:`telegram.Bot.get_chat`.
@ -265,7 +265,7 @@ class Chat(TelegramObject):
access to old messages; available only to chat administrators. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
sticker_set_name (:obj:`str`): Optional. For supergroups, name of Group sticker set.
Returned only in :meth:`telegram.Bot.get_chat`.
can_set_sticker_set (:obj:`bool`): Optional. :obj:`True`, if the bot can change group the
@ -307,30 +307,30 @@ class Chat(TelegramObject):
:const:`telegram.constants.ReactionEmoji` are allowed. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
accent_color_id (:obj:`int`): Optional. Identifier of the
:class:`accent color <telegram.constants.AccentColor>` for the chat name and
backgrounds of the chat photo, reply header, and link preview. See `accent colors`_
for more details. Returned only in :meth:`telegram.Bot.get_chat`. Always returned in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
background_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of emoji chosen
by the chat for the reply header and link preview background. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
profile_accent_color_id (:obj:`int`): Optional. Identifier of the
:class:`accent color <telegram.constants.ProfileAccentColor>` for the chat's profile
background. See profile `accent colors`_ for more details. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
profile_background_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of
the emoji chosen by the chat for its profile background. Returned only in
:meth:`telegram.Bot.get_chat`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
emoji_status_custom_emoji_id (:obj:`str`): Optional. Custom emoji identifier of emoji
status of the chat or the other party in a private chat. Returned only in
:meth:`telegram.Bot.get_chat`.
@ -1475,7 +1475,7 @@ class Chat(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Bot.delete_message`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool`: On success, :obj:`True` is returned.
@ -1507,7 +1507,7 @@ class Chat(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Bot.delete_messages`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool`: On success, :obj:`True` is returned.
@ -2604,7 +2604,7 @@ class Chat(TelegramObject):
.. seealso:: :meth:`copy_message`, :meth:`send_copy`, :meth:`copy_messages`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -2649,7 +2649,7 @@ class Chat(TelegramObject):
.. seealso:: :meth:`copy_message`, :meth:`send_copy`, :meth:`send_copies`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -2778,7 +2778,7 @@ class Chat(TelegramObject):
.. seealso:: :meth:`forward_to`, :meth:`forward_from`, :meth:`forward_messages_to`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -2821,7 +2821,7 @@ class Chat(TelegramObject):
.. seealso:: :meth:`forward_from`, :meth:`forward_to`, :meth:`forward_messages_from`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -3538,7 +3538,7 @@ class Chat(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.get_user_chat_boosts`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.UserChatBoosts`: On success, returns the boosts applied in the chat.
@ -3572,7 +3572,7 @@ class Chat(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.set_message_reaction`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool` On success, :obj:`True` is returned.

14
telegram/_chatboost.py
View file

@ -45,7 +45,7 @@ class ChatBoostSource(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`source` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
source (:obj:`str`): The source of the chat boost. Can be one of:
@ -104,7 +104,7 @@ class ChatBoostSourcePremium(ChatBoostSource):
The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium
subscription to another user.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
user (:class:`telegram.User`): User that boosted the chat.
@ -130,7 +130,7 @@ class ChatBoostSourceGiftCode(ChatBoostSource):
such code boosts the chat 4 times for the duration of the corresponding Telegram Premium
subscription.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
user (:class:`telegram.User`): User for which the gift code was created.
@ -155,7 +155,7 @@ class ChatBoostSourceGiveaway(ChatBoostSource):
The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4
times for the duration of the corresponding Telegram Premium subscription.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
giveaway_message_id (:obj:`int`): Identifier of a message in the chat with the giveaway;
@ -200,7 +200,7 @@ class ChatBoost(TelegramObject):
considered equal, if their :attr:`boost_id`, :attr:`add_date`, :attr:`expiration_date`,
and :attr:`source` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
boost_id (:obj:`str`): Unique identifier of the boost.
@ -263,7 +263,7 @@ class ChatBoostUpdated(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`chat`, and :attr:`boost` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat (:class:`telegram.Chat`): Chat which was boosted.
@ -370,7 +370,7 @@ class UserChatBoosts(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`boosts` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
boosts (Sequence[:class:`telegram.ChatBoost`]): List of boosts added to the chat by the

6
telegram/_giveaway.py
View file

@ -38,7 +38,7 @@ class Giveaway(TelegramObject):
considered equal, if their :attr:`chats`, :attr:`winners_selection_date` and
:attr:`winner_count` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chats (Tuple[:class:`telegram.Chat`]): The list of chats which the user must join to
@ -161,7 +161,7 @@ class GiveawayWinners(TelegramObject):
considered equal, if their :attr:`chat`, :attr:`giveaway_message_id`,
:attr:`winners_selection_date`, :attr:`winner_count` and :attr:`winners` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat (:class:`telegram.Chat`): The chat that created the giveaway
@ -283,7 +283,7 @@ class GiveawayCompleted(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`winner_count` and :attr:`unclaimed_prize_count` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:

10
telegram/_inline/inputtextmessagecontent.py
View file

@ -57,19 +57,19 @@ class InputTextMessageContent(InputMessageContent):
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in the
sent message. Mutually exclusive with :paramref:`link_preview_options`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`link_preview_options` replacing this
argument. PTB will automatically convert this argument to that one, but
for advanced options, please use :paramref:`link_preview_options` directly.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
In future versions, this argument will become keyword only.
link_preview_options (:obj:`LinkPreviewOptions`, optional): Link preview generation
options for the message. Mutually exclusive with
:paramref:`disable_web_page_preview`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Attributes:
message_text (:obj:`str`): Text of the message to be sent,
@ -87,7 +87,7 @@ class InputTextMessageContent(InputMessageContent):
options for the message. Mutually exclusive with
:attr:`disable_web_page_preview`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
@ -121,7 +121,7 @@ class InputTextMessageContent(InputMessageContent):
def disable_web_page_preview(self) -> Optional[bool]:
"""Optional[:obj:`bool`]: Disables link previews for links in the sent message.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
"""
warn_about_deprecated_attr_in_property(
deprecated_attr_name="disable_web_page_preview",

8
telegram/_keyboardbutton.py
View file

@ -88,7 +88,7 @@ class KeyboardButton(TelegramObject):
:attr:`request_users`.
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates this argument in favor of ref`request_users`.
request_users (:class:`KeyboardButtonRequestUsers`, optional): If specified, pressing the
@ -96,7 +96,7 @@ class KeyboardButton(TelegramObject):
identifier to the bot in a :attr:`telegram.Message.user_shared` service message.
Available in private chats only.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
request_chat (:class:`KeyboardButtonRequestChat`, optional): If specified, pressing the
button will open a list of suitable chats. Tapping on a chat will send its
identifier to the bot in a :attr:`telegram.Message.chat_shared` service message.
@ -124,7 +124,7 @@ class KeyboardButton(TelegramObject):
identifier to the bot in a :attr:`telegram.Message.user_shared` service message.
Available in private chats only.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
request_chat (:class:`KeyboardButtonRequestChat`): Optional. If specified, pressing the
button will open a list of suitable chats. Tapping on a chat will send its
identifier to the bot in a :attr:`telegram.Message.chat_shared` service message.
@ -195,7 +195,7 @@ class KeyboardButton(TelegramObject):
"""Optional[:class:`KeyboardButtonRequestUsers`]: Alias for :attr:`request_users`.
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates this attribute in favor of :attr:`request_users`.
"""
warn_about_deprecated_attr_in_property(

8
telegram/_keyboardbuttonrequest.py
View file

@ -41,7 +41,7 @@ class KeyboardButtonRequestUsers(TelegramObject):
`Telegram Docs on requesting users \
<https://core.telegram.org/bots/features#chat-and-user-selection>`_
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
This class was previously named :class:`KeyboardButtonRequestUser`.
Args:
@ -58,7 +58,7 @@ class KeyboardButtonRequestUsers(TelegramObject):
Defaults to :tg-const:`telegram.constants.KeyboardButtonRequestUsersLimit.MIN_QUANTITY`
.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Attributes:
request_id (:obj:`int`): Identifier of the request.
@ -73,7 +73,7 @@ class KeyboardButtonRequestUsers(TelegramObject):
Defaults to :tg-const:`telegram.constants.KeyboardButtonRequestUsersLimit.MIN_QUANTITY`
.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = (
@ -111,7 +111,7 @@ class KeyboardButtonRequestUser(KeyboardButtonRequestUsers):
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :class:`KeyboardButtonRequestUsers` instead.
"""

2
telegram/_linkpreviewoptions.py
View file

@ -34,7 +34,7 @@ class LinkPreviewOptions(TelegramObject):
considered equal, if their :attr:`is_disabled`, :attr:`url`, :attr:`prefer_small_media`,
:attr:`prefer_large_media`, and :attr:`show_above_text` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
is_disabled (:obj:`bool`, optional): :obj:`True`, if the link preview is disabled.

194
telegram/_message.py
View file

@ -124,7 +124,7 @@ class MaybeInaccessibleMessage(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`message_id` and :attr:`chat` are equal
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
message_id (:obj:`int`): Unique message identifier.
@ -186,8 +186,8 @@ class MaybeInaccessibleMessage(TelegramObject):
not affected by this change, :meth:`Message.__bool__` is not overridden and will
continue to work as before.
.. versionadded:: NEXT.VERSION
.. deprecated:: NEXT.VERSION
.. versionadded:: 20.8
.. deprecated:: 20.8
This behavior is introduced only temporarily to ease migration to Bot API 7.0. It will
be removed along with other functionality deprecated by Bot API 7.0.
"""
@ -211,7 +211,7 @@ class MaybeInaccessibleMessage(TelegramObject):
def is_accessible(self) -> bool:
"""Convenience attribute. :obj:`True`, if the date is not 0 in Unix time.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
# Once we drop support for python 3.9, this can be made a TypeGuard function:
# def is_accessible(self) -> TypeGuard[Message]:
@ -251,7 +251,7 @@ class InaccessibleMessage(MaybeInaccessibleMessage):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`message_id` and :attr:`chat` are equal
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
message_id (:obj:`int`): Unique message identifier.
@ -287,7 +287,7 @@ class Message(MaybeInaccessibleMessage):
Note:
In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
* This class is now a subclass of :class:`telegram.MaybeInaccessibleMessage`.
* The :paramref:`pinned_message` now can be either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
@ -326,25 +326,25 @@ class Message(MaybeInaccessibleMessage):
forward_from (:class:`telegram.User`, optional): For forwarded messages, sender of
the original message.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_from` in favor of
:paramref:`forward_origin`.
forward_from_chat (:class:`telegram.Chat`, optional): For messages forwarded from channels
or from anonymous administrators, information about the original sender chat.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_from_chat` in favor of
:paramref:`forward_origin`.
forward_from_message_id (:obj:`int`, optional): For forwarded channel posts, identifier of
the original message in the channel.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_from_message_id` in favor of
:paramref:`forward_origin`.
forward_sender_name (:obj:`str`, optional): Sender's name for messages forwarded from
users who disallow adding a link to their account in forwarded messages.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_sender_name` in favor of
:paramref:`forward_origin`.
forward_date (:class:`datetime.datetime`, optional): For forwarded messages, date the
@ -353,7 +353,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
|datetime_localization|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_date` in favor of
:paramref:`forward_origin`.
is_automatic_forward (:obj:`bool`, optional): :obj:`True`, if the message is a channel
@ -388,7 +388,7 @@ class Message(MaybeInaccessibleMessage):
link preview generation for the message, if it is a text message and link preview
options were changed.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): For messages with a
Caption. Special entities like usernames, URLs, bot commands, etc. that appear in the
@ -472,7 +472,7 @@ class Message(MaybeInaccessibleMessage):
was pinned. Note that the Message object in this field will not contain further
:attr:`reply_to_message` fields even if it is itself a reply.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
This attribute now is either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
invoice (:class:`telegram.Invoice`, optional): Message is an invoice for a payment,
@ -484,7 +484,7 @@ class Message(MaybeInaccessibleMessage):
forward_signature (:obj:`str`, optional): For messages forwarded from channels, signature
of the post author if present.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`forward_signature` in favor of
:paramref:`forward_origin`.
author_signature (:obj:`str`, optional): Signature of the post author for messages in
@ -567,12 +567,12 @@ class Message(MaybeInaccessibleMessage):
with the bot.
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :paramref:`user_shared` in favor of :paramref:`users_shared`.
users_shared (:class:`telegram.UsersShared`, optional): Service message: users were shared
with the bot
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
chat_shared (:class:`telegram.ChatShared`, optional):Service message: a chat was shared
with the bot.
@ -580,31 +580,31 @@ class Message(MaybeInaccessibleMessage):
giveaway_created (:class:`telegram.GiveawayCreated`, optional): Service message: a
scheduled giveaway was created
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway (:class:`telegram.Giveaway`, optional): The message is a scheduled giveaway
message
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway_winners (:class:`telegram.GiveawayWinners`, optional): A giveaway with public
winners was completed
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway_completed (:class:`telegram.GiveawayCompleted`, optional): Service message: a
giveaway without public winners was completed
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
external_reply (:class:`telegram.ExternalReplyInfo`, optional): Information about the
message that is being replied to, which may come from another chat or forum topic.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
quote (:class:`telegram.TextQuote`, optional): For replies that quote part of the original
message, the quoted part of the message.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
forward_origin (:class:`telegram.MessageOrigin`, optional): Information about the original
message for forwarded messages
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Attributes:
message_id (:obj:`int`): Unique message identifier inside this chat.
@ -655,7 +655,7 @@ class Message(MaybeInaccessibleMessage):
link preview generation for the message, if it is a text message and link preview
options were changed.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. For messages with a
Caption. Special entities like usernames, URLs, bot commands, etc. that appear in the
@ -754,7 +754,7 @@ class Message(MaybeInaccessibleMessage):
was pinned. Note that the Message object in this field will not contain further
:attr:`reply_to_message` fields even if it is itself a reply.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
This attribute now is either class:`telegram.Message` or
class:`telegram.InaccessibleMessage`.
invoice (:class:`telegram.Invoice`): Optional. Message is an invoice for a payment,
@ -842,7 +842,7 @@ class Message(MaybeInaccessibleMessage):
users_shared (:class:`telegram.UsersShared`): Optional. Service message: users were shared
with the bot
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
chat_shared (:class:`telegram.ChatShared`): Optional. Service message: a chat was shared
with the bot.
@ -850,31 +850,31 @@ class Message(MaybeInaccessibleMessage):
giveaway_created (:class:`telegram.GiveawayCreated`): Optional. Service message: a
scheduled giveaway was created
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway (:class:`telegram.Giveaway`): Optional. The message is a scheduled giveaway
message
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway_winners (:class:`telegram.GiveawayWinners`): Optional. A giveaway with public
winners was completed
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
giveaway_completed (:class:`telegram.GiveawayCompleted`): Optional. Service message: a
giveaway without public winners was completed
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
external_reply (:class:`telegram.ExternalReplyInfo`): Optional. Information about the
message that is being replied to, which may come from another chat or forum topic.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
quote (:class:`telegram.TextQuote`): Optional. For replies that quote part of the original
message, the quoted part of the message.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
forward_origin (:class:`telegram.MessageOrigin`, optional): Information about the original
message for forwarded messages
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. |custom_emoji_no_md1_support| replace:: Since custom emoji entities are not supported by
:attr:`~telegram.constants.ParseMode.MARKDOWN`, this method now raises a
@ -1220,7 +1220,7 @@ class Message(MaybeInaccessibleMessage):
be present. However, this behavior is not documented and may be changed by Telegram.
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`user_shared` in favor of :attr:`users_shared`.
"""
warn_about_deprecated_attr_in_property(
@ -1235,7 +1235,7 @@ class Message(MaybeInaccessibleMessage):
""":class:`telegram.User`: Optional. For forwarded messages, sender of the original
message.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_from` in favor of :attr:`forward_origin`.
"""
warn_about_deprecated_attr_in_property(
@ -1250,7 +1250,7 @@ class Message(MaybeInaccessibleMessage):
""":class:`telegram.Chat`: Optional. For messages forwarded from channels or from anonymous
administrators, information about the original sender chat.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_from_chat` in favor of :attr:`forward_origin`.
"""
warn_about_deprecated_attr_in_property(
@ -1265,7 +1265,7 @@ class Message(MaybeInaccessibleMessage):
""":obj:`int`: Optional. For forwarded channel posts, identifier of the original message
in the channel.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_from_message_id` in favor of
:attr:`forward_origin`.
"""
@ -1281,7 +1281,7 @@ class Message(MaybeInaccessibleMessage):
""":obj:`str`: Optional. For messages forwarded from channels, signature
of the post author if present.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_signature` in favor of :attr:`forward_origin`.
"""
warn_about_deprecated_attr_in_property(
@ -1296,7 +1296,7 @@ class Message(MaybeInaccessibleMessage):
""":class:`telegram.User`: Optional. Sender's name for messages forwarded from users who
disallow adding a link to their account in forwarded messages.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_sender_name` in favor of :attr:`forward_origin`.
"""
warn_about_deprecated_attr_in_property(
@ -1314,7 +1314,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
|datetime_localization|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates :attr:`forward_date` in favor of :attr:`forward_origin`.
"""
warn_about_deprecated_attr_in_property(
@ -1575,7 +1575,7 @@ class Message(MaybeInaccessibleMessage):
message.compute_quote_position_and_entities("Hello, world!", 1)
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
quote (:obj:`str`): Part of the message which is to be quoted. This is
@ -1676,7 +1676,7 @@ class Message(MaybeInaccessibleMessage):
)
)
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
quote (:obj:`str`, optional): Passed in :meth:`compute_quote_position_and_entities`
@ -1792,12 +1792,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -1868,12 +1868,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -1939,12 +1939,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2010,12 +2010,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2075,12 +2075,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.Message`]: An array of the sent Messages.
@ -2142,12 +2142,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2213,12 +2213,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2285,12 +2285,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2358,12 +2358,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2426,12 +2426,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2495,12 +2495,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2567,12 +2567,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2634,12 +2634,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2703,12 +2703,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2775,12 +2775,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2845,12 +2845,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2918,12 +2918,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -2987,12 +2987,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -3079,12 +3079,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
.. versionadded:: 13.2
@ -3171,12 +3171,12 @@ class Message(MaybeInaccessibleMessage):
Keyword Args:
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.Message`: On success, instance representing the message posted.
@ -3366,12 +3366,12 @@ class Message(MaybeInaccessibleMessage):
quote (:obj:`bool`, optional): |reply_quote|
.. versionadded:: 13.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This argument is deprecated in favor of :paramref:`do_quote`
do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote|
Mutually exclusive with :paramref:`quote`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.MessageId`: On success, returns the MessageId of the sent message.
@ -4080,7 +4080,7 @@ class Message(MaybeInaccessibleMessage):
For the documentation of the arguments, please see
:meth:`telegram.Bot.set_message_reaction`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool` On success, :obj:`True` is returned.
@ -4314,7 +4314,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4339,7 +4339,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4365,7 +4365,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4390,7 +4390,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4548,7 +4548,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.5
|custom_emoji_no_md1_support|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
|blockquote_no_md1_support|
Returns:
@ -4578,7 +4578,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4605,7 +4605,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.5
|custom_emoji_no_md1_support|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
|blockquote_no_md1_support|
Returns:
@ -4635,7 +4635,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4660,7 +4660,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.5
|custom_emoji_no_md1_support|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
|blockquote_no_md1_support|
Returns:
@ -4690,7 +4690,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:
@ -4719,7 +4719,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.5
|custom_emoji_no_md1_support|
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
|blockquote_no_md1_support|
Returns:
@ -4749,7 +4749,7 @@ class Message(MaybeInaccessibleMessage):
.. versionchanged:: 20.3
Custom emoji entities are now supported.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Blockquote entities are now supported.
Returns:

6
telegram/_messageentity.py
View file

@ -52,7 +52,7 @@ class MessageEntity(TelegramObject):
.. versionadded:: 20.0
Added inline custom emoji
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Added block quotation
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.
@ -81,7 +81,7 @@ class MessageEntity(TelegramObject):
.. versionadded:: 20.0
Added inline custom emoji
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Added block quotation
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.
@ -183,7 +183,7 @@ class MessageEntity(TelegramObject):
BLOCKQUOTE: Final[str] = constants.MessageEntityType.BLOCKQUOTE
""":const:`telegram.constants.MessageEntityType.BLOCKQUOTE`
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
ALL_TYPES: Final[List[str]] = list(constants.MessageEntityType)
"""List[:obj:`str`]: A list of all available message entity types."""

10
telegram/_messageorigin.py
View file

@ -44,7 +44,7 @@ class MessageOrigin(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`type` and :attr:`date` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
type (:obj:`str`): Type of the message origin, can be on of:
@ -131,7 +131,7 @@ class MessageOriginUser(MessageOrigin):
"""
The message was originally sent by a known user.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
date (:obj:`datetime.datetime`): Date the message was sent originally.
@ -165,7 +165,7 @@ class MessageOriginHiddenUser(MessageOrigin):
"""
The message was originally sent by an unknown user.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
date (:obj:`datetime.datetime`): Date the message was sent originally.
@ -199,7 +199,7 @@ class MessageOriginChat(MessageOrigin):
"""
The message was originally sent on behalf of a chat to a group chat.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
date (:obj:`datetime.datetime`): Date the message was sent originally.
@ -242,7 +242,7 @@ class MessageOriginChannel(MessageOrigin):
"""
The message was originally sent to a channel chat.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
date (:obj:`datetime.datetime`): Date the message was sent originally.

4
telegram/_messagereactionupdated.py
View file

@ -39,7 +39,7 @@ class MessageReactionCountUpdated(TelegramObject):
considered equal, if the :attr:`chat`, :attr:`message_id`, :attr:`date` and :attr:`reactions`
is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat (:class:`telegram.Chat`): The chat containing the message.
@ -111,7 +111,7 @@ class MessageReactionUpdated(TelegramObject):
considered equal, if the :attr:`chat`, :attr:`message_id`, :attr:`date`, :attr:`old_reaction`
and :attr:`new_reaction` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
chat (:class:`telegram.Chat`): The chat containing the message.

8
telegram/_reaction.py
View file

@ -32,7 +32,7 @@ class ReactionType(TelegramObject):
"""Base class for Telegram ReactionType Objects.
There exist :class:`telegram.ReactionTypeEmoji` and :class:`telegram.ReactionTypeCustomEmoji`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
type (:obj:`str`): Type of the reaction. Can be
@ -88,7 +88,7 @@ class ReactionTypeEmoji(ReactionType):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if the :attr:`emoji` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
emoji (:obj:`str`): Reaction emoji. It can be one of
@ -123,7 +123,7 @@ class ReactionTypeCustomEmoji(ReactionType):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if the :attr:`custom_emoji_id` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
custom_emoji_id (:obj:`str`): Custom emoji identifier.
@ -157,7 +157,7 @@ class ReactionCount(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if the :attr:`type` and :attr:`total_count` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
type (:class:`telegram.ReactionType`): Type of the reaction.

6
telegram/_reply.py
View file

@ -57,7 +57,7 @@ class ExternalReplyInfo(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`origin` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
origin (:class:`telegram.MessageOrigin`): Origin of the message replied to by the given
@ -273,7 +273,7 @@ class TextQuote(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`text` and :attr:`position` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
text (:obj:`str`): Text of the quoted part of a message that is replied to by the given
@ -348,7 +348,7 @@ class ReplyParameters(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`message_id` is equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
message_id (:obj:`int`): Identifier of the message that will be replied to in the current

6
telegram/_shared.py
View file

@ -37,7 +37,7 @@ class UsersShared(TelegramObject):
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`request_id` and :attr:`user_ids` are equal.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Bot API 7.0 replaces :class:`UserShared` with this class. The only difference is that now
the :attr:`user_ids` is a sequence instead of a single integer.
@ -83,7 +83,7 @@ class UserShared(UsersShared):
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :class:`UsersShared` instead.
"""
@ -116,7 +116,7 @@ class UserShared(UsersShared):
def user_id(self) -> int:
"""Alias for the first entry of :attr:`UsersShared.user_ids`.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Bot API 7.0 deprecates this attribute in favor of :attr:`UsersShared.user_ids`.
"""
warn_about_deprecated_attr_in_property(

24
telegram/_update.py
View file

@ -105,12 +105,12 @@ class Update(TelegramObject):
chat_boost (:class:`telegram.ChatBoostUpdated`, optional): A chat boost was added or
changed. The bot must be an administrator in the chat to receive these updates.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
removed_chat_boost (:class:`telegram.ChatBoostRemoved`, optional): A boost was removed from
a chat. The bot must be an administrator in the chat to receive these updates.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
message_reaction (:class:`telegram.MessageReactionUpdated`, optional): A reaction to a
message was changed by a user. The bot must be an administrator in the chat and must
@ -121,7 +121,7 @@ class Update(TelegramObject):
:meth:`telegram.ext.Application.run_webhook`). The update isn't received for reactions
set by bots.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
message_reaction_count (:class:`telegram.MessageReactionCountUpdated`, optional): Reactions
to a message with anonymous reactions were changed. The bot must be an administrator in
@ -132,7 +132,7 @@ class Update(TelegramObject):
:meth:`telegram.ext.Application.run_webhook`). The updates are grouped and can be sent
with delay up to a few minutes.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Attributes:
update_id (:obj:`int`): The update's unique identifier. Update identifiers start from a
@ -191,12 +191,12 @@ class Update(TelegramObject):
chat_boost (:class:`telegram.ChatBoostUpdated`): Optional. A chat boost was added or
changed. The bot must be an administrator in the chat to receive these updates.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
removed_chat_boost (:class:`telegram.ChatBoostRemoved`): Optional. A boost was removed from
a chat. The bot must be an administrator in the chat to receive these updates.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
message_reaction (:class:`telegram.MessageReactionUpdated`): Optional. A reaction to a
message was changed by a user. The bot must be an administrator in the chat and must
@ -207,7 +207,7 @@ class Update(TelegramObject):
:meth:`telegram.ext.Application.run_webhook`). The update isn't received for reactions
set by bots.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
message_reaction_count (:class:`telegram.MessageReactionCountUpdated`): Optional. Reactions
to a message with anonymous reactions were changed. The bot must be an administrator in
@ -218,7 +218,7 @@ class Update(TelegramObject):
:meth:`telegram.ext.Application.run_webhook`). The updates are grouped and can be sent
with delay up to a few minutes.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = (
@ -305,19 +305,19 @@ class Update(TelegramObject):
CHAT_BOOST: Final[str] = constants.UpdateType.CHAT_BOOST
""":const:`telegram.constants.UpdateType.CHAT_BOOST`
.. versionadded:: NEXT.VERSION"""
.. versionadded:: 20.8"""
REMOVED_CHAT_BOOST: Final[str] = constants.UpdateType.REMOVED_CHAT_BOOST
""":const:`telegram.constants.UpdateType.REMOVED_CHAT_BOOST`
.. versionadded:: NEXT.VERSION"""
.. versionadded:: 20.8"""
MESSAGE_REACTION: Final[str] = constants.UpdateType.MESSAGE_REACTION
""":const:`telegram.constants.UpdateType.MESSAGE_REACTION`
.. versionadded:: NEXT.VERSION"""
.. versionadded:: 20.8"""
MESSAGE_REACTION_COUNT: Final[str] = constants.UpdateType.MESSAGE_REACTION_COUNT
""":const:`telegram.constants.UpdateType.MESSAGE_REACTION_COUNT`
.. versionadded:: NEXT.VERSION"""
.. versionadded:: 20.8"""
ALL_TYPES: Final[List[str]] = list(constants.UpdateType)
"""List[:obj:`str`]: A list of all available update types.

14
telegram/_user.py
View file

@ -453,7 +453,7 @@ class User(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Bot.delete_message`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool`: On success, :obj:`True` is returned.
@ -485,7 +485,7 @@ class User(TelegramObject):
For the documentation of the arguments, please see :meth:`telegram.Bot.delete_messages`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:obj:`bool`: On success, :obj:`True` is returned.
@ -1635,7 +1635,7 @@ class User(TelegramObject):
.. seealso:: :meth:`copy_message`, :meth:`send_copy`, :meth:`copy_messages`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -1680,7 +1680,7 @@ class User(TelegramObject):
.. seealso:: :meth:`copy_message`, :meth:`send_copy`, :meth:`send_copies`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -1809,7 +1809,7 @@ class User(TelegramObject):
.. seealso:: :meth:`forward_to`, :meth:`forward_from`, :meth:`forward_messages_to`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -1852,7 +1852,7 @@ class User(TelegramObject):
.. seealso:: :meth:`forward_from`, :meth:`forward_to`, :meth:`forward_messages_from`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId`
@ -2034,7 +2034,7 @@ class User(TelegramObject):
For the documentation of the arguments, please see
:meth:`telegram.Bot.get_user_chat_boosts`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`telegram.UserChatBoosts`: On success, returns the boosts applied by the user.

4
telegram/_utils/defaultvalue.py
View file

@ -138,11 +138,11 @@ DEFAULT_20: DefaultValue[int] = DefaultValue(20)
DEFAULT_IP: DefaultValue[str] = DefaultValue("127.0.0.1")
""":class:`DefaultValue`: Default :obj:`127.0.0.1`
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
DEFAULT_80: DefaultValue[int] = DefaultValue(80)
""":class:`DefaultValue`: Default :obj:`80`
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""

2
telegram/_version.py
View file

@ -51,7 +51,7 @@ class Version(NamedTuple):
__version_info__: Final[Version] = Version(
major=20, minor=7, micro=0, releaselevel="final", serial=0
major=20, minor=8, micro=0, releaselevel="final", serial=0
)
__version__: Final[str] = str(__version_info__)

58
telegram/constants.py
View file

@ -159,7 +159,7 @@ SUPPORTED_WEBHOOK_PORTS: Final[List[int]] = [443, 80, 88, 8443]
#: :obj:`datetime.datetime`, value of unix 0.
#: This date literal is used in :class:`telegram.InaccessibleMessage`
#:
#: .. versionadded:: NEXT.VERSION
#: .. versionadded:: 20.8
ZERO_DATE: Final[datetime.datetime] = datetime.datetime(1970, 1, 1, tzinfo=UTC)
@ -177,7 +177,7 @@ class AccentColor(Enum):
Since Telegram gives no exact specification for the accent colors, future accent colors might
have a different data type.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -641,7 +641,7 @@ class BulkRequestLimit(IntEnum):
:meth:`telegram.Bot.forward_messages` and :meth:`telegram.Bot.copy_messages`. The enum members
of this enumeration are instances of :class:`int` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -706,7 +706,7 @@ class ChatBoostSources(StringEnum):
:class:`Telegram chat boost <telegram.ChatBoostSource>`.
The enum members of this enumeration are instances of :class:`str` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -1114,7 +1114,7 @@ class GiveawayLimit(IntEnum):
"""This enum contains limitations for :class:`telegram.Giveaway` and related classes.
The enum members of this enumeration are instances of :class:`int` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -1128,7 +1128,7 @@ class KeyboardButtonRequestUsersLimit(IntEnum):
"""This enum contains limitations for :class:`telegram.KeyboardButtonRequestUsers`.
The enum members of this enumeration are instances of :class:`int` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -1610,7 +1610,7 @@ class MessageEntityType(StringEnum):
BLOCKQUOTE = "blockquote"
""":obj:`str`: Message entities representing a block quotation.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
@ -1674,7 +1674,7 @@ class MessageOriginType(StringEnum):
"""This enum contains the available types of :class:`telegram.MessageOrigin`. The enum
members of this enumeration are instances of :class:`str` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -1710,7 +1710,7 @@ class MessageType(StringEnum):
CHAT_SHARED = "chat_shared"
""":obj:`str`: Messages with :attr:`telegram.Message.chat_shared`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
CONNECTED_WEBSITE = "connected_website"
""":obj:`str`: Messages with :attr:`telegram.Message.connected_website`."""
@ -1725,54 +1725,54 @@ class MessageType(StringEnum):
FORUM_TOPIC_CREATED = "forum_topic_created"
""":obj:`str`: Messages with :attr:`telegram.Message.forum_topic_created`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
FORUM_TOPIC_CLOSED = "forum_topic_closed"
""":obj:`str`: Messages with :attr:`telegram.Message.forum_topic_closed`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
FORUM_TOPIC_EDITED = "forum_topic_edited"
""":obj:`str`: Messages with :attr:`telegram.Message.forum_topic_edited`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
FORUM_TOPIC_REOPENED = "forum_topic_reopened"
""":obj:`str`: Messages with :attr:`telegram.Message.forum_topic_reopened`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GAME = "game"
""":obj:`str`: Messages with :attr:`telegram.Message.game`."""
GENERAL_FORUM_TOPIC_HIDDEN = "general_forum_topic_hidden"
""":obj:`str`: Messages with :attr:`telegram.Message.general_forum_topic_hidden`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GENERAL_FORUM_TOPIC_UNHIDDEN = "general_forum_topic_unhidden"
""":obj:`str`: Messages with :attr:`telegram.Message.general_forum_topic_unhidden`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GIVEAWAY = "giveaway"
""":obj:`str`: Messages with :attr:`telegram.Message.giveaway`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GIVEAWAY_CREATED = "giveaway_created"
""":obj:`str`: Messages with :attr:`telegram.Message.giveaway_created`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GIVEAWAY_WINNERS = "giveaway_winners"
""":obj:`str`: Messages with :attr:`telegram.Message.giveaway_winners`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GIVEAWAY_COMPLETED = "giveaway_completed"
""":obj:`str`: Messages with :attr:`telegram.Message.giveaway_completed`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
GROUP_CHAT_CREATED = "group_chat_created"
""":obj:`str`: Messages with :attr:`telegram.Message.group_chat_created`."""
@ -1815,7 +1815,7 @@ class MessageType(StringEnum):
USERS_SHARED = "users_shared"
""":obj:`str`: Messages with :attr:`telegram.Message.users_shared`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
VENUE = "venue"
""":obj:`str`: Messages with :attr:`telegram.Message.venue`."""
@ -1836,12 +1836,12 @@ class MessageType(StringEnum):
WEB_APP_DATA = "web_app_data"
""":obj:`str`: Messages with :attr:`telegram.Message.web_app_data`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
WRITE_ACCESS_ALLOWED = "write_access_allowed"
""":obj:`str`: Messages with :attr:`telegram.Message.write_access_allowed`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
@ -1879,7 +1879,7 @@ class ProfileAccentColor(Enum):
Since Telegram gives no exact specification for the accent colors, future accent colors might
have a different data type.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -2472,22 +2472,22 @@ class UpdateType(StringEnum):
CHAT_BOOST = "chat_boost"
""":obj:`str`: Updates with :attr:`telegram.Update.chat_boost`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
REMOVED_CHAT_BOOST = "removed_chat_boost"
""":obj:`str`: Updates with :attr:`telegram.Update.removed_chat_boost`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
MESSAGE_REACTION = "message_reaction"
""":obj:`str`: Updates with :attr:`telegram.Update.message_reaction`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
MESSAGE_REACTION_COUNT = "message_reaction_count"
""":obj:`str`: Updates with :attr:`telegram.Update.message_reaction_count`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
@ -2660,7 +2660,7 @@ class ReactionType(StringEnum):
"""This enum contains the available types of :class:`telegram.ReactionType`. The enum
members of this enumeration are instances of :class:`str` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()
@ -2675,7 +2675,7 @@ class ReactionEmoji(StringEnum):
"""This enum contains the available emojis of :class:`telegram.ReactionTypeEmoji`. The enum
members of this enumeration are instances of :class:`str` and can be treated as such.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()

2
telegram/error.py
View file

@ -138,7 +138,7 @@ class EndPointNotFound(TelegramError):
"""Raised when the requested endpoint is not found. Only relevant for
:meth:`telegram.Bot.do_api_request`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ()

2
telegram/ext/_application.py
View file

@ -968,7 +968,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AsyncContextManager["Applica
this param, you must also run a reverse proxy to the unix socket and set the
appropriate :paramref:`webhook_url`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
if not self.updater:
raise RuntimeError(

16
telegram/ext/_defaults.py
View file

@ -44,7 +44,7 @@ class Defaults:
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in this
message. Mutually exclusive with :paramref:`link_preview_options`.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :paramref:`link_preview_options` instead. This parameter will be removed in
future versions.
@ -52,7 +52,7 @@ class Defaults:
Will be used for :attr:`telegram.ReplyParameters.allow_sending_without_reply`.
quote (:obj:`bool`, optional): |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :paramref:`do_quote` instead. This parameter will be removed in future
versions.
tzinfo (:class:`datetime.tzinfo`, optional): A timezone to be used for all date(time)
@ -110,10 +110,10 @@ class Defaults:
link_preview_options=LinkPreviewOptions(url="https://telegram.org")
)
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
do_quote(:obj:`bool`, optional): |reply_quote|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = (
@ -282,7 +282,7 @@ class Defaults:
""":obj:`bool`: Optional. Disables link previews for links in all outgoing
messages.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :attr:`link_preview_options` instead. This attribute will be removed in future
versions.
"""
@ -311,7 +311,7 @@ class Defaults:
def quote(self) -> Optional[bool]:
""":obj:`bool`: Optional. |reply_quote|
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :attr:`do_quote` instead. This attribute will be removed in future
versions.
"""
@ -364,7 +364,7 @@ class Defaults:
""":class:`telegram.LinkPreviewOptions`: Optional. Link preview generation options for all
outgoing messages.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
return self._link_preview_options
@ -372,6 +372,6 @@ class Defaults:
def do_quote(self) -> Optional[bool]:
""":obj:`bool`: Optional. |reply_quote|
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
return self._do_quote

2
telegram/ext/_handlers/chatboosthandler.py
View file

@ -34,7 +34,7 @@ class ChatBoostHandler(BaseHandler[Update, CCT]):
When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
callback (:term:`coroutine function`): The callback function for this handler. Will be

2
telegram/ext/_handlers/messagereactionhandler.py
View file

@ -48,7 +48,7 @@ class MessageReactionHandler(BaseHandler[Update, CCT]):
When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Args:
callback (:term:`coroutine function`): The callback function for this handler. Will be

4
telegram/ext/_handlers/precheckoutqueryhandler.py
View file

@ -58,7 +58,7 @@ class PreCheckoutQueryHandler(BaseHandler[Update, CCT]):
pattern (:obj:`str` | :func:`re.Pattern <re.compile>`, optional): Optional. Regex pattern
to test :attr:`telegram.PreCheckoutQuery.invoice_payload` against.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Attributes:
callback (:term:`coroutine function`): The callback function for this handler.
@ -66,7 +66,7 @@ class PreCheckoutQueryHandler(BaseHandler[Update, CCT]):
pattern (:obj:`str` | :func:`re.Pattern <re.compile>`, optional): Optional. Regex pattern
to test :attr:`telegram.PreCheckoutQuery.invoice_payload` against.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""

2
telegram/ext/_updater.py
View file

@ -546,7 +546,7 @@ class Updater(AsyncContextManager["Updater"]):
this param, you must also run a reverse proxy to the unix socket and set the
appropriate :paramref:`webhook_url`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Returns:
:class:`queue.Queue`: The update queue that can be filled from the main thread.

2
telegram/ext/_utils/_update_parsing.py
View file

@ -18,7 +18,7 @@
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains helper functions related to parsing updates and their contents.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
Warning:
Contents of this module are intended to be used internally by the library and *not* by the

16
telegram/ext/filters.py
View file

@ -870,7 +870,7 @@ class _Chat(MessageFilter):
CHAT = _Chat(name="filters.CHAT")
"""This filter filters *any* message that has a :attr:`telegram.Message.chat`.
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
This filter has no effect since :attr:`telegram.Message.chat` is always present.
"""
@ -1362,7 +1362,7 @@ class _Forwarded(MessageFilter):
FORWARDED = _Forwarded(name="filters.FORWARDED")
"""Messages that contain :attr:`telegram.Message.forward_origin`.
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Now based on :attr:`telegram.Message.forward_origin` instead of
:attr:`telegram.Message.forward_date`.
"""
@ -1378,7 +1378,7 @@ class ForwardedFrom(_ChatUserBaseFilter):
.. versionadded:: 13.5
.. versionchanged:: NEXT.VERSION
.. versionchanged:: 20.8
Was previously based on :attr:`telegram.Message.forward_from` and
:attr:`telegram.Message.forward_from_chat`.
@ -2048,7 +2048,7 @@ class StatusUpdate:
GIVEAWAY_CREATED = _GiveawayCreated(name="filters.StatusUpdate.GIVEAWAY_CREATED")
"""Messages that contain :attr:`telegram.Message.giveaway_created`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
class _GiveawayCompleted(MessageFilter):
@ -2059,7 +2059,7 @@ class StatusUpdate:
GIVEAWAY_COMPLETED = _GiveawayCompleted(name="filters.StatusUpdate.GIVEAWAY_COMPLETED")
"""Messages that contain :attr:`telegram.Message.giveaway_completed`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
class _LeftChatMember(MessageFilter):
@ -2156,7 +2156,7 @@ class StatusUpdate:
new :attr:`telegram.Message.users_shared` attribute!
.. versionadded:: 20.1
.. deprecated:: NEXT.VERSION
.. deprecated:: 20.8
Use :attr:`USERS_SHARED` instead.
"""
@ -2169,7 +2169,7 @@ class StatusUpdate:
USERS_SHARED = _UsersShared(name="filters.StatusUpdate.USERS_SHARED")
"""Messages that contain :attr:`telegram.Message.users_shared`.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
class _VideoChatEnded(MessageFilter):
@ -2365,7 +2365,7 @@ class SuccessfulPayment(MessageFilter):
invoice payloads to allow. Only exact matches are allowed. If not
specified, will allow any invoice payload.
.. versionadded:: NEXT.VERSION
.. versionadded:: 20.8
"""
__slots__ = ("invoice_payloads",)