From 031dd691acb0d44b3c882a1367b3fa089cda1175 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 24 Apr 2022 14:58:17 +0200 Subject: [PATCH 01/19] Change version number v14 -> v20 --- docs/source/conf.py | 6 ++-- docs/source/telegram.request.rst | 2 +- telegram/_bot.py | 10 +++--- telegram/_chat.py | 2 +- telegram/_chatinvitelink.py | 2 +- telegram/_chatmember.py | 2 +- telegram/_files/file.py | 2 +- telegram/_files/inputfile.py | 4 +-- telegram/_files/inputmedia.py | 2 +- telegram/_forcereply.py | 2 +- telegram/_inline/inlinequery.py | 4 +-- telegram/_message.py | 2 +- telegram/_poll.py | 2 +- telegram/_telegramobject.py | 6 ++-- telegram/_utils/datetime.py | 2 +- telegram/_utils/defaultvalue.py | 4 +-- telegram/_utils/files.py | 2 +- telegram/_utils/markup.py | 2 +- telegram/_utils/types.py | 2 +- telegram/_utils/warnings.py | 4 +-- telegram/constants.py | 52 +++++++++++++-------------- telegram/error.py | 10 +++--- telegram/ext/_application.py | 20 +++++------ telegram/ext/_basepersistence.py | 26 +++++++------- telegram/ext/_callbackcontext.py | 8 ++--- telegram/ext/_conversationhandler.py | 4 +-- telegram/ext/_defaults.py | 6 ++-- telegram/ext/_dictpersistence.py | 10 +++--- telegram/ext/_handler.py | 2 +- telegram/ext/_jobqueue.py | 36 +++++++++---------- telegram/ext/_picklepersistence.py | 8 ++--- telegram/ext/_updater.py | 6 ++-- telegram/ext/_utils/stack.py | 2 +- telegram/ext/_utils/trackingdict.py | 2 +- telegram/ext/_utils/types.py | 8 ++--- telegram/ext/filters.py | 12 +++---- telegram/helpers.py | 2 +- telegram/request/_baserequest.py | 2 +- telegram/request/_httpxrequest.py | 2 +- telegram/request/_requestdata.py | 2 +- telegram/request/_requestparameter.py | 2 +- telegram/warnings.py | 8 ++--- 42 files changed, 147 insertions(+), 147 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index f0a3fb5e8bb..bc14a028df1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -155,10 +155,10 @@ 'admonition-font-size': '0.92rem'}, 'light_css_variables': {'admonition-title-font-size': '0.95rem', 'admonition-font-size': '0.92rem'}, - "announcement": 'PTB has undergone significant changes in v14. Please read the documentation ' + "announcement": 'PTB has undergone significant changes in v20. Please read the documentation ' 'carefully and also check out the transition guide in the ' - '' - 'wiki.', + 'wiki.', } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 5279a8af171..71f19fc4dfd 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -3,7 +3,7 @@ telegram.request Module ======================= -.. versionadded:: 14.0 +.. versionadded:: 20.0 .. toctree:: telegram.request.baserequest diff --git a/telegram/_bot.py b/telegram/_bot.py index 08ebadf2757..cb0a1c6a467 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -152,7 +152,7 @@ class Bot(TelegramObject, AbstractAsyncContextManager): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`bot` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Removed the deprecated methods ``kick_chat_member``, ``kickChatMember``, ``get_chat_members_count`` and ``getChatMembersCount``. @@ -366,7 +366,7 @@ async def initialize(self) -> None: cache :attr:`bot` and calls :meth:`telegram.request.BaseRequest.initialize` for the request objects used by this bot. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ if self._initialized: self._logger.debug('This Bot is already initialized.') @@ -380,7 +380,7 @@ async def shutdown(self) -> None: """Stop & clear resources used by this class. Currently just calls :meth:`telegram.request.BaseRequest.shutdown` for the request objects used by this bot. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ if not self._initialized: self._logger.debug('This Bot is already shut down. Returning.') @@ -5278,7 +5278,7 @@ async def edit_chat_invite_link( of the target channel (in the format ``@channelusername``). invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Now also accepts :obj:`telegram.ChatInviteLink` instances. expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. @@ -5373,7 +5373,7 @@ async def revoke_chat_invite_link( of the target channel (in the format ``@channelusername``). invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to revoke. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Now also accepts :obj:`telegram.ChatInviteLink` instances. read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to diff --git a/telegram/_chat.py b/telegram/_chat.py index ea9469721e6..bc110c73a8d 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -62,7 +62,7 @@ class Chat(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`id` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the deprecated methods ``kick_member`` and ``get_members_count``. Args: diff --git a/telegram/_chatinvitelink.py b/telegram/_chatinvitelink.py index 42aa06c9a34..5e18300506e 100644 --- a/telegram/_chatinvitelink.py +++ b/telegram/_chatinvitelink.py @@ -36,7 +36,7 @@ class ChatInviteLink(TelegramObject): :attr:`is_primary` and :attr:`is_revoked` are equal. .. versionadded:: 13.4 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * The argument & attribute :attr:`creates_join_request` is now required to comply with the Bot API. diff --git a/telegram/_chatmember.py b/telegram/_chatmember.py index a97a124d5a2..135f43fe959 100644 --- a/telegram/_chatmember.py +++ b/telegram/_chatmember.py @@ -42,7 +42,7 @@ class ChatMember(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`user` and :attr:`status` are equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 As of Bot API 5.3, :class:`ChatMember` is nothing but the base class for the subclasses listed above and is no longer returned directly by :meth:`~telegram.Bot.get_chat`. Therefore, most of the arguments and attributes were removed and you should no longer diff --git a/telegram/_files/file.py b/telegram/_files/file.py index 5d5b036746b..38fd9b47bd7 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -119,7 +119,7 @@ async def download( :attr:`file_path` is the path of a local file (which is the case when a Bot API Server is running in local mode), this method will just return the path. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * :paramref:`custom_path` parameter now also accepts :class:`pathlib.Path` as argument. * Returns :class:`pathlib.Path` object in cases where previously a :obj:`str` was diff --git a/telegram/_files/inputfile.py b/telegram/_files/inputfile.py index 0f50efd7d31..bf9a79a29c9 100644 --- a/telegram/_files/inputfile.py +++ b/telegram/_files/inputfile.py @@ -35,7 +35,7 @@ class InputFile: """This object represents a Telegram InputFile. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The former attribute ``attach`` was renamed to :attr:`attach_name`. Args: @@ -46,7 +46,7 @@ class InputFile: If :paramref:`obj` is a string, it will be encoded as bytes via :external:obj:`obj.encode('utf-8') `. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Accept string input. filename (:obj:`str`, optional): Filename for this InputFile. attach (:obj:`bool`, optional): Pass :obj:`True` if the parameter this file belongs to in diff --git a/telegram/_files/inputmedia.py b/telegram/_files/inputmedia.py index 9e2ccbe9c09..813f0d4249a 100644 --- a/telegram/_files/inputmedia.py +++ b/telegram/_files/inputmedia.py @@ -41,7 +41,7 @@ class InputMedia(TelegramObject): """ Base class for Telegram InputMedia Objects. - .. versionchanged:: 14.0: + .. versionchanged:: 20.0: Added arguments and attributes :attr:`type`, :attr:`media`, :attr:`caption`, :attr:`caption_entities`, :paramref:`parse_mode`. diff --git a/telegram/_forcereply.py b/telegram/_forcereply.py index 18921670d04..c7d67eb1f18 100644 --- a/telegram/_forcereply.py +++ b/telegram/_forcereply.py @@ -33,7 +33,7 @@ class ForceReply(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`selective` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The (undocumented) argument ``force_reply`` was removed and instead :attr:`force_reply` is now always set to :obj:`True` as expected by the Bot API. diff --git a/telegram/_inline/inlinequery.py b/telegram/_inline/inlinequery.py index cb8adc2e219..ea470fef137 100644 --- a/telegram/_inline/inlinequery.py +++ b/telegram/_inline/inlinequery.py @@ -140,7 +140,7 @@ async def answer( For the documentation of the arguments, please see :meth:`telegram.Bot.answer_inline_query`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Raises :class:`ValueError` instead of :class:`TypeError`. Args: @@ -178,5 +178,5 @@ async def answer( MAX_SWITCH_PM_TEXT_LENGTH: ClassVar[int] = constants.InlineQueryLimit.SWITCH_PM_TEXT_LENGTH """:const:`telegram.constants.InlineQueryLimit.SWITCH_PM_TEXT_LENGTH` - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ diff --git a/telegram/_message.py b/telegram/_message.py index 902cdc6e154..9b0986d825c 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -661,7 +661,7 @@ def effective_attachment( Otherwise :obj:`None` is returned. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`dice`, :attr:`passport_data` and :attr:`poll` are now also considered to be an attachment. diff --git a/telegram/_poll.py b/telegram/_poll.py index da9e362ea2f..368c2c4dddc 100644 --- a/telegram/_poll.py +++ b/telegram/_poll.py @@ -295,5 +295,5 @@ def parse_explanation_entities(self, types: List[str] = None) -> Dict[MessageEnt MAX_OPTION_NUMBER: ClassVar[int] = constants.PollLimit.OPTION_NUMBER """:const:`telegram.constants.PollLimit.OPTION_NUMBER` - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ diff --git a/telegram/_telegramobject.py b/telegram/_telegramobject.py index e9243429548..d3a0ae172e9 100644 --- a/telegram/_telegramobject.py +++ b/telegram/_telegramobject.py @@ -48,7 +48,7 @@ class TelegramObject: assert telegram_object.get_bot() is copy.deepcopy(telegram_object).get_bot() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 ``telegram_object['from']`` will look up the key ``from_user``. This is to account for special cases like :attr:`Message.from_user` that deviate from the official Bot API. """ @@ -229,7 +229,7 @@ def get_bot(self) -> 'Bot': .. seealso:: :meth:`set_bot` - .. versionadded: 14.0 + .. versionadded: 20.0 Raises: RuntimeError: If no :class:`telegram.Bot` instance was set for this object. @@ -245,7 +245,7 @@ def set_bot(self, bot: Optional['Bot']) -> None: .. seealso:: :meth:`get_bot` - .. versionadded: 14.0 + .. versionadded: 20.0 Arguments: bot (:class:`telegram.Bot` | :obj:`None`): The bot instance. diff --git a/telegram/_utils/datetime.py b/telegram/_utils/datetime.py index 63803bfff45..5dd2072d4d7 100644 --- a/telegram/_utils/datetime.py +++ b/telegram/_utils/datetime.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to datetime and timestamp conversations. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. diff --git a/telegram/_utils/defaultvalue.py b/telegram/_utils/defaultvalue.py index 581678e00a9..c79ce9473f1 100644 --- a/telegram/_utils/defaultvalue.py +++ b/telegram/_utils/defaultvalue.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the DefaultValue class. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. @@ -131,7 +131,7 @@ def __repr__(self) -> str: DEFAULT_TRUE: DefaultValue = DefaultValue(True) """:class:`DefaultValue`: Default :obj:`True` -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ DEFAULT_20: DefaultValue = DefaultValue(20) diff --git a/telegram/_utils/files.py b/telegram/_utils/files.py index 5197bb21ad3..861a3f146ac 100644 --- a/telegram/_utils/files.py +++ b/telegram/_utils/files.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to handling of files. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. diff --git a/telegram/_utils/markup.py b/telegram/_utils/markup.py index 776cda57a50..888937ba601 100644 --- a/telegram/_utils/markup.py +++ b/telegram/_utils/markup.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a helper function for Telegram's ReplyMarkups -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) class ``telegram.ReplyMarkup``. diff --git a/telegram/_utils/types.py b/telegram/_utils/types.py index c211cd45458..048a452fbf3 100644 --- a/telegram/_utils/types.py +++ b/telegram/_utils/types.py @@ -72,7 +72,7 @@ ] """Type alias for reply markup objects. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ FieldTuple = Tuple[str, bytes, str] diff --git a/telegram/_utils/warnings.py b/telegram/_utils/warnings.py index afdd5827a4a..82c5a3aff97 100644 --- a/telegram/_utils/warnings.py +++ b/telegram/_utils/warnings.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to warnings issued by the library. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the @@ -35,7 +35,7 @@ def warn(message: str, category: Type[Warning] = PTBUserWarning, stacklevel: int """ Helper function used as a shortcut for warning with default values. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: message (:obj:`str`): Specify the warnings message to pass to ``warnings.warn()``. diff --git a/telegram/constants.py b/telegram/constants.py index 36d71889f75..2522fad48de 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -20,8 +20,8 @@ `Telegram Bots FAQ `_ and `Telegram Bots API `_. -.. versionchanged:: 14.0 - Since v14.0, most of the constants in this module are grouped into enums. +.. versionchanged:: 20.0 + Since v20.0, most of the constants in this module are grouped into enums. Attributes: BOT_API_VERSION (:obj:`str`): `5.7`. Telegram Bot API version supported by this @@ -79,7 +79,7 @@ class BotCommandScopeType(StringEnum): """This enum contains the available types of :class:`telegram.BotCommandScope`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -105,7 +105,7 @@ class CallbackQueryLimit(IntEnum): :meth:`telegram.Bot.answer_callback_query`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -119,7 +119,7 @@ class ChatAction(StringEnum): """This enum contains the available chat actions for :meth:`telegram.Bot.send_chat_action`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -152,7 +152,7 @@ class ChatID(IntEnum): """This enum contains some special chat IDs. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -187,7 +187,7 @@ class ChatInviteLinkLimit(IntEnum): :meth:`telegram.Bot.create_chat_invite_link`/:meth:`telegram.Bot.edit_chat_invite_link`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -204,7 +204,7 @@ class ChatMemberStatus(StringEnum): """This enum contains the available states for :class:`telegram.ChatMember`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -227,7 +227,7 @@ class ChatType(StringEnum): """This enum contains the available types of :class:`telegram.Chat`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -250,7 +250,7 @@ class DiceEmoji(StringEnum): :meth:`telegram.Bot.send_dice`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -273,7 +273,7 @@ class FileSizeLimit(IntEnum): """This enum contains limitations regarding the upload and download of files. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -290,7 +290,7 @@ class FloodLimit(IntEnum): """This enum contains limitations regarding flood limits. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -315,7 +315,7 @@ class InlineKeyboardMarkupLimit(IntEnum): :meth:`telegram.Bot.send_message` & friends. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -338,7 +338,7 @@ class InputMediaType(StringEnum): """This enum contains the available types of :class:`telegram.InputMedia`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -360,7 +360,7 @@ class InlineQueryLimit(IntEnum): :meth:`telegram.Bot.answer_inline_query`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -377,7 +377,7 @@ class InlineQueryResultType(StringEnum): """This enum contains the available types of :class:`telegram.InlineQueryResult`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -429,7 +429,7 @@ class LocationLimit(IntEnum): :meth:`telegram.Bot.send_location`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -451,7 +451,7 @@ class MaskPosition(StringEnum): """This enum contains the available positions for :class:`telegram.MaskPosition`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -471,7 +471,7 @@ class MessageAttachmentType(StringEnum): as attachment. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -519,7 +519,7 @@ class MessageEntityType(StringEnum): """This enum contains the available types of :class:`telegram.MessageEntity`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -563,7 +563,7 @@ class MessageLimit(IntEnum): :meth:`telegram.Bot.send_message` & friends. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -587,7 +587,7 @@ class MessageType(StringEnum): as attachment. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -673,7 +673,7 @@ class ParseMode(StringEnum): """This enum contains the available parse modes. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -696,7 +696,7 @@ class PollLimit(IntEnum): :meth:`telegram.Bot.send_poll`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -714,7 +714,7 @@ class PollType(StringEnum): :meth:`telegram.Bot.send_poll`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -729,7 +729,7 @@ class UpdateType(StringEnum): """This enum contains the available types of :class:`telegram.Update`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () diff --git a/telegram/error.py b/telegram/error.py index 5b95ff3f684..715f6a95ba9 100644 --- a/telegram/error.py +++ b/telegram/error.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains classes that represent Telegram errors. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Replaced ``Unauthorized`` by :class:`Forbidden`. """ @@ -84,7 +84,7 @@ def __reduce__(self) -> Tuple[type, Tuple[str]]: class Forbidden(TelegramError): """Raised when the bot has not enough rights to perform the requested action. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This class was previously named ``Unauthorized``. """ @@ -97,7 +97,7 @@ class InvalidToken(TelegramError): Args: message (:obj:`str`, optional): Any additional information about the exception. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ('_message',) @@ -128,7 +128,7 @@ class TimedOut(NetworkError): Args: message (:obj:`str`, optional): Any additional information about the exception. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -187,7 +187,7 @@ def __reduce__(self) -> Tuple[type, Tuple[str]]: class PassportDecryptionError(TelegramError): """Something went wrong with decryption. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This class was previously named ``TelegramDecryptionError`` and was available via ``telegram.TelegramDecryptionError``. """ diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index d11323bf6fb..8c6e81deb7f 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -130,7 +130,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) finally: await application.shutdown() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Initialization is now done through the :class:`telegram.ext.ApplicationBuilder`. * Removed the attribute ``groups``. @@ -145,7 +145,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) chat_data (:obj:`types.MappingProxyType`): A dictionary handlers can use to store data for the chat. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`chat_data` is now read-only .. tip:: @@ -154,7 +154,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) user_data (:obj:`types.MappingProxyType`): A dictionary handlers can use to store data for the user. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`user_data` is now read-only .. tip:: @@ -423,7 +423,7 @@ async def _initialize_persistence(self) -> None: def builder() -> 'InitApplicationBuilder': """Convenience method. Returns a new :class:`telegram.ext.ApplicationBuilder`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ # Unfortunately this needs to be here due to cyclical imports from telegram.ext import ApplicationBuilder # pylint: disable=import-outside-toplevel @@ -903,7 +903,7 @@ async def process_update(self, update: object) -> None: """Processes a single update and marks the update to be updated by the persistence later. Exceptions raised by handler callbacks will be processed by :meth:`process_update`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Persistence is now updated in an interval set by :attr:`telegram.ext.BasePersistence.update_interval`. @@ -1030,7 +1030,7 @@ def add_handlers( """Registers multiple handlers at once. The order of the handlers in the passed sequence(s) matters. See :meth:`add_handler` for details. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: handlers (List[:class:`telegram.ext.Handler`] | \ @@ -1092,7 +1092,7 @@ def drop_chat_data(self, chat_id: int) -> None: the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete. The entry will be deleted even if it is @@ -1111,7 +1111,7 @@ def drop_user_data(self, user_id: int) -> None: the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete. The entry will be deleted even if it is @@ -1397,7 +1397,7 @@ async def process_error( (even in other groups) will handle the update. All other exceptions raised by an error handler will just be logged. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * ``dispatch_error`` was renamed to :meth:`process_error`. * Exceptions raised by error handlers are now properly logged. @@ -1409,7 +1409,7 @@ async def process_error( error (:obj:`Exception`): The error that was raised. job (:class:`telegram.ext.Job`, optional): The job that caused the error. - .. versionadded:: 14.0 + .. versionadded:: 20.0 coroutine (:term:`coroutine function`, optional): The coroutine that caused the error. Returns: diff --git a/telegram/ext/_basepersistence.py b/telegram/ext/_basepersistence.py index 998836e121f..2567b3b6e4a 100644 --- a/telegram/ext/_basepersistence.py +++ b/telegram/ext/_basepersistence.py @@ -105,7 +105,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): :class:`telegram.TelegramObject`, one may call :meth:`set_bot` to ensure that shortcuts like :meth:`telegram.Message.reply_text` are available. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. * ``insert/replace_bot`` was dropped. Serialization of bot instances now needs to be handled by the specific implementation - see above note. @@ -119,7 +119,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: store_data (:class:`PersistenceInput`): Specifies which kinds of data will be saved by this @@ -148,7 +148,7 @@ def update_interval(self) -> float: """:obj:`float`: Time (in seconds) that the :class:`~telegram.ext.Application` will wait between two consecutive runs of updating the persistence. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ return self._update_interval @@ -184,7 +184,7 @@ async def get_user_data(self) -> Dict[int, UD]: * The type from :attr:`telegram.ext.ContextTypes.user_data` if :class:`telegram.ext.ContextTypes` is used. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: @@ -203,7 +203,7 @@ async def get_chat_data(self) -> Dict[int, CD]: * The type from :attr:`telegram.ext.ContextTypes.chat_data` if :class:`telegram.ext.ContextTypes` is used. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: @@ -234,7 +234,7 @@ async def get_callback_data(self) -> Optional[CDCData]: .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Returns: @@ -310,7 +310,7 @@ async def update_callback_data(self, data: CDCData) -> None: .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -324,7 +324,7 @@ async def drop_chat_data(self, chat_id: int) -> None: """Will be called by the :class:`telegram.ext.Application`, when using :meth:`~telegram.ext.Application.drop_chat_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -335,7 +335,7 @@ async def drop_user_data(self, user_id: int) -> None: """Will be called by the :class:`telegram.ext.Application`, when using :meth:`~telegram.ext.Application.drop_user_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. @@ -349,7 +349,7 @@ async def refresh_user_data(self, user_id: int, user_data: UD) -> None: .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -367,7 +367,7 @@ async def refresh_chat_data(self, chat_id: int, chat_data: CD) -> None: .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -385,7 +385,7 @@ async def refresh_bot_data(self, bot_data: BD) -> None: .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -398,6 +398,6 @@ async def flush(self) -> None: """Will be called by :meth:`telegram.ext.Application.stop`. Gives the persistence a chance to finish up saving or close a database connection gracefully. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. """ diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index 58cbd89a245..f25ac21a116 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -90,7 +90,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): Only present when passed to the callback of :class:`telegram.ext.Job` or in error handlers if the error is caused by a job. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`job` is now also present in error handlers if the error is caused by a job. """ @@ -112,7 +112,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): async def callback(update: Update, context: CallbackContext.DEFAULT_TYPE): ... - .. versionadded: 14.0 + .. versionadded: 20.0 """ __slots__ = ( @@ -261,7 +261,7 @@ def from_error( .. seealso:: :meth:`telegram.ext.Application.add_error_handler` - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed arguments ``async_args`` and ``async_kwargs``. Args: @@ -272,7 +272,7 @@ def from_error( context. job (:class:`telegram.ext.Job`, optional): The job associated with the error. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Returns: :class:`telegram.ext.CallbackContext` diff --git a/telegram/ext/_conversationhandler.py b/telegram/ext/_conversationhandler.py index 43447d2ba2d..f8e83dee620 100644 --- a/telegram/ext/_conversationhandler.py +++ b/telegram/ext/_conversationhandler.py @@ -228,7 +228,7 @@ class ConversationHandler(Handler[Update, CCT]): saved. :paramref:`name` is required and persistence has to be set in :attr:`Application <.Application.persistence>`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Was previously named as ``persistence``. map_to_parent (Dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be used to instruct a child conversation handler to transition into a mapped state on @@ -242,7 +242,7 @@ class ConversationHandler(Handler[Update, CCT]): 2. the value passed to this parameter (if any) 3. :attr:`telegram.ext.Defaults.block` (if defaults are used) - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 No longer overrides the handlers settings. Resolution order was changed. Raises: diff --git a/telegram/ext/_defaults.py b/telegram/ext/_defaults.py index 8e1a43efd73..64b27680e92 100644 --- a/telegram/ext/_defaults.py +++ b/telegram/ext/_defaults.py @@ -26,7 +26,7 @@ class Defaults: """Convenience Class to gather all parameters with a (user defined) default value - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the argument and attribute ``timeout``. Specify default timeout behavior for the networking backend directly via :class:`telegram.ext.ApplicationBuilder` instead. @@ -54,7 +54,7 @@ class Defaults: protect_content (:obj:`bool`, optional): Protects the contents of the sent message from forwarding and saving. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ( @@ -210,7 +210,7 @@ def protect_content(self) -> Optional[bool]: """:obj:`bool`: Optional. Protects the contents of the sent message from forwarding and saving. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ return self._protect_content diff --git a/telegram/ext/_dictpersistence.py b/telegram/ext/_dictpersistence.py index c5e6d676397..ec36ea1d89d 100644 --- a/telegram/ext/_dictpersistence.py +++ b/telegram/ext/_dictpersistence.py @@ -49,7 +49,7 @@ class DictPersistence(BasePersistence): * This implementation of :class:`BasePersistence` does not handle data that cannot be serialized by :func:`json.dumps`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. Args: @@ -73,7 +73,7 @@ class DictPersistence(BasePersistence): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: store_data (:class:`PersistenceInput`): Specifies which kinds of data will be saved by this @@ -371,7 +371,7 @@ async def update_callback_data(self, data: CDCData) -> None: async def drop_chat_data(self, chat_id: int) -> None: """Will delete the specified key from the :attr:`chat_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -384,7 +384,7 @@ async def drop_chat_data(self, chat_id: int) -> None: async def drop_user_data(self, user_id: int) -> None: """Will delete the specified key from the :attr:`user_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. @@ -418,7 +418,7 @@ async def refresh_bot_data(self, bot_data: Dict) -> None: async def flush(self) -> None: """Does nothing. - .. versionadded:: 14.0 + .. versionadded:: 20.0 .. seealso:: :meth:`telegram.ext.BasePersistence.flush` """ diff --git a/telegram/ext/_handler.py b/telegram/ext/_handler.py index e9b6cd13085..b4c2cb00b12 100644 --- a/telegram/ext/_handler.py +++ b/telegram/ext/_handler.py @@ -38,7 +38,7 @@ class Handler(Generic[UT, CCT], ABC): 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. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The attribute ``run_async`` is now :paramref:`block`. Args: diff --git a/telegram/ext/_jobqueue.py b/telegram/ext/_jobqueue.py index 40f919b3cc1..d318365de8a 100644 --- a/telegram/ext/_jobqueue.py +++ b/telegram/ext/_jobqueue.py @@ -42,7 +42,7 @@ class JobQueue: Attributes: scheduler (:class:`apscheduler.schedulers.asyncio.AsyncIOScheduler`): The scheduler. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Use :class:`~apscheduler.schedulers.asyncio.AsyncIOScheduler` instead of :class:`~apscheduler.schedulers.background.BackgroundScheduler` @@ -156,13 +156,13 @@ async def callback(context: CallbackContext) passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 context (:obj:`object`, optional): Additional data needed for the callback function. Can be accessed through :attr:`Job.context` in the callback. Defaults to :obj:`None`. @@ -263,13 +263,13 @@ async def callback(context: CallbackContext) passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -320,7 +320,7 @@ def run_monthly( ) -> 'Job': """Creates a new :class:`Job` that runs on a monthly basis and adds it to the queue. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The ``day_is_strict`` argument was removed. Instead one can now pass -1 to the ``day`` parameter to have the job run on the last day of the month. @@ -345,13 +345,13 @@ async def callback(context: CallbackContext) passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -420,13 +420,13 @@ async def callback(context: CallbackContext) passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -485,13 +485,13 @@ async def callback(context: CallbackContext) passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Returns: :class:`telegram.ext.Job`: The new :class:`Job` instance that has been added to the job @@ -563,7 +563,7 @@ class Job: * If :attr:`job` isn't passed on initialization, it must be set manually afterwards for this :class:`telegram.ext.Job` to be useful. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed argument and attribute ``job_queue``. Args: @@ -579,10 +579,10 @@ async def callback(context: CallbackContext) job (:class:`apscheduler.job.Job`, optional): The APS Job this job is a wrapper for. chat_id (:obj:`int`, optional): Chat id of the chat that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: callback (:term:`coroutine function`): The callback function that should be executed by the @@ -592,10 +592,10 @@ async def callback(context: CallbackContext) job (:class:`apscheduler.job.Job`): Optional. The APS Job this job is a wrapper for. chat_id (:obj:`int`): Optional. Chat id of the chat that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`): Optional. User id of the user that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ( @@ -634,7 +634,7 @@ async def run(self, application: 'Application') -> None: """Executes the callback function independently of the jobs schedule. Also calls :meth:`telegram.ext.Application.update_persistence`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Calls :meth:`telegram.ext.Application.update_persistence`. Args: diff --git a/telegram/ext/_picklepersistence.py b/telegram/ext/_picklepersistence.py index 8d3091ea10a..24dfb04f094 100644 --- a/telegram/ext/_picklepersistence.py +++ b/telegram/ext/_picklepersistence.py @@ -141,7 +141,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): :attr:`~BasePersistence.bot` will be replaced by a placeholder before pickling and :attr:`~BasePersistence.bot` will be inserted back when loading the data. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. * The parameter and attribute ``filename`` were replaced by :attr:`filepath`. @@ -171,7 +171,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: filepath (:obj:`str` | :obj:`pathlib.Path`): The filepath for storing the pickle files. @@ -489,7 +489,7 @@ async def drop_chat_data(self, chat_id: int) -> None: """Will delete the specified key from the ``chat_data`` and depending on :attr:`on_flush` save the pickle file. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -508,7 +508,7 @@ async def drop_user_data(self, user_id: int) -> None: """Will delete the specified key from the ``user_data`` and depending on :attr:`on_flush` save the pickle file. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. diff --git a/telegram/ext/_updater.py b/telegram/ext/_updater.py index dc469134b8e..a4a7c327933 100644 --- a/telegram/ext/_updater.py +++ b/telegram/ext/_updater.py @@ -68,7 +68,7 @@ class Updater(AbstractAsyncContextManager): finally: await updater.shutdown() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Removed argument and attribute ``user_sig_handler`` * The only arguments and attributes are now :attr:`bot` and :attr:`update_queue` as now @@ -187,7 +187,7 @@ async def start_polling( ) -> asyncio.Queue: """Starts polling updates from Telegram. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the ``clean`` argument in favor of :paramref:`drop_pending_updates`. Args: @@ -385,7 +385,7 @@ async def start_webhook( .. versionchanged:: 13.4 :meth:`start_webhook` now *always* calls :meth:`telegram.Bot.set_webhook`, so pass ``webhook_url`` instead of calling ``updater.bot.set_webhook(webhook_url)`` manually. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the ``clean`` argument in favor of :paramref:`drop_pending_updates` and removed the deprecated argument ``force_event_loop``. diff --git a/telegram/ext/_utils/stack.py b/telegram/ext/_utils/stack.py index e4df470d715..d25379179c9 100644 --- a/telegram/ext/_utils/stack.py +++ b/telegram/ext/_utils/stack.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to inspecting the program stack. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the diff --git a/telegram/ext/_utils/trackingdict.py b/telegram/ext/_utils/trackingdict.py index f14c6baa52c..1de9944932b 100644 --- a/telegram/ext/_utils/trackingdict.py +++ b/telegram/ext/_utils/trackingdict.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a mutable mapping that keeps track of the keys that where accessed. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the diff --git a/telegram/ext/_utils/types.py b/telegram/ext/_utils/types.py index 48e16143ee6..2ec2fe6a649 100644 --- a/telegram/ext/_utils/types.py +++ b/telegram/ext/_utils/types.py @@ -53,12 +53,12 @@ HandlerCallback = Callable[[UT, CCT], Coroutine[Any, Any, RT]] """Type of a handler callback - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ JobCallback = Callable[[CCT], Coroutine[Any, Any, Any]] """Type of a job callback - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ ConversationKey = Tuple[Union[int, str], ...] @@ -80,7 +80,7 @@ BT = TypeVar('BT', bound='Bot') """Type of the bot. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ UD = TypeVar('UD') """Type of the user data for a single user. @@ -100,4 +100,4 @@ JQ = TypeVar('JQ', bound=Union[None, 'JobQueue']) """Type of the job queue. -.. versionadded:: 14.0""" +.. versionadded:: 20.0""" diff --git a/telegram/ext/filters.py b/telegram/ext/filters.py index 2e47e50c1c4..80474eb977a 100644 --- a/telegram/ext/filters.py +++ b/telegram/ext/filters.py @@ -20,7 +20,7 @@ This module contains filters for use with :class:`telegram.ext.MessageHandler`, :class:`telegram.ext.CommandHandler`, or :class:`telegram.ext.PrefixHandler`. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 #. Filters are no longer callable, if you're using a custom filter and are calling an existing filter, then switch to the new syntax: ``filters.{filter}.check_update(update)``. @@ -159,7 +159,7 @@ class BaseFilter: will be the class name. If you want to overwrite this assign a better name to the :attr:`name` class variable. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Added the arguments :attr:`name` and :attr:`data_filter`. Args: @@ -1896,7 +1896,7 @@ def filter(self, message: Message) -> bool: """Messages that contain :attr:`telegram.Message.sticker` and :attr:`is animated `. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _Static(MessageFilter): @@ -1912,7 +1912,7 @@ def filter(self, message: Message) -> bool: """Messages that contain :attr:`telegram.Message.sticker` and is a static sticker, i.e. does not contain :attr:`telegram.Sticker.is_animated` or :attr:`telegram.Sticker.is_video`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _Video(MessageFilter): @@ -1925,7 +1925,7 @@ def filter(self, message: Message) -> bool: """Messages that contain :attr:`telegram.Message.sticker` and is a :attr:`video sticker `. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ @@ -2033,7 +2033,7 @@ def filter(self, update: Update) -> bool: """Updates with either :attr:`telegram.Update.edited_message` or :attr:`telegram.Update.edited_channel_post`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _EditedChannelPost(UpdateFilter): diff --git a/telegram/helpers.py b/telegram/helpers.py index f9ce4a3a81d..25d72a5875a 100644 --- a/telegram/helpers.py +++ b/telegram/helpers.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains convenience helper functions. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram.utils.helpers``. """ diff --git a/telegram/request/_baserequest.py b/telegram/request/_baserequest.py index ece9f2009d5..39a6a3660e3 100644 --- a/telegram/request/_baserequest.py +++ b/telegram/request/_baserequest.py @@ -72,7 +72,7 @@ class BaseRequest( finally: await request_object.shutdown() - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () diff --git a/telegram/request/_httpxrequest.py b/telegram/request/_httpxrequest.py index 9a378c07ea1..d1bdcdbf79b 100644 --- a/telegram/request/_httpxrequest.py +++ b/telegram/request/_httpxrequest.py @@ -40,7 +40,7 @@ class HTTPXRequest(BaseRequest): """Implementation of :class:`~telegram.request.BaseRequest` using the library `httpx `_. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: connection_pool_size (:obj:`int`, optional): Number of connections to keep in the diff --git a/telegram/request/_requestdata.py b/telegram/request/_requestdata.py index 6bcc0c97a79..433783923b1 100644 --- a/telegram/request/_requestdata.py +++ b/telegram/request/_requestdata.py @@ -33,7 +33,7 @@ class RequestData: """Instances of this class collect the data needed for one request to the Bot API, including all parameters and files to be sent along with the request. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Warning: How exactly instances of this will are created should be considered an implementation diff --git a/telegram/request/_requestparameter.py b/telegram/request/_requestparameter.py index 311ff506f0d..8e29262ace7 100644 --- a/telegram/request/_requestparameter.py +++ b/telegram/request/_requestparameter.py @@ -37,7 +37,7 @@ class RequestParameter: """Instances of this class represent a single parameter to be sent along with a request to the Bot API. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Warning: This class intended is to be used internally by the library and *not* by the user. Changes diff --git a/telegram/warnings.py b/telegram/warnings.py index 5ac35418ccc..41fb1f2a243 100644 --- a/telegram/warnings.py +++ b/telegram/warnings.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains classes used for warnings issued by this library. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ __all__ = ['PTBDeprecationWarning', 'PTBRuntimeWarning', 'PTBUserWarning'] @@ -28,7 +28,7 @@ class PTBUserWarning(UserWarning): """ Custom user warning class used for warnings in this library. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -38,7 +38,7 @@ class PTBRuntimeWarning(PTBUserWarning, RuntimeWarning): """ Custom runtime warning class used for warnings in this library. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -50,7 +50,7 @@ class PTBDeprecationWarning(PTBUserWarning, DeprecationWarning): """ Custom warning class for deprecations in this library. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Renamed TelegramDeprecationWarning to PTBDeprecationWarning. """ From 60b7e8143b1d4dafdcd99edf4018f9caeaccea7f Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 24 Apr 2022 15:06:48 +0200 Subject: [PATCH 02/19] Overhaul readmes --- README.rst | 173 +++++++++++++++---------------------------------- README_RAW.rst | 154 ++++++++++++++----------------------------- 2 files changed, 99 insertions(+), 228 deletions(-) diff --git a/README.rst b/README.rst index fbdfd5a6e62..747cbdaefd7 100644 --- a/README.rst +++ b/README.rst @@ -6,12 +6,6 @@ :target: https://python-telegram-bot.org :alt: python-telegram-bot Logo -We have made you a wrapper you can't refuse - -We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! - -*Stay tuned for library updates and new releases on our* `Telegram Channel `_. - .. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg :target: https://pypi.org/project/python-telegram-bot/ :alt: PyPi Package Version @@ -29,7 +23,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr :alt: PyPi Package Monthly Download .. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable - :target: https://python-telegram-bot.readthedocs.io/en/stable/?badge=stable + :target: https://python-telegram-bot.readthedocs.io/en/stable/ :alt: Documentation Status .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg @@ -59,41 +53,26 @@ We have a vibrant community of developers helping each other in our `Telegram gr .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black +.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram + :target: https://t.me/pythontelegrambotchannel + :alt: Telegram Group + .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup :alt: Telegram Group -================= -Table of contents -================= - -- `Introduction`_ - -- `Telegram API support`_ - -- `Installing`_ - -- `Getting started`_ - - #. `Learning by example`_ - - #. `Logging`_ - - #. `Documentation`_ - -- `Getting help`_ +We have made you a wrapper you can't refuse -- `Contributing`_ +We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! -- `License`_ +*Stay tuned for library updates and new releases on our* `Telegram Channel `_. -============ Introduction ============ -This library provides a pure Python interface for the +This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.7+**. PTB might also work on `PyPy `_, though there have been a lot of issues before. Hence, PyPy is not officially supported. +It's compatible with Python versions **3.7+**. In addition to the pure API implementation, this library features a number of high-level classes to make the development of bots easy and straightforward. These classes are contained in the @@ -101,51 +80,35 @@ make the development of bots easy and straightforward. These classes are contain A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``. `See here for details. `_ ----- Note ---- Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both. -==================== Telegram API support ==================== All types and methods of the Telegram Bot API **5.7** are supported. -=========== -Concurrency -=========== - -Since v14.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. -Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. -Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include: - -* ``telegram.ext.Application/Updater.update_queue`` -* ``telegram.ext.ConversationHandler.check/handle_update`` -* ``telegram.ext.CallbackDataCache`` -* ``telegram.ext.BasePersistence`` -* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime - -========== Installing ========== -You can install or upgrade python-telegram-bot with: +You can install or upgrade ``python-telegram-bot`` via .. code:: shell $ pip install python-telegram-bot --upgrade -Or you can install from source with: +To install a pre-release, use the ``--pre`` `flag `_ in addition. + +You can also install ``python-telegram-bot`` from source, though this is usually not necessary. .. code:: shell - $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive + $ git clone https://github.com/python-telegram-bot/python-telegram-bot $ cd python-telegram-bot $ python setup.py install ---------------------- Optional Dependencies --------------------- @@ -155,96 +118,62 @@ PTB can be installed with optional dependencies: * ``pip install python-telegram-bot[json]`` installs the `ujson `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. * ``pip install python-telegram-bot[socks]`` installs the `PySocks `_ library. Use this, if you want to work behind a Socks5 server. -=============== -Getting started -=============== - -Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``: - -- `Introduction to the API `_ -- Tutorial: `Your first Bot `_ - -Other references: - -- `Telegram API documentation `_ -- `python-telegram-bot documentation `_ - -------------------- -Learning by example -------------------- - -We believe that the best way to learn this package is by example. Here -are some examples for you to review. Even if it is not your approach for learning, please take a -look at ``echobot.py``. It is the de facto base for most of the bots out there. Best of all, -the code for these examples is released to the public domain, so you can start by grabbing the -code and building on top of it. - -Visit `this page `_ to discover the official examples or look at the examples on the `wiki `_ to see other bots the community has built. - -------- -Logging -------- - -This library uses the ``logging`` module. To set up logging to standard output, put: - -.. code:: python - - import logging - - logging.basicConfig( - level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" - ) - -at the beginning of your script. - -You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want: - -.. code:: python - - logger = logging.getLogger() - logger.setLevel(logging.INFO) - -If you want DEBUG logs instead: - -.. code:: python - - logger.setLevel(logging.DEBUG) +Quick Start +=========== +Our Wiki contains an `Introduction to the API `_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``. +Moreover, the `Tutorial: Your first Bot `_ gives an introduction on how chatbots can be easily programmed with the help of the ``telegram.ext`` module. -============= -Documentation -============= +Resources +========= -``python-telegram-bot``'s documentation lives at `readthedocs.io `_. +- The `package documentation `_ is the technical reference for ``python-telegram-bot``. + It contains descriptions of all available classes, modules, methods and arguments. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot` `and other useful resources that go beyond the technical documentation. +- Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. + Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. + The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. +- The `official Telegram Bot API documentation `_ is of course always worth a read. -============ Getting help ============ -You can get help in several ways: +If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help. -1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! +1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction. -2. Report bugs, request new features or ask questions by `creating an issue `_ or `a discussion `_. +2. Ask questions by opening `a discussion `_. -3. Our `Wiki pages `_ offer a growing amount of resources. +3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. -4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. +Concurrency +=========== + +Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. +Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. +Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include: +* ``telegram.ext.Application/Updater.update_queue`` +* ``telegram.ext.ConversationHandler.check/handle_update`` +* ``telegram.ext.CallbackDataCache`` +* ``telegram.ext.BasePersistence`` +* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime -============ Contributing ============ -Contributions of all sizes are welcome. Please review our `contribution guidelines `_ to get started. You can also help by `reporting bugs `_. +Contributions of all sizes are welcome. +Please review our `contribution guidelines `_ to get started. +You can also help by `reporting bugs or feature requests `_. -======== Donating ======== -Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. +Occasionally we are asked if we accept donations to support the development. +While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. +If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. -======= License ======= -You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. +Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. diff --git a/README_RAW.rst b/README_RAW.rst index fb4184d56e1..af8ee79c0fa 100644 --- a/README_RAW.rst +++ b/README_RAW.rst @@ -6,12 +6,6 @@ :target: https://python-telegram-bot.org :alt: python-telegram-bot-raw Logo -We have made you a wrapper you can't refuse - -We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! - -*Stay tuned for library updates and new releases on our* `Telegram Channel `_. - .. image:: https://img.shields.io/pypi/v/python-telegram-bot-raw.svg :target: https://pypi.org/project/python-telegram-bot-raw/ :alt: PyPi Package Version @@ -59,167 +53,115 @@ We have a vibrant community of developers helping each other in our `Telegram gr .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black +.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram + :target: https://t.me/pythontelegrambotchannel + :alt: Telegram Group + .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup :alt: Telegram Group -================= -Table of contents -================= - -- `Introduction`_ - -- `Telegram API support`_ - -- `Installing`_ - -- `Getting started`_ - - #. `Logging`_ - - #. `Documentation`_ - -- `Getting help`_ +We have made you a wrapper you can't refuse -- `Contributing`_ +We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! -- `License`_ +*Stay tuned for library updates and new releases on our* `Telegram Channel `_. -============ Introduction ============ -This library provides a pure Python, lightweight interface for the +This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.7+**. PTB-Raw might also work on `PyPy `_, though there have been a lot of issues before. Hence, PyPy is not officially supported. +It's compatible with Python versions **3.7+**. -``python-telegram-bot-raw`` is part of the `python-telegram-bot `_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does *not* have independent release schedules, changelogs or documentation. Please consult the PTB resources. +``python-telegram-bot-raw`` is part of the `python-telegram-bot `_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does not have independent release schedules, changelogs or documentation. ----- Note ---- Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both. -==================== Telegram API support ==================== All types and methods of the Telegram Bot API **5.7** are supported. -=========== -Concurrency -=========== - -Since v14.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. -Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. - -========== Installing ========== -You can install or upgrade python-telegram-bot-raw with: +You can install or upgrade ``python-telegram-bot`` via .. code:: shell $ pip install python-telegram-bot-raw --upgrade -Or you can install from source with: +To install a pre-release, use the ``--pre`` `flag `_ in addition. + +You can also install ``python-telegram-bot-raw`` from source, though this is usually not necessary. .. code:: shell - $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive + $ git clone https://github.com/python-telegram-bot/python-telegram-bot $ cd python-telegram-bot $ python setup-raw.py install ----- -Note ----- - -Installing the `.tar.gz` archive available on PyPi directly via `pip` will *not* work as expected, as `pip` does not recognize that it should use `setup-raw.py` instead of `setup.py`. - ---------------------- Optional Dependencies --------------------- -PTB can be installed with optional dependencies: - -* ``pip install python-telegram-bot-raw[passport]`` installs the `cryptography `_ library. Use this, if you want to use Telegram Passport related functionality. -* ``pip install python-telegram-bot-raw[json]`` installs the `ujson `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. - -=============== -Getting started -=============== - -Our Wiki contains an `Introduction to the API `_. Other references are: - -- the `Telegram API documentation `_ -- the `python-telegram-bot documentation `_ - -------- -Logging -------- - -This library uses the ``logging`` module. To set up logging to standard output, put: - -.. code:: python - - import logging - - logging.basicConfig( - level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" - ) +``python-telegram-bot-raw`` can be installed with optional dependencies: -at the beginning of your script. +* ``pip install python-telegram-bot[passport]`` installs the `cryptography `_ library. Use this, if you want to use Telegram Passport related functionality. +* ``pip install python-telegram-bot[json]`` installs the `ujson `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. +* ``pip install python-telegram-bot[socks]`` installs the `PySocks `_ library. Use this, if you want to work behind a Socks5 server. -You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want: - -.. code:: python - - logger = logging.getLogger() - logger.setLevel(logging.INFO) - -If you want DEBUG logs instead: - -.. code:: python - - logger.setLevel(logging.DEBUG) +Quick Start +=========== +Our Wiki contains an `Introduction to the API `_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``. -============= -Documentation -============= +Resources +========= -``python-telegram-bot``'s documentation lives at `readthedocs.io `_, which -includes the relevant documentation for ``python-telegram-bot-raw``. +- The `package documentation `_ is the technical reference for ``python-telegram-bot``. + It contains descriptions of all available classes, modules, methods and arguments. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot` `and other useful resources that go beyond the technical documentation. +- Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. + Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. + The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. +- The `official Telegram Bot API documentation `_ is of course always worth a read. -============ Getting help ============ -You can get help in several ways: +If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help. -1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! +1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction. -2. Report bugs, request new features or ask questions by `creating an issue `_ or `a discussion `_. +2. Ask questions by opening `a discussion `_. -3. Our `Wiki pages `_ offer a growing amount of resources. +3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. -4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. +Concurrency +=========== + +Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. +Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. -============ Contributing ============ -Contributions of all sizes are welcome. Please review our `contribution guidelines `_ to get started. You can also help by `reporting bugs `_. +Contributions of all sizes are welcome. +Please review our `contribution guidelines `_ to get started. +You can also help by `reporting bugs or feature requests `_. -======== Donating ======== -Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. +Occasionally we are asked if we accept donations to support the development. +While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. +If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. -======= License ======= -You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. +Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. From 03acd34f63373d85ffeb97c233903fac9d2d32dc Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 24 Apr 2022 15:17:41 +0200 Subject: [PATCH 03/19] Update start page of docs --- README.rst | 2 +- README_RAW.rst | 2 +- docs/source/index.rst | 33 +++++++++------------------------ docs/source/telegram.rst | 11 ----------- docs/source/telegram_auxil.rst | 10 ++++++++++ 5 files changed, 21 insertions(+), 37 deletions(-) create mode 100644 docs/source/telegram_auxil.rst diff --git a/README.rst b/README.rst index 747cbdaefd7..f79aeb6e78a 100644 --- a/README.rst +++ b/README.rst @@ -129,7 +129,7 @@ Resources - The `package documentation `_ is the technical reference for ``python-telegram-bot``. It contains descriptions of all available classes, modules, methods and arguments. -- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot` `and other useful resources that go beyond the technical documentation. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. - Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. diff --git a/README_RAW.rst b/README_RAW.rst index af8ee79c0fa..dc318f95123 100644 --- a/README_RAW.rst +++ b/README_RAW.rst @@ -124,7 +124,7 @@ Resources - The `package documentation `_ is the technical reference for ``python-telegram-bot``. It contains descriptions of all available classes, modules, methods and arguments. -- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot` `and other useful resources that go beyond the technical documentation. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. - Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. diff --git a/docs/source/index.rst b/docs/source/index.rst index 9b42222ec18..3172b732007 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,39 +3,24 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Python Telegram Bot's documentation! -=============================================== +.. include:: ../../README.rst -Guides and tutorials -==================== +.. The toctrees are hidden such that they don't reander on the start page but still include the contents into the documentation. -If you're just starting out with the library, we recommend following our `"Your first Bot" `_ tutorial that you can find on our `wiki `_. -While being there, you will also find guides to learn how to use handlers, webhooks, proxies, making your bot persistent, and much more. - -Examples -======== - -A great way to learn is by looking at examples. Ours can be found in our `examples folder on Github `_. - - -Reference -========= - -Below you can find a reference of all the classes and methods in python-telegram-bot. -Apart from the `telegram.ext` package and the `Auxiliary` modules, the objects reflect the types defined in the `official Telegram Bot API documentation `_. +.. toctree:: + telegram + :hidden: .. toctree:: telegram.ext + :hidden: .. toctree:: - telegram - -Changelog ---------- + telegram_auxil + :hidden: .. toctree:: - :maxdepth: 2 - changelog + :hidden: diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index 7e62b5468e5..c39d0e4efd9 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -167,14 +167,3 @@ Passport telegram.passportfile telegram.encryptedpassportelement telegram.encryptedcredentials - -Auxiliary modules ------------------ - -.. toctree:: - - telegram.constants - telegram.error - telegram.helpers - telegram.request - telegram.warnings diff --git a/docs/source/telegram_auxil.rst b/docs/source/telegram_auxil.rst new file mode 100644 index 00000000000..0a7d951e2c9 --- /dev/null +++ b/docs/source/telegram_auxil.rst @@ -0,0 +1,10 @@ +Auxiliary modules +================= + +.. toctree:: + + telegram.constants + telegram.error + telegram.helpers + telegram.request + telegram.warnings From b6e53d4b2713a41578449f51a0e9445951848476 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 24 Apr 2022 15:37:27 +0200 Subject: [PATCH 04/19] Bump doc deps & fix a few dead links --- docs/requirements-docs.txt | 4 ++-- telegram/_bot.py | 2 +- telegram/_chat.py | 6 ++++-- telegram/_inline/inlinequery.py | 4 +++- telegram/_message.py | 6 ++++-- telegram/_user.py | 6 ++++-- telegram/ext/_application.py | 4 ++-- telegram/ext/_applicationbuilder.py | 2 +- telegram/ext/_callbackcontext.py | 2 +- telegram/ext/_defaults.py | 3 +-- 10 files changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 33069985833..9c5e03c3817 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,6 +1,6 @@ -sphinx==4.4.0 +sphinx==4.5.0 sphinx-pypi-upload -furo==2022.1.2 +furo==2022.04.07 # Can be replaced with a sphinx-paramlinks==... dependency once a version is released that # includes the commit mentioned below and maybe even # https://github.com/sqlalchemyorg/sphinx-paramlinks/pull/14 diff --git a/telegram/_bot.py b/telegram/_bot.py index cb0a1c6a467..e0ffde17c31 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -6542,7 +6542,7 @@ async def send_poll( available modes. explanation_entities (List[:class:`telegram.MessageEntity`], optional): List of special entities that appear in message text, which can be specified instead of - :paramref:`parse_mode`. + :paramref:`explanation_parse_mode`. open_period (:obj:`int`, optional): Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with :paramref:`close_date`. close_date (:obj:`int` | :obj:`datetime.datetime`, optional): Point in time (Unix diff --git a/telegram/_chat.py b/telegram/_chat.py index bc110c73a8d..8d586750bfe 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -1289,12 +1289,14 @@ async def send_invoice( For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Returns: :class:`telegram.Message`: On success, instance representing the message posted. diff --git a/telegram/_inline/inlinequery.py b/telegram/_inline/inlinequery.py index ea470fef137..a48f868da49 100644 --- a/telegram/_inline/inlinequery.py +++ b/telegram/_inline/inlinequery.py @@ -145,7 +145,9 @@ async def answer( Args: auto_pagination (:obj:`bool`, optional): If set to :obj:`True`, :attr:`offset` will be - passed as :paramref:`current_offset` to :meth:`telegram.Bot.answer_inline_query`. + passed as + :paramref:`current_offset ` to + :meth:`telegram.Bot.answer_inline_query`. Defaults to :obj:`False`. Raises: diff --git a/telegram/_message.py b/telegram/_message.py index 9b0986d825c..5bf828f60b1 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -1884,14 +1884,16 @@ async def reply_invoice( For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionadded:: 13.2 .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the invoice is sent as an actual diff --git a/telegram/_user.py b/telegram/_user.py index 1bd2c5361d2..fca822901e4 100644 --- a/telegram/_user.py +++ b/telegram/_user.py @@ -774,12 +774,14 @@ async def send_invoice( For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Returns: :class:`telegram.Message`: On success, instance representing the message posted. diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 8c6e81deb7f..83d613b539e 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -1087,7 +1087,7 @@ def drop_chat_data(self, chat_id: int) -> None: the persistence on the next run of :meth:`update_persistence`, if applicable. Warning: - When using :paramref:`concurrent_updates` or the :attr:`job_queue`, + When using :attr:`concurrent_updates` or the :attr:`job_queue`, :meth:`process_update` or :meth:`telegram.ext.Job.run` may re-create this entry due to the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. @@ -1106,7 +1106,7 @@ def drop_user_data(self, user_id: int) -> None: the persistence on the next run of :meth:`update_persistence`, if applicable. Warning: - When using :paramref:`concurrent_updates` or the :attr:`job_queue`, + When using :attr:`concurrent_updates` or the :attr:`job_queue`, :meth:`process_update` or :meth:`telegram.ext.Job.run` may re-create this entry due to the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. diff --git a/telegram/ext/_applicationbuilder.py b/telegram/ext/_applicationbuilder.py index d2d67549bcd..5754dc3cd26 100644 --- a/telegram/ext/_applicationbuilder.py +++ b/telegram/ext/_applicationbuilder.py @@ -763,7 +763,7 @@ def concurrent_updates(self: BuilderType, concurrent_updates: Union[bool, int]) that your bot does not (explicitly or implicitly) rely on updates being processed sequentially. - .. seealso:: :paramref:`telegram.ext.Application.concurrent_updates` + .. seealso:: :attr:`telegram.ext.Application.concurrent_updates` Args: concurrent_updates (:obj:`bool` | :obj:`int`): Passing :obj:`True` will allow for diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index f25ac21a116..3e93fd960e2 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -64,7 +64,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): Warning: Do not combine custom attributes with :paramref:`telegram.ext.Handler.block` set to - :obj:`False` or :paramref:`telegram.ext.Application.concurrent_updates` set to + :obj:`False` or :attr:`telegram.ext.Application.concurrent_updates` set to :obj:`True`. Due to how those work, it will almost certainly execute the callbacks for an update out of order, and the attributes that you think you added will not be present. diff --git a/telegram/ext/_defaults.py b/telegram/ext/_defaults.py index 64b27680e92..cf43b44736b 100644 --- a/telegram/ext/_defaults.py +++ b/telegram/ext/_defaults.py @@ -30,7 +30,6 @@ class Defaults: Removed the argument and attribute ``timeout``. Specify default timeout behavior for the networking backend directly via :class:`telegram.ext.ApplicationBuilder` instead. - Parameters: parse_mode (:obj:`str`, optional): Send :attr:`~telegram.constants.ParseMode.MARKDOWN` or :attr:`~telegram.constants.ParseMode.HTML`, if you want Telegram apps to show @@ -120,7 +119,7 @@ def parse_mode(self, value: object) -> NoReturn: @property def explanation_parse_mode(self) -> Optional[str]: - """:obj:`str`: Optional. Alias for :paramref:`parse_mode`, used for + """:obj:`str`: Optional. Alias for :attr:`parse_mode`, used for the corresponding parameter of :meth:`telegram.Bot.send_poll`. """ return self._parse_mode From b76e2a222510421678a1da8f4bfddb345c5eaca1 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 27 Apr 2022 01:47:58 +0530 Subject: [PATCH 05/19] remove extra whitespace in timeout docs --- telegram/_bot.py | 328 +++++++++++++++++------------------ telegram/_files/file.py | 4 +- telegram/ext/_application.py | 4 +- telegram/ext/_updater.py | 4 +- 4 files changed, 170 insertions(+), 170 deletions(-) diff --git a/telegram/_bot.py b/telegram/_bot.py index e0ffde17c31..42555d3d014 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -521,13 +521,13 @@ async def get_me( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -604,13 +604,13 @@ async def send_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -681,13 +681,13 @@ async def delete_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -752,13 +752,13 @@ async def forward_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -861,12 +861,12 @@ async def send_photo( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1000,12 +1000,12 @@ async def send_audio( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1141,12 +1141,12 @@ async def send_document( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1243,12 +1243,12 @@ async def send_sticker( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1375,12 +1375,12 @@ async def send_video( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1507,12 +1507,12 @@ async def send_video_note( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1644,12 +1644,12 @@ async def send_animation( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1776,12 +1776,12 @@ async def send_voice( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1862,12 +1862,12 @@ async def send_media_group( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1965,13 +1965,13 @@ async def send_location( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2075,13 +2075,13 @@ async def edit_message_live_location( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2159,13 +2159,13 @@ async def stop_message_live_location( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2264,13 +2264,13 @@ async def send_venue( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2385,13 +2385,13 @@ async def send_contact( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2480,13 +2480,13 @@ async def send_game( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2542,13 +2542,13 @@ async def send_chat_action( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2711,13 +2711,13 @@ async def answer_inline_query( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2793,13 +2793,13 @@ async def get_user_profile_photos( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2868,13 +2868,13 @@ async def get_file( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2941,13 +2941,13 @@ async def ban_chat_member( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. until_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the user will @@ -3018,13 +3018,13 @@ async def ban_chat_sender_chat( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3079,13 +3079,13 @@ async def unban_chat_member( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3139,13 +3139,13 @@ async def unban_chat_sender_chat( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3214,13 +3214,13 @@ async def answer_callback_query( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3300,13 +3300,13 @@ async def edit_message_text( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3387,13 +3387,13 @@ async def edit_message_caption( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3473,13 +3473,13 @@ async def edit_message_media( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3548,13 +3548,13 @@ async def edit_message_reply_markup( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3625,13 +3625,13 @@ async def get_updates( read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to ``2``. :paramref:`timeout` will be added to this value. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. allowed_updates (List[:obj:`str`]), optional): A list the types of @@ -3747,13 +3747,13 @@ async def set_webhook( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3825,13 +3825,13 @@ async def delete_webhook( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3879,13 +3879,13 @@ async def leave_chat( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3932,13 +3932,13 @@ async def get_chat( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3984,13 +3984,13 @@ async def get_chat_administrators( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4038,13 +4038,13 @@ async def get_chat_member_count( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4089,13 +4089,13 @@ async def get_chat_member( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4144,13 +4144,13 @@ async def set_chat_sticker_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4192,13 +4192,13 @@ async def delete_chat_sticker_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4236,13 +4236,13 @@ async def get_webhook_info( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4298,13 +4298,13 @@ async def set_game_score( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4375,13 +4375,13 @@ async def get_game_high_scores( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4539,13 +4539,13 @@ async def send_invoice( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4649,13 +4649,13 @@ async def answer_shipping_query( # pylint: disable=invalid-name read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4740,13 +4740,13 @@ async def answer_pre_checkout_query( # pylint: disable=invalid-name read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4819,13 +4819,13 @@ async def restrict_chat_member( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4924,13 +4924,13 @@ async def promote_chat_member( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5003,13 +5003,13 @@ async def set_chat_permissions( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5059,13 +5059,13 @@ async def set_chat_administrator_custom_title( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5113,13 +5113,13 @@ async def export_chat_invite_link( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5185,13 +5185,13 @@ async def create_chat_invite_link( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5290,13 +5290,13 @@ async def edit_chat_invite_link( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5378,13 +5378,13 @@ async def revoke_chat_invite_link( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5437,13 +5437,13 @@ async def approve_chat_join_request( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5494,13 +5494,13 @@ async def decline_chat_join_request( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5552,13 +5552,13 @@ async def set_chat_photo( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5604,13 +5604,13 @@ async def delete_chat_photo( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5658,13 +5658,13 @@ async def set_chat_title( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5712,13 +5712,13 @@ async def set_chat_description( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5774,13 +5774,13 @@ async def pin_chat_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5835,13 +5835,13 @@ async def unpin_chat_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5892,13 +5892,13 @@ async def unpin_all_chat_messages( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5939,13 +5939,13 @@ async def get_sticker_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6001,13 +6001,13 @@ async def upload_sticker_file( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6105,13 +6105,13 @@ async def create_new_sticker_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6214,13 +6214,13 @@ async def add_sticker_to_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6275,13 +6275,13 @@ async def set_sticker_position_in_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6323,13 +6323,13 @@ async def delete_sticker_from_set( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6394,13 +6394,13 @@ async def set_sticker_set_thumb( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6457,13 +6457,13 @@ async def set_passport_data_errors( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6571,13 +6571,13 @@ async def send_poll( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6655,13 +6655,13 @@ async def stop_poll( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6742,13 +6742,13 @@ async def send_dice( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6799,13 +6799,13 @@ async def get_my_commands( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6872,13 +6872,13 @@ async def set_my_commands( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6952,13 +6952,13 @@ def delete_my_commands( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -7009,13 +7009,13 @@ async def log_out( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. @@ -7052,13 +7052,13 @@ async def close( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. @@ -7134,13 +7134,13 @@ async def copy_message( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the diff --git a/telegram/_files/file.py b/telegram/_files/file.py index 38fd9b47bd7..d2fcd1e4eaa 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -132,13 +132,13 @@ async def download( read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 83d613b539e..482fc648282 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -572,13 +572,13 @@ def run_polling( read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.read_timeout`. Defaults to ``2``. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on diff --git a/telegram/ext/_updater.py b/telegram/ext/_updater.py index a4a7c327933..e9c6ba02533 100644 --- a/telegram/ext/_updater.py +++ b/telegram/ext/_updater.py @@ -203,13 +203,13 @@ async def start_polling( * > 0 - retry up to X times read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.read_timeout`. Defaults to ``2``. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. allowed_updates (List[:obj:`str`], optional): Passed to From f0e3f5a4108985bb1858456e478b3c836bf66499 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 27 Apr 2022 02:00:07 +0530 Subject: [PATCH 06/19] few doc fixes for bot and inlinequeryhandler --- telegram/_bot.py | 35 +++++++++++++++-------------- telegram/ext/_inlinequeryhandler.py | 5 +++-- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/telegram/_bot.py b/telegram/_bot.py index 42555d3d014..dc6cf6cf2c2 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -6053,17 +6053,17 @@ async def create_new_sticker_set( """ Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. - You must use exactly one of the fields ``png_sticker``, ``tgs_sticker``, or - ``webm_sticker``. + You must use exactly one of the fields :paramref:`png_sticker`, :paramref:`tgs_sticker`, or + :paramref:`webm_sticker`. Warning: - As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the - arguments had to be changed. Use keyword arguments to make sure that the arguments are - passed correctly. + As of API 4.7 :paramref:`png_sticker` is an optional argument and therefore the order + of the arguments had to be changed. Use keyword arguments to make sure that the + arguments are passed correctly. Note: - The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from - disk ``open(filename, 'rb')`` + The :paramref:`png_sticker` and :paramref:`tgs_sticker` argument can be either a + file_id, an URL or a file from disk ``open(filename, 'rb')`` Args: user_id (:obj:`int`): User identifier of created sticker set owner. @@ -6167,19 +6167,19 @@ async def add_sticker_to_set( ) -> bool: """ Use this method to add a new sticker to a set created by the bot. - You **must** use exactly one of the fields ``png_sticker``, ``tgs_sticker`` or - ``webm_sticker``. Animated stickers can be added to animated sticker sets and only to them. - Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 - stickers. + You **must** use exactly one of the fields :paramref:`png_sticker`, :paramref:`tgs_sticker` + or :paramref:`webm_sticker`. Animated stickers can be added to animated sticker sets and + only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can + have up to 120 stickers. Warning: - As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the - arguments had to be changed. Use keyword arguments to make sure that the arguments are - passed correctly. + As of API 4.7 :paramref:`png_sticker` is an optional argument and therefore the order + of the arguments had to be changed. Use keyword arguments to make sure that the + arguments are passed correctly. Note: - The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from - disk ``open(filename, 'rb')`` + The :paramref:`png_sticker` and :paramref:`tgs_sticker` argument can be either a + file_id, an URL or a file from disk ``open(filename, 'rb')`` Args: user_id (:obj:`int`): User identifier of created sticker set owner. @@ -6371,7 +6371,8 @@ async def set_sticker_set_thumb( only. Note: - The thumb can be either a file_id, an URL or a file from disk ``open(filename, 'rb')`` + The :paramref:`thumb` can be either a file_id, an URL or a file from disk + ``open(filename, 'rb')`` Args: name (:obj:`str`): Sticker set name diff --git a/telegram/ext/_inlinequeryhandler.py b/telegram/ext/_inlinequeryhandler.py index f6e44dcd61d..74b8040ce13 100644 --- a/telegram/ext/_inlinequeryhandler.py +++ b/telegram/ext/_inlinequeryhandler.py @@ -43,8 +43,9 @@ class InlineQueryHandler(Handler[Update, CCT]): """ - Handler class to handle Telegram inline queries. Optionally based on a regex. Read the - documentation of the :mod:`re` module for more information. + Handler class to handle Telegram updates that contain a :attr:`Update.inline_query`. + Optionally based on a regex. Read the documentation of the :mod:`re` module for more + information. Warning: * When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom From 905654ccef155144d3c21a06738f41168040385f Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 27 Apr 2022 18:14:15 +0530 Subject: [PATCH 07/19] attempt to add telegram group group logo in footer --- docs/source/conf.py | 19 +++++++++++++++++++ telegram/ext/_inlinequeryhandler.py | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index bc14a028df1..c8637efd75a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -159,6 +159,25 @@ 'carefully and also check out the transition guide in the ' 'wiki.', + + "footer_icons": { + "name": "Telegram", + "url": "https://t.me/pythontelegrambotgroup/", + # Following svg is from https://react-icons.github.io/react-icons/search?q=telegram + "html": ''\ + '' \ + , + "class": "" + } } # Add any paths that contain custom themes here, relative to this directory. diff --git a/telegram/ext/_inlinequeryhandler.py b/telegram/ext/_inlinequeryhandler.py index 74b8040ce13..37db3f4d08f 100644 --- a/telegram/ext/_inlinequeryhandler.py +++ b/telegram/ext/_inlinequeryhandler.py @@ -43,7 +43,7 @@ class InlineQueryHandler(Handler[Update, CCT]): """ - Handler class to handle Telegram updates that contain a :attr:`Update.inline_query`. + Handler class to handle Telegram updates that contain a :attr:`telegram.Update.inline_query`. Optionally based on a regex. Read the documentation of the :mod:`re` module for more information. From 93ba835da7d9a0ba7dc204a5b516df80b8c20631 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 27 Apr 2022 18:34:37 +0530 Subject: [PATCH 08/19] fix telegram icon and also re-add github icon --- docs/source/conf.py | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index c8637efd75a..47cf2712a32 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,7 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '4.3.2' +needs_sphinx = '4.5.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -147,8 +147,7 @@ html_theme = 'furo' # Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. +# further. For a list of options available for each theme, see the documentation. html_theme_options = { 'navigation_with_keys': True, 'dark_css_variables': {'admonition-title-font-size': '0.95rem', @@ -159,8 +158,9 @@ 'carefully and also check out the transition guide in the ' 'wiki.', - - "footer_icons": { + + "footer_icons":[{ + # Telegram group logo "name": "Telegram", "url": "https://t.me/pythontelegrambotgroup/", # Following svg is from https://react-icons.github.io/react-icons/search?q=telegram @@ -176,8 +176,25 @@ '1.426 0 0 0-.013-.315.337.337 0 0 0-.114-.217.526.526 0 0 0-.31-.093c-.3.005-.7' \ '63.166-2.984 1.09z">' \ , - "class": "" - } + "class": "" + }, + { # Github logo + "name": "GitHub", + "url": "https://github.com/python-telegram-bot/python-telegram-bot", + "html": '' \ + ''\ + , + "class": "", + }, + ] } # Add any paths that contain custom themes here, relative to this directory. From 303502611510f344aea36e3e8c02f8b82f367be2 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 27 Apr 2022 18:57:11 +0530 Subject: [PATCH 09/19] add icon to ptb website and change tg link to channel --- docs/source/conf.py | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 47cf2712a32..34907b7c3f2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -160,9 +160,9 @@ 'Transition-guide-to-Version-20.0">wiki.', "footer_icons":[{ - # Telegram group logo - "name": "Telegram", - "url": "https://t.me/pythontelegrambotgroup/", + # Telegram channel logo + "name": "Telegram Channel", + "url": "https://t.me/pythontelegrambotchannel/", # Following svg is from https://react-icons.github.io/react-icons/search?q=telegram "html": ''\ @@ -180,7 +180,7 @@ }, { # Github logo "name": "GitHub", - "url": "https://github.com/python-telegram-bot/python-telegram-bot", + "url": "https://github.com/python-telegram-bot/python-telegram-bot/", "html": ''\ + '', + "class": "", + } ] } From 045b787a400ab8543b5f69e0eddfa4a2b4efdac9 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Wed, 27 Apr 2022 20:49:46 +0200 Subject: [PATCH 10/19] Pimp sidebar and fix heading levels in contrib guide --- .github/CONTRIBUTING.rst | 21 +++++++++++---------- docs/source/contributing.rst | 1 + docs/source/index.rst | 15 +++++++++------ 3 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 docs/source/contributing.rst diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index e34cb1dd76b..9e57a275e3e 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -1,10 +1,11 @@ +================= How To Contribute ================= Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation. Setting things up ------------------ +================= 1. Fork the ``python-telegram-bot`` repository to your GitHub account. @@ -35,7 +36,7 @@ Setting things up $ pre-commit install Finding something to do -####################### +======================= If you already know what you'd like to work on, you can skip this section. @@ -46,7 +47,7 @@ Another great way to start contributing is by writing tests. Tests are really im That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers. Instructions for making a code change -##################################### +===================================== The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``. @@ -93,13 +94,13 @@ Here's how to make a one-off code change. - Before making a commit ensure that all automated tests still pass: - .. code-block:: + .. code-block:: bash $ pytest -v To run ``test_official`` (particularly useful if you made API changes), run - .. code-block:: + .. code-block:: bash $ export TEST_OFFICIAL=true @@ -107,7 +108,7 @@ Here's how to make a one-off code change. - If you want run style & type checks before committing run - .. code-block:: + .. code-block:: bash $ pre-commit run -a @@ -208,10 +209,10 @@ for new to make relevant changes if said lines don't do what they are supposed t Style commandments ------------------- +================== Assert comparison order -####################### +----------------------- Assert statements should compare in **actual** == **expected** order. For example (assuming ``test_call`` is the thing being tested): @@ -225,7 +226,7 @@ For example (assuming ``test_call`` is the thing being tested): assert 5 == test_call() Properly calling callables -########################## +-------------------------- Methods, functions and classes can specify optional parameters (with default values) using Python's keyword arg syntax. When providing a value to such a @@ -243,7 +244,7 @@ This gives us the flexibility to re-order arguments and more importantly to add new required arguments. It's also more explicit and easier to read. Properly defining optional arguments -#################################### +------------------------------------ It's always good to not initialize optional arguments at class creation, instead use ``**kwargs`` to get them. It's well known Telegram API can diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 00000000000..03db3edaab1 --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../.github/CONTRIBUTING.rst \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 3172b732007..c8778554754 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,19 +8,22 @@ .. The toctrees are hidden such that they don't reander on the start page but still include the contents into the documentation. .. toctree:: - telegram :hidden: + :caption: Reference -.. toctree:: + telegram telegram.ext - :hidden: + telegram_auxil .. toctree:: - telegram_auxil :hidden: + :caption: Project -.. toctree:: changelog - :hidden: + contributing + Website + Telegram Channel + Telegram User Group + Code of Conduct From 2447df337f460104425f7a907f7f533d84ee2ee6 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Wed, 27 Apr 2022 20:52:14 +0200 Subject: [PATCH 11/19] tiny html_title fix --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 34907b7c3f2..9097ba33a52 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -231,7 +231,7 @@ # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = f"python-telegram-bot
v{version}" +html_title = f"python-telegram-bot
v{version}" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None From 885b550ac735ed037c6fb505cf2b2b28c8ac88d2 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Wed, 27 Apr 2022 21:58:42 +0200 Subject: [PATCH 12/19] remove all the :github_url: directives b/c furo doesn't support them anyway --- docs/source/telegram.animation.rst | 2 -- docs/source/telegram.audio.rst | 2 -- docs/source/telegram.bot.rst | 2 -- docs/source/telegram.botcommand.rst | 2 -- docs/source/telegram.botcommandscope.rst | 2 -- docs/source/telegram.botcommandscopeallchatadministrators.rst | 2 -- docs/source/telegram.botcommandscopeallgroupchats.rst | 2 -- docs/source/telegram.botcommandscopeallprivatechats.rst | 2 -- docs/source/telegram.botcommandscopechat.rst | 2 -- docs/source/telegram.botcommandscopechatadministrators.rst | 2 -- docs/source/telegram.botcommandscopechatmember.rst | 2 -- docs/source/telegram.botcommandscopedefault.rst | 2 -- docs/source/telegram.callbackgame.rst | 2 -- docs/source/telegram.callbackquery.rst | 2 -- docs/source/telegram.chat.rst | 2 -- docs/source/telegram.chatinvitelink.rst | 2 -- docs/source/telegram.chatjoinrequest.rst | 2 -- docs/source/telegram.chatlocation.rst | 2 -- docs/source/telegram.chatmember.rst | 2 -- docs/source/telegram.chatmemberadministrator.rst | 2 -- docs/source/telegram.chatmemberbanned.rst | 2 -- docs/source/telegram.chatmemberleft.rst | 2 -- docs/source/telegram.chatmembermember.rst | 2 -- docs/source/telegram.chatmemberowner.rst | 2 -- docs/source/telegram.chatmemberrestricted.rst | 2 -- docs/source/telegram.chatmemberupdated.rst | 2 -- docs/source/telegram.chatpermissions.rst | 2 -- docs/source/telegram.chatphoto.rst | 2 -- docs/source/telegram.choseninlineresult.rst | 2 -- docs/source/telegram.constants.rst | 2 -- docs/source/telegram.contact.rst | 2 -- docs/source/telegram.credentials.rst | 2 -- docs/source/telegram.datacredentials.rst | 2 -- docs/source/telegram.dice.rst | 2 -- docs/source/telegram.document.rst | 2 -- docs/source/telegram.encryptedcredentials.rst | 2 -- docs/source/telegram.encryptedpassportelement.rst | 2 -- docs/source/telegram.error.rst | 2 -- docs/source/telegram.ext.application.rst | 2 -- docs/source/telegram.ext.applicationbuilder.rst | 2 -- docs/source/telegram.ext.applicationhandlerstop.rst | 2 -- docs/source/telegram.ext.basepersistence.rst | 2 -- docs/source/telegram.ext.callbackcontext.rst | 2 -- docs/source/telegram.ext.callbackdatacache.rst | 2 -- docs/source/telegram.ext.callbackqueryhandler.rst | 2 -- docs/source/telegram.ext.chatjoinrequesthandler.rst | 2 -- docs/source/telegram.ext.chatmemberhandler.rst | 2 -- docs/source/telegram.ext.choseninlineresulthandler.rst | 2 -- docs/source/telegram.ext.commandhandler.rst | 2 -- docs/source/telegram.ext.contexttypes.rst | 2 -- docs/source/telegram.ext.conversationhandler.rst | 2 -- docs/source/telegram.ext.defaults.rst | 2 -- docs/source/telegram.ext.dictpersistence.rst | 2 -- docs/source/telegram.ext.extbot.rst | 2 -- docs/source/telegram.ext.filters.rst | 2 -- docs/source/telegram.ext.handler.rst | 2 -- docs/source/telegram.ext.inlinequeryhandler.rst | 2 -- docs/source/telegram.ext.invalidcallbackdata.rst | 2 -- docs/source/telegram.ext.job.rst | 2 -- docs/source/telegram.ext.jobqueue.rst | 2 -- docs/source/telegram.ext.messagehandler.rst | 2 -- docs/source/telegram.ext.persistenceinput.rst | 2 -- docs/source/telegram.ext.picklepersistence.rst | 2 -- docs/source/telegram.ext.pollanswerhandler.rst | 2 -- docs/source/telegram.ext.pollhandler.rst | 2 -- docs/source/telegram.ext.precheckoutqueryhandler.rst | 2 -- docs/source/telegram.ext.prefixhandler.rst | 2 -- docs/source/telegram.ext.shippingqueryhandler.rst | 2 -- docs/source/telegram.ext.stringcommandhandler.rst | 2 -- docs/source/telegram.ext.stringregexhandler.rst | 2 -- docs/source/telegram.ext.typehandler.rst | 2 -- docs/source/telegram.ext.updater.rst | 2 -- docs/source/telegram.file.rst | 2 -- docs/source/telegram.filecredentials.rst | 2 -- docs/source/telegram.forcereply.rst | 2 -- docs/source/telegram.game.rst | 2 -- docs/source/telegram.gamehighscore.rst | 2 -- docs/source/telegram.helpers.rst | 2 -- docs/source/telegram.iddocumentdata.rst | 2 -- docs/source/telegram.inlinekeyboardbutton.rst | 2 -- docs/source/telegram.inlinekeyboardmarkup.rst | 2 -- docs/source/telegram.inlinequery.rst | 2 -- docs/source/telegram.inlinequeryresult.rst | 2 -- docs/source/telegram.inlinequeryresultarticle.rst | 2 -- docs/source/telegram.inlinequeryresultaudio.rst | 2 -- docs/source/telegram.inlinequeryresultcachedaudio.rst | 2 -- docs/source/telegram.inlinequeryresultcacheddocument.rst | 2 -- docs/source/telegram.inlinequeryresultcachedgif.rst | 2 -- docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst | 2 -- docs/source/telegram.inlinequeryresultcachedphoto.rst | 2 -- docs/source/telegram.inlinequeryresultcachedsticker.rst | 2 -- docs/source/telegram.inlinequeryresultcachedvideo.rst | 2 -- docs/source/telegram.inlinequeryresultcachedvoice.rst | 2 -- docs/source/telegram.inlinequeryresultcontact.rst | 2 -- docs/source/telegram.inlinequeryresultdocument.rst | 2 -- docs/source/telegram.inlinequeryresultgame.rst | 2 -- docs/source/telegram.inlinequeryresultgif.rst | 2 -- docs/source/telegram.inlinequeryresultlocation.rst | 2 -- docs/source/telegram.inlinequeryresultmpeg4gif.rst | 2 -- docs/source/telegram.inlinequeryresultphoto.rst | 2 -- docs/source/telegram.inlinequeryresultvenue.rst | 2 -- docs/source/telegram.inlinequeryresultvideo.rst | 2 -- docs/source/telegram.inlinequeryresultvoice.rst | 2 -- docs/source/telegram.inputcontactmessagecontent.rst | 2 -- docs/source/telegram.inputfile.rst | 2 -- docs/source/telegram.inputinvoicemessagecontent.rst | 2 -- docs/source/telegram.inputlocationmessagecontent.rst | 2 -- docs/source/telegram.inputmedia.rst | 2 -- docs/source/telegram.inputmediaanimation.rst | 2 -- docs/source/telegram.inputmediaaudio.rst | 2 -- docs/source/telegram.inputmediadocument.rst | 2 -- docs/source/telegram.inputmediaphoto.rst | 2 -- docs/source/telegram.inputmediavideo.rst | 2 -- docs/source/telegram.inputmessagecontent.rst | 2 -- docs/source/telegram.inputtextmessagecontent.rst | 2 -- docs/source/telegram.inputvenuemessagecontent.rst | 2 -- docs/source/telegram.invoice.rst | 2 -- docs/source/telegram.keyboardbutton.rst | 2 -- docs/source/telegram.keyboardbuttonpolltype.rst | 2 -- docs/source/telegram.labeledprice.rst | 2 -- docs/source/telegram.location.rst | 2 -- docs/source/telegram.loginurl.rst | 2 -- docs/source/telegram.maskposition.rst | 2 -- docs/source/telegram.message.rst | 2 -- docs/source/telegram.messageautodeletetimerchanged.rst | 2 -- docs/source/telegram.messageentity.rst | 2 -- docs/source/telegram.messageid.rst | 2 -- docs/source/telegram.orderinfo.rst | 2 -- docs/source/telegram.passportdata.rst | 2 -- docs/source/telegram.passportelementerror.rst | 2 -- docs/source/telegram.passportelementerrordatafield.rst | 2 -- docs/source/telegram.passportelementerrorfile.rst | 2 -- docs/source/telegram.passportelementerrorfiles.rst | 2 -- docs/source/telegram.passportelementerrorfrontside.rst | 2 -- docs/source/telegram.passportelementerrorreverseside.rst | 2 -- docs/source/telegram.passportelementerrorselfie.rst | 2 -- docs/source/telegram.passportelementerrortranslationfile.rst | 2 -- docs/source/telegram.passportelementerrortranslationfiles.rst | 2 -- docs/source/telegram.passportelementerrorunspecified.rst | 2 -- docs/source/telegram.passportfile.rst | 2 -- docs/source/telegram.personaldetails.rst | 2 -- docs/source/telegram.photosize.rst | 2 -- docs/source/telegram.poll.rst | 2 -- docs/source/telegram.pollanswer.rst | 2 -- docs/source/telegram.polloption.rst | 2 -- docs/source/telegram.precheckoutquery.rst | 2 -- docs/source/telegram.proximityalerttriggered.rst | 2 -- docs/source/telegram.replykeyboardmarkup.rst | 2 -- docs/source/telegram.replykeyboardremove.rst | 2 -- docs/source/telegram.request.baserequest.rst | 2 -- docs/source/telegram.request.httpxrequest.rst | 2 -- docs/source/telegram.request.requestdata.rst | 2 -- docs/source/telegram.request.rst | 2 -- docs/source/telegram.residentialaddress.rst | 2 -- docs/source/telegram.securedata.rst | 2 -- docs/source/telegram.securevalue.rst | 2 -- docs/source/telegram.shippingaddress.rst | 2 -- docs/source/telegram.shippingoption.rst | 2 -- docs/source/telegram.shippingquery.rst | 2 -- docs/source/telegram.sticker.rst | 2 -- docs/source/telegram.stickerset.rst | 2 -- docs/source/telegram.successfulpayment.rst | 2 -- docs/source/telegram.telegramobject.rst | 2 -- docs/source/telegram.update.rst | 2 -- docs/source/telegram.user.rst | 2 -- docs/source/telegram.userprofilephotos.rst | 2 -- docs/source/telegram.venue.rst | 2 -- docs/source/telegram.video.rst | 2 -- docs/source/telegram.videonote.rst | 2 -- docs/source/telegram.voice.rst | 2 -- docs/source/telegram.voicechatended.rst | 2 -- docs/source/telegram.voicechatparticipantsinvited.rst | 2 -- docs/source/telegram.voicechatscheduled.rst | 2 -- docs/source/telegram.voicechatstarted.rst | 2 -- docs/source/telegram.warnings.rst | 2 -- docs/source/telegram.webhookinfo.rst | 2 -- 176 files changed, 352 deletions(-) diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 908e824e9e7..05776f0fc7f 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/animation.py - telegram.Animation ================== diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 09065d8fe66..ae4928eca31 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/audio.py - telegram.Audio ============== diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst index 9869dedc1d2..6b620b5fb21 100644 --- a/docs/source/telegram.bot.rst +++ b/docs/source/telegram.bot.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/bot.py - telegram.Bot ============ diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst index 26dece6ad36..9ceb402c5b3 100644 --- a/docs/source/telegram.botcommand.rst +++ b/docs/source/telegram.botcommand.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommand.py - telegram.BotCommand =================== diff --git a/docs/source/telegram.botcommandscope.rst b/docs/source/telegram.botcommandscope.rst index 6257125203f..0cbbca97d73 100644 --- a/docs/source/telegram.botcommandscope.rst +++ b/docs/source/telegram.botcommandscope.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScope ======================== diff --git a/docs/source/telegram.botcommandscopeallchatadministrators.rst b/docs/source/telegram.botcommandscopeallchatadministrators.rst index fa30ce538b3..e77bb09879e 100644 --- a/docs/source/telegram.botcommandscopeallchatadministrators.rst +++ b/docs/source/telegram.botcommandscopeallchatadministrators.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllChatAdministrators ============================================= diff --git a/docs/source/telegram.botcommandscopeallgroupchats.rst b/docs/source/telegram.botcommandscopeallgroupchats.rst index 2c4f672eb60..c00d78380ad 100644 --- a/docs/source/telegram.botcommandscopeallgroupchats.rst +++ b/docs/source/telegram.botcommandscopeallgroupchats.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllGroupChats ======================================= diff --git a/docs/source/telegram.botcommandscopeallprivatechats.rst b/docs/source/telegram.botcommandscopeallprivatechats.rst index 91ea4d034a9..c63bf9039d6 100644 --- a/docs/source/telegram.botcommandscopeallprivatechats.rst +++ b/docs/source/telegram.botcommandscopeallprivatechats.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllPrivateChats ======================================= diff --git a/docs/source/telegram.botcommandscopechat.rst b/docs/source/telegram.botcommandscopechat.rst index dd779542811..cd54df932c5 100644 --- a/docs/source/telegram.botcommandscopechat.rst +++ b/docs/source/telegram.botcommandscopechat.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChat ============================ diff --git a/docs/source/telegram.botcommandscopechatadministrators.rst b/docs/source/telegram.botcommandscopechatadministrators.rst index 68cb1328289..7e47342938f 100644 --- a/docs/source/telegram.botcommandscopechatadministrators.rst +++ b/docs/source/telegram.botcommandscopechatadministrators.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChatAdministrators ========================================== diff --git a/docs/source/telegram.botcommandscopechatmember.rst b/docs/source/telegram.botcommandscopechatmember.rst index e28105179e9..c86175c80e8 100644 --- a/docs/source/telegram.botcommandscopechatmember.rst +++ b/docs/source/telegram.botcommandscopechatmember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChatMember ================================== diff --git a/docs/source/telegram.botcommandscopedefault.rst b/docs/source/telegram.botcommandscopedefault.rst index 2705a734c15..cbf90cfe350 100644 --- a/docs/source/telegram.botcommandscopedefault.rst +++ b/docs/source/telegram.botcommandscopedefault.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeDefault =============================== diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst index e2facc41e3d..6fa11ded81e 100644 --- a/docs/source/telegram.callbackgame.rst +++ b/docs/source/telegram.callbackgame.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/callbackgame.py - telegram.Callbackgame ===================== diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst index b628b02368f..297189aaf4d 100644 --- a/docs/source/telegram.callbackquery.rst +++ b/docs/source/telegram.callbackquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackquery.py - telegram.CallbackQuery ====================== diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index 7347e5d1322..cd04bb87b84 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chat.py - telegram.Chat ============= diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst index e85f97fb69c..ca24e5340ba 100644 --- a/docs/source/telegram.chatinvitelink.rst +++ b/docs/source/telegram.chatinvitelink.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatinvitelink.py - telegram.ChatInviteLink ======================= diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst index 4011738459d..e1450cc1060 100644 --- a/docs/source/telegram.chatjoinrequest.rst +++ b/docs/source/telegram.chatjoinrequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatjoinrequest.py - telegram.ChatJoinRequest ======================== diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst index dd0c2f006ef..8994d138e2d 100644 --- a/docs/source/telegram.chatlocation.rst +++ b/docs/source/telegram.chatlocation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatlocation.py - telegram.ChatLocation ===================== diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst index 2aa4a58f2ec..7bba9e4489f 100644 --- a/docs/source/telegram.chatmember.rst +++ b/docs/source/telegram.chatmember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMember =================== diff --git a/docs/source/telegram.chatmemberadministrator.rst b/docs/source/telegram.chatmemberadministrator.rst index ac510865175..62a56f183de 100644 --- a/docs/source/telegram.chatmemberadministrator.rst +++ b/docs/source/telegram.chatmemberadministrator.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberAdministrator ================================ diff --git a/docs/source/telegram.chatmemberbanned.rst b/docs/source/telegram.chatmemberbanned.rst index 168c2df9675..15f5ff2db85 100644 --- a/docs/source/telegram.chatmemberbanned.rst +++ b/docs/source/telegram.chatmemberbanned.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberBanned ========================= diff --git a/docs/source/telegram.chatmemberleft.rst b/docs/source/telegram.chatmemberleft.rst index 6840063c618..6a0ca2b15e7 100644 --- a/docs/source/telegram.chatmemberleft.rst +++ b/docs/source/telegram.chatmemberleft.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberLeft ======================= diff --git a/docs/source/telegram.chatmembermember.rst b/docs/source/telegram.chatmembermember.rst index 7e2d8293be9..55ca6fe99f8 100644 --- a/docs/source/telegram.chatmembermember.rst +++ b/docs/source/telegram.chatmembermember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberMember ========================= diff --git a/docs/source/telegram.chatmemberowner.rst b/docs/source/telegram.chatmemberowner.rst index 784cb644a1a..03f162a7f90 100644 --- a/docs/source/telegram.chatmemberowner.rst +++ b/docs/source/telegram.chatmemberowner.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberOwner ======================== diff --git a/docs/source/telegram.chatmemberrestricted.rst b/docs/source/telegram.chatmemberrestricted.rst index cd76611fdf8..957414ed389 100644 --- a/docs/source/telegram.chatmemberrestricted.rst +++ b/docs/source/telegram.chatmemberrestricted.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberRestricted ============================= diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst index c5c14126055..d6feecc442f 100644 --- a/docs/source/telegram.chatmemberupdated.rst +++ b/docs/source/telegram.chatmemberupdated.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmemberupdated.py - telegram.ChatMemberUpdated ========================== diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst index bb180946dda..7cefdbc23e2 100644 --- a/docs/source/telegram.chatpermissions.rst +++ b/docs/source/telegram.chatpermissions.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatpermissions.py - telegram.ChatPermissions ======================== diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst index 22a9aaad322..4ab6ae0a2f2 100644 --- a/docs/source/telegram.chatphoto.rst +++ b/docs/source/telegram.chatphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/chatphoto.py - telegram.ChatPhoto ================== diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst index cb997a913c5..d60547d4bb4 100644 --- a/docs/source/telegram.choseninlineresult.rst +++ b/docs/source/telegram.choseninlineresult.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/choseninlineresult.py - telegram.ChosenInlineResult =========================== diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index a223a220b18..1249514650f 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/constants.py - telegram.constants Module ========================= diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst index 345c00584a7..f38079be98d 100644 --- a/docs/source/telegram.contact.rst +++ b/docs/source/telegram.contact.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/contact.py - telegram.Contact ================ diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst index 59f4f36e4a3..6a3fe39e17b 100644 --- a/docs/source/telegram.credentials.rst +++ b/docs/source/telegram.credentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.Credentials ==================== diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst index 51d85455fd2..b0916762ee4 100644 --- a/docs/source/telegram.datacredentials.rst +++ b/docs/source/telegram.datacredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.DataCredentials ======================== diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst index 29dedd5b580..6e80f6d485d 100644 --- a/docs/source/telegram.dice.rst +++ b/docs/source/telegram.dice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/dice.py - telegram.Dice ============= diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index ac492ff484e..83db9ffa03c 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/document.py - telegram.Document ================= .. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst index 096efbcc03c..d4285143664 100644 --- a/docs/source/telegram.encryptedcredentials.rst +++ b/docs/source/telegram.encryptedcredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.EncryptedCredentials ============================= diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst index 5a9693be3c3..f2296360149 100644 --- a/docs/source/telegram.encryptedpassportelement.rst +++ b/docs/source/telegram.encryptedpassportelement.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/encryptedpassportelement.py - telegram.EncryptedPassportElement ================================= diff --git a/docs/source/telegram.error.rst b/docs/source/telegram.error.rst index b2fd1f4d61a..c5cd7aee0de 100644 --- a/docs/source/telegram.error.rst +++ b/docs/source/telegram.error.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/error.py - telegram.error Module ===================== diff --git a/docs/source/telegram.ext.application.rst b/docs/source/telegram.ext.application.rst index b2fc8ff4113..722340ea8e8 100644 --- a/docs/source/telegram.ext.application.rst +++ b/docs/source/telegram.ext.application.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_application.py - telegram.ext.Application ======================== diff --git a/docs/source/telegram.ext.applicationbuilder.rst b/docs/source/telegram.ext.applicationbuilder.rst index cff3899c492..a5e7d61260d 100644 --- a/docs/source/telegram.ext.applicationbuilder.rst +++ b/docs/source/telegram.ext.applicationbuilder.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_applicationbuilder.py - telegram.ext.ApplicationBuilder =============================== diff --git a/docs/source/telegram.ext.applicationhandlerstop.rst b/docs/source/telegram.ext.applicationhandlerstop.rst index b2ee0c6ed31..fe2feb9d213 100644 --- a/docs/source/telegram.ext.applicationhandlerstop.rst +++ b/docs/source/telegram.ext.applicationhandlerstop.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_application.py - telegram.ext.ApplicationHandlerStop =================================== diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst index 178d95a8073..013c052d8c1 100644 --- a/docs/source/telegram.ext.basepersistence.rst +++ b/docs/source/telegram.ext.basepersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py - telegram.ext.BasePersistence ============================ diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst index bd5ff3706cf..36487931805 100644 --- a/docs/source/telegram.ext.callbackcontext.rst +++ b/docs/source/telegram.ext.callbackcontext.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackcontext.py - telegram.ext.CallbackContext ============================ diff --git a/docs/source/telegram.ext.callbackdatacache.rst b/docs/source/telegram.ext.callbackdatacache.rst index e1467e02a32..96dbedd9f97 100644 --- a/docs/source/telegram.ext.callbackdatacache.rst +++ b/docs/source/telegram.ext.callbackdatacache.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackdatacache.py - telegram.ext.CallbackDataCache ============================== diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst index 8f72eecb23f..4e876e41306 100644 --- a/docs/source/telegram.ext.callbackqueryhandler.rst +++ b/docs/source/telegram.ext.callbackqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackqueryhandler.py - telegram.ext.CallbackQueryHandler ================================= diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst index 650ff1b35c0..e36596b4a9c 100644 --- a/docs/source/telegram.ext.chatjoinrequesthandler.rst +++ b/docs/source/telegram.ext.chatjoinrequesthandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatjoinrequesthandler.py - telegram.ext.ChatJoinRequestHandler =================================== diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst index 97601495911..59675b9547a 100644 --- a/docs/source/telegram.ext.chatmemberhandler.rst +++ b/docs/source/telegram.ext.chatmemberhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatmemberhandler.py - telegram.ext.ChatMemberHandler ============================== diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst index 8ada326a611..e415c2d7ebd 100644 --- a/docs/source/telegram.ext.choseninlineresulthandler.rst +++ b/docs/source/telegram.ext.choseninlineresulthandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/choseninlineresulthandler.py - telegram.ext.ChosenInlineResultHandler ====================================== diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst index 4b8d869e9f6..a892d3ca89d 100644 --- a/docs/source/telegram.ext.commandhandler.rst +++ b/docs/source/telegram.ext.commandhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py - telegram.ext.CommandHandler =========================== diff --git a/docs/source/telegram.ext.contexttypes.rst b/docs/source/telegram.ext.contexttypes.rst index d0cc0a29a1d..28f3e31a766 100644 --- a/docs/source/telegram.ext.contexttypes.rst +++ b/docs/source/telegram.ext.contexttypes.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/contexttypes.py - telegram.ext.ContextTypes ========================= diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst index 2f5007d159a..aa4bac815d0 100644 --- a/docs/source/telegram.ext.conversationhandler.rst +++ b/docs/source/telegram.ext.conversationhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/conversationhandler.py - telegram.ext.ConversationHandler ================================ diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst index 66a3387049d..d08a6ed5c12 100644 --- a/docs/source/telegram.ext.defaults.rst +++ b/docs/source/telegram.ext.defaults.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/defaults.py - telegram.ext.Defaults ===================== diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst index 95ea3ef3f27..08b78de3764 100644 --- a/docs/source/telegram.ext.dictpersistence.rst +++ b/docs/source/telegram.ext.dictpersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dictpersistence.py - telegram.ext.DictPersistence ============================ diff --git a/docs/source/telegram.ext.extbot.rst b/docs/source/telegram.ext.extbot.rst index a295f2aa4b3..d0e85027cc0 100644 --- a/docs/source/telegram.ext.extbot.rst +++ b/docs/source/telegram.ext.extbot.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/extbot.py - telegram.ext.ExtBot =================== diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst index 8eb415771f4..d332480cd7b 100644 --- a/docs/source/telegram.ext.filters.rst +++ b/docs/source/telegram.ext.filters.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/filters.py - telegram.ext.filters Module =========================== diff --git a/docs/source/telegram.ext.handler.rst b/docs/source/telegram.ext.handler.rst index 065cbba98f1..45822d22346 100644 --- a/docs/source/telegram.ext.handler.rst +++ b/docs/source/telegram.ext.handler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/handler.py - telegram.ext.Handler ==================== diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst index ea2ddeaf748..5b249c9fa1d 100644 --- a/docs/source/telegram.ext.inlinequeryhandler.rst +++ b/docs/source/telegram.ext.inlinequeryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/inlinequeryhandler.py - telegram.ext.InlineQueryHandler =============================== diff --git a/docs/source/telegram.ext.invalidcallbackdata.rst b/docs/source/telegram.ext.invalidcallbackdata.rst index 58588d1feef..b19bed91c33 100644 --- a/docs/source/telegram.ext.invalidcallbackdata.rst +++ b/docs/source/telegram.ext.invalidcallbackdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackdatacache.py - telegram.ext.InvalidCallbackData ================================ diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst index d6c4f69146c..c150bc37c8c 100644 --- a/docs/source/telegram.ext.job.rst +++ b/docs/source/telegram.ext.job.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py - telegram.ext.Job ===================== diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst index ec5f98398f2..080d64226e9 100644 --- a/docs/source/telegram.ext.jobqueue.rst +++ b/docs/source/telegram.ext.jobqueue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py - telegram.ext.JobQueue ===================== diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst index 262c1aa0665..2d1ca39bf5a 100644 --- a/docs/source/telegram.ext.messagehandler.rst +++ b/docs/source/telegram.ext.messagehandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagehandler.py - telegram.ext.MessageHandler =========================== diff --git a/docs/source/telegram.ext.persistenceinput.rst b/docs/source/telegram.ext.persistenceinput.rst index ea5a0b38c83..b2d491979e4 100644 --- a/docs/source/telegram.ext.persistenceinput.rst +++ b/docs/source/telegram.ext.persistenceinput.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py - telegram.ext.PersistenceInput ============================= diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst index fc1dcd7a5c4..f8691b1815a 100644 --- a/docs/source/telegram.ext.picklepersistence.rst +++ b/docs/source/telegram.ext.picklepersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/picklepersistence.py - telegram.ext.PicklePersistence ============================== diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst index fa049fa9f27..5113f135e82 100644 --- a/docs/source/telegram.ext.pollanswerhandler.rst +++ b/docs/source/telegram.ext.pollanswerhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollanswerhandler.py - telegram.ext.PollAnswerHandler ============================== diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst index 14a9d003a52..da30d879fc4 100644 --- a/docs/source/telegram.ext.pollhandler.rst +++ b/docs/source/telegram.ext.pollhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollhandler.py - telegram.ext.PollHandler ======================== diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst index c7138853dae..28fe9d49ad3 100644 --- a/docs/source/telegram.ext.precheckoutqueryhandler.rst +++ b/docs/source/telegram.ext.precheckoutqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/precheckoutqueryhandler.py - telegram.ext.PreCheckoutQueryHandler ==================================== diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst index d61e3589298..18fb2be1444 100644 --- a/docs/source/telegram.ext.prefixhandler.rst +++ b/docs/source/telegram.ext.prefixhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py - telegram.ext.PrefixHandler =========================== diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst index 013ef57b846..7da2992b94d 100644 --- a/docs/source/telegram.ext.shippingqueryhandler.rst +++ b/docs/source/telegram.ext.shippingqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/shippingqueryhandler.py - telegram.ext.ShippingQueryHandler ================================= diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst index 5fe5dc82bbb..57ed1710e47 100644 --- a/docs/source/telegram.ext.stringcommandhandler.rst +++ b/docs/source/telegram.ext.stringcommandhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringcommandhandler.py - telegram.ext.StringCommandHandler ================================= diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst index 127239db9d6..621d9b7324b 100644 --- a/docs/source/telegram.ext.stringregexhandler.rst +++ b/docs/source/telegram.ext.stringregexhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringregexhandler.py - telegram.ext.StringRegexHandler =============================== diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst index 49dfbbf1127..05ebd4ee3ef 100644 --- a/docs/source/telegram.ext.typehandler.rst +++ b/docs/source/telegram.ext.typehandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/typehandler.py - telegram.ext.TypeHandler ======================== diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst index dcd8ce4c061..2a52132d74c 100644 --- a/docs/source/telegram.ext.updater.rst +++ b/docs/source/telegram.ext.updater.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/updater.py - telegram.ext.Updater ==================== diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst index 8db85d86d16..f04d547abae 100644 --- a/docs/source/telegram.file.rst +++ b/docs/source/telegram.file.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/file.py - telegram.File ============= diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst index bc2d88e779d..600661e5042 100644 --- a/docs/source/telegram.filecredentials.rst +++ b/docs/source/telegram.filecredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.FileCredentials ======================== diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst index 2ee8edce872..75bfc166a05 100644 --- a/docs/source/telegram.forcereply.rst +++ b/docs/source/telegram.forcereply.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/forcereply.py - telegram.ForceReply =================== diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst index c6f2c51c1e7..ada1140d560 100644 --- a/docs/source/telegram.game.rst +++ b/docs/source/telegram.game.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/game.py - telegram.Game ============= diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst index 84528bdb951..c69c7fe1dfa 100644 --- a/docs/source/telegram.gamehighscore.rst +++ b/docs/source/telegram.gamehighscore.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/gamehighscore.py - telegram.GameHighScore ====================== diff --git a/docs/source/telegram.helpers.rst b/docs/source/telegram.helpers.rst index f75937653a3..7d589f3e346 100644 --- a/docs/source/telegram.helpers.rst +++ b/docs/source/telegram.helpers.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/helpers.py - telegram.helpers Module ======================= diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst index 85c32271ace..1333f7ed4a3 100644 --- a/docs/source/telegram.iddocumentdata.rst +++ b/docs/source/telegram.iddocumentdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.IdDocumentData ======================= diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst index dde7af030ca..9a118a75c25 100644 --- a/docs/source/telegram.inlinekeyboardbutton.rst +++ b/docs/source/telegram.inlinekeyboardbutton.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardbutton.py - telegram.InlineKeyboardButton ============================= diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst index 1a41e0d1d4b..63aba46304b 100644 --- a/docs/source/telegram.inlinekeyboardmarkup.rst +++ b/docs/source/telegram.inlinekeyboardmarkup.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardmarkup.py - telegram.InlineKeyboardMarkup ============================= diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst index 00c6566a9b9..ce17a816d77 100644 --- a/docs/source/telegram.inlinequery.rst +++ b/docs/source/telegram.inlinequery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequery.py - telegram.InlineQuery ==================== diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst index 0d9970b1a1d..97e9a97ff3e 100644 --- a/docs/source/telegram.inlinequeryresult.rst +++ b/docs/source/telegram.inlinequeryresult.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresult.py - telegram.InlineQueryResult ========================== diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst index 46ea88cd72d..c8756fdc7b2 100644 --- a/docs/source/telegram.inlinequeryresultarticle.rst +++ b/docs/source/telegram.inlinequeryresultarticle.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultarticle.py - telegram.InlineQueryResultArticle ================================= diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst index 414b437c7f5..83bb5d4527f 100644 --- a/docs/source/telegram.inlinequeryresultaudio.rst +++ b/docs/source/telegram.inlinequeryresultaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultaudio.py - telegram.InlineQueryResultAudio =============================== diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst index 01431917ac8..f7e9929164b 100644 --- a/docs/source/telegram.inlinequeryresultcachedaudio.rst +++ b/docs/source/telegram.inlinequeryresultcachedaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedaudio.py - telegram.InlineQueryResultCachedAudio ===================================== diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst index 5a23a317e04..18db7ba7afa 100644 --- a/docs/source/telegram.inlinequeryresultcacheddocument.rst +++ b/docs/source/telegram.inlinequeryresultcacheddocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcacheddocument.py - telegram.InlineQueryResultCachedDocument ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst index a639991db10..9faaf071a4e 100644 --- a/docs/source/telegram.inlinequeryresultcachedgif.rst +++ b/docs/source/telegram.inlinequeryresultcachedgif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedgif.py - telegram.InlineQueryResultCachedGif =================================== diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst index d98da74344f..1c6406ab554 100644 --- a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedmpeg4gif.py - telegram.InlineQueryResultCachedMpeg4Gif ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst index 882f84ce474..9887210f392 100644 --- a/docs/source/telegram.inlinequeryresultcachedphoto.rst +++ b/docs/source/telegram.inlinequeryresultcachedphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedphoto.py - telegram.InlineQueryResultCachedPhoto ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst index 19872be365c..4b989ddba8d 100644 --- a/docs/source/telegram.inlinequeryresultcachedsticker.rst +++ b/docs/source/telegram.inlinequeryresultcachedsticker.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedsticker.py - telegram.InlineQueryResultCachedSticker ======================================= diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst index 567b86b71b2..49efa7e898d 100644 --- a/docs/source/telegram.inlinequeryresultcachedvideo.rst +++ b/docs/source/telegram.inlinequeryresultcachedvideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvideo.py - telegram.InlineQueryResultCachedVideo ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst index c26bf187246..88a5377c81a 100644 --- a/docs/source/telegram.inlinequeryresultcachedvoice.rst +++ b/docs/source/telegram.inlinequeryresultcachedvoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvoice.py - telegram.InlineQueryResultCachedVoice ===================================== diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst index cd40f9fe858..017ccfbcaa9 100644 --- a/docs/source/telegram.inlinequeryresultcontact.rst +++ b/docs/source/telegram.inlinequeryresultcontact.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcontact.py - telegram.InlineQueryResultContact ================================= diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst index 7cdd4601fde..ec85422603f 100644 --- a/docs/source/telegram.inlinequeryresultdocument.rst +++ b/docs/source/telegram.inlinequeryresultdocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultdocument.py - telegram.InlineQueryResultDocument ================================== diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst index dbc57c9deae..7c6172d8018 100644 --- a/docs/source/telegram.inlinequeryresultgame.rst +++ b/docs/source/telegram.inlinequeryresultgame.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgame.py - telegram.InlineQueryResultGame ============================== diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst index eb02ae7098b..a9c60f14319 100644 --- a/docs/source/telegram.inlinequeryresultgif.rst +++ b/docs/source/telegram.inlinequeryresultgif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgif.py - telegram.InlineQueryResultGif ============================= diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst index 49622306ad9..37980636da4 100644 --- a/docs/source/telegram.inlinequeryresultlocation.rst +++ b/docs/source/telegram.inlinequeryresultlocation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultlocation.py - telegram.InlineQueryResultLocation ================================== diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst index 72d87c82244..ad7e12d473d 100644 --- a/docs/source/telegram.inlinequeryresultmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultmpeg4gif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultmpeg4gif.py - telegram.InlineQueryResultMpeg4Gif ================================== diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst index 9e6edd7f408..40a9f63c3a0 100644 --- a/docs/source/telegram.inlinequeryresultphoto.rst +++ b/docs/source/telegram.inlinequeryresultphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultphoto.py - telegram.InlineQueryResultPhoto =============================== diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst index 50e026353ac..4378ed478c1 100644 --- a/docs/source/telegram.inlinequeryresultvenue.rst +++ b/docs/source/telegram.inlinequeryresultvenue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvenue.py - telegram.InlineQueryResultVenue =============================== diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst index d760dda182c..3cb445fd02b 100644 --- a/docs/source/telegram.inlinequeryresultvideo.rst +++ b/docs/source/telegram.inlinequeryresultvideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvideo.py - telegram.InlineQueryResultVideo =============================== diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst index 2e7c139b3ed..e3efd071794 100644 --- a/docs/source/telegram.inlinequeryresultvoice.rst +++ b/docs/source/telegram.inlinequeryresultvoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvoice.py - telegram.InlineQueryResultVoice =============================== diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst index d26eaebc3b0..3a98e7e9862 100644 --- a/docs/source/telegram.inputcontactmessagecontent.rst +++ b/docs/source/telegram.inputcontactmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputcontactmessagecontent.py - telegram.InputContactMessageContent =================================== diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst index 7462feff4ab..cd55a869c72 100644 --- a/docs/source/telegram.inputfile.rst +++ b/docs/source/telegram.inputfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputfile.py - telegram.InputFile ================== diff --git a/docs/source/telegram.inputinvoicemessagecontent.rst b/docs/source/telegram.inputinvoicemessagecontent.rst index 071d431093d..f19f8c6dae2 100644 --- a/docs/source/telegram.inputinvoicemessagecontent.rst +++ b/docs/source/telegram.inputinvoicemessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputinvoicemessagecontent.py - telegram.InputInvoiceMessageContent =================================== diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst index 40db11ceb9c..b5bc314e266 100644 --- a/docs/source/telegram.inputlocationmessagecontent.rst +++ b/docs/source/telegram.inputlocationmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputlocationmessagecontent.py - telegram.InputLocationMessageContent ==================================== diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst index 5d3e96cf15d..26b9d76eb60 100644 --- a/docs/source/telegram.inputmedia.rst +++ b/docs/source/telegram.inputmedia.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMedia =================== diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst index ca0f302bf8b..b94711b06c9 100644 --- a/docs/source/telegram.inputmediaanimation.rst +++ b/docs/source/telegram.inputmediaanimation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaAnimation ============================ diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst index 9340ae86ee4..5a7a977fc19 100644 --- a/docs/source/telegram.inputmediaaudio.rst +++ b/docs/source/telegram.inputmediaaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaAudio ======================== diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst index 7fa547dedc5..746b15f9a19 100644 --- a/docs/source/telegram.inputmediadocument.rst +++ b/docs/source/telegram.inputmediadocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaDocument =========================== diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst index 11dc5e99d2f..07bfe307f10 100644 --- a/docs/source/telegram.inputmediaphoto.rst +++ b/docs/source/telegram.inputmediaphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaPhoto ======================== diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst index 6f6a128803a..af28e4667e6 100644 --- a/docs/source/telegram.inputmediavideo.rst +++ b/docs/source/telegram.inputmediavideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaVideo ======================== diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst index 26efa6063ff..3745109963a 100644 --- a/docs/source/telegram.inputmessagecontent.rst +++ b/docs/source/telegram.inputmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputmessagecontent.py - telegram.InputMessageContent ============================ diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst index 992f02eedd9..88d7972f4e9 100644 --- a/docs/source/telegram.inputtextmessagecontent.rst +++ b/docs/source/telegram.inputtextmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputtextmessagecontent.py - telegram.InputTextMessageContent ================================ diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst index ba91631e14b..009a39920f8 100644 --- a/docs/source/telegram.inputvenuemessagecontent.rst +++ b/docs/source/telegram.inputvenuemessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputvenuemessagecontent.py - telegram.InputVenueMessageContent ================================= diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst index f5af48a06e2..f38c4e6c7a3 100644 --- a/docs/source/telegram.invoice.rst +++ b/docs/source/telegram.invoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/invoice.py - telegram.Invoice ================ diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst index ccb5b508bcf..cec3de5d77b 100644 --- a/docs/source/telegram.keyboardbutton.rst +++ b/docs/source/telegram.keyboardbutton.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbutton.py - telegram.KeyboardButton ======================= diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst index 1c4ef7f2dfd..fa4315abd71 100644 --- a/docs/source/telegram.keyboardbuttonpolltype.rst +++ b/docs/source/telegram.keyboardbuttonpolltype.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbuttonpolltype.py - telegram.KeyboardButtonPollType =============================== diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst index 046cde062ba..7c9d5668aa5 100644 --- a/docs/source/telegram.labeledprice.rst +++ b/docs/source/telegram.labeledprice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/labeledprice.py - telegram.LabeledPrice ===================== diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst index 22effdd0bce..7d3a62c21dc 100644 --- a/docs/source/telegram.location.rst +++ b/docs/source/telegram.location.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/location.py - telegram.Location ================= diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst index 2a39d661ef9..3f8324d9545 100644 --- a/docs/source/telegram.loginurl.rst +++ b/docs/source/telegram.loginurl.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/loginurl.py - telegram.LoginUrl ================= diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst index f54fb5ea526..d38bb3445f4 100644 --- a/docs/source/telegram.maskposition.rst +++ b/docs/source/telegram.maskposition.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.MaskPosition ===================== diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst index 91e3fe39ae1..97259744c3a 100644 --- a/docs/source/telegram.message.rst +++ b/docs/source/telegram.message.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/message.py - telegram.Message ================ diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst index 3553f7d9fd1..ae1fd5472f6 100644 --- a/docs/source/telegram.messageautodeletetimerchanged.rst +++ b/docs/source/telegram.messageautodeletetimerchanged.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageautodeletetimerchanged.py - telegram.MessageAutoDeleteTimerChanged ====================================== diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst index a9a9c421ed8..9e3fce97b2f 100644 --- a/docs/source/telegram.messageentity.rst +++ b/docs/source/telegram.messageentity.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageentity.py - telegram.MessageEntity ====================== diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst index 1fb90866113..9df1de2a145 100644 --- a/docs/source/telegram.messageid.rst +++ b/docs/source/telegram.messageid.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageid.py - telegram.MessageId ================== diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst index 981768981d0..28741db799c 100644 --- a/docs/source/telegram.orderinfo.rst +++ b/docs/source/telegram.orderinfo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/orderinfo.py - telegram.OrderInfo ================== diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst index 92b033e4046..43a33b56016 100644 --- a/docs/source/telegram.passportdata.rst +++ b/docs/source/telegram.passportdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportdata.py - telegram.PassportData ===================== diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst index b431f05d8ce..00ef430d7e0 100644 --- a/docs/source/telegram.passportelementerror.rst +++ b/docs/source/telegram.passportelementerror.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementError ============================= diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst index 8868e6b15a6..ac304f7b573 100644 --- a/docs/source/telegram.passportelementerrordatafield.rst +++ b/docs/source/telegram.passportelementerrordatafield.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorDataField ====================================== diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst index cb74323302b..339d7a786cc 100644 --- a/docs/source/telegram.passportelementerrorfile.rst +++ b/docs/source/telegram.passportelementerrorfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFile ================================= diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst index a6ed2e4a185..f9643d96935 100644 --- a/docs/source/telegram.passportelementerrorfiles.rst +++ b/docs/source/telegram.passportelementerrorfiles.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFiles ================================== diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst index 3e57cf2cd19..a92635a2743 100644 --- a/docs/source/telegram.passportelementerrorfrontside.rst +++ b/docs/source/telegram.passportelementerrorfrontside.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFrontSide ====================================== diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst index 089eaffb015..380a1066430 100644 --- a/docs/source/telegram.passportelementerrorreverseside.rst +++ b/docs/source/telegram.passportelementerrorreverseside.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorReverseSide ======================================== diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst index a29b72f5b66..e79c2d8e34e 100644 --- a/docs/source/telegram.passportelementerrorselfie.rst +++ b/docs/source/telegram.passportelementerrorselfie.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorSelfie ======================================== diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst index df48052ecc9..f195552cc5f 100644 --- a/docs/source/telegram.passportelementerrortranslationfile.rst +++ b/docs/source/telegram.passportelementerrortranslationfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorTranslationFile ============================================ diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst index 50c59a4df1d..0a01244bb92 100644 --- a/docs/source/telegram.passportelementerrortranslationfiles.rst +++ b/docs/source/telegram.passportelementerrortranslationfiles.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorTranslationFiles ============================================= diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst index cca80814490..aa5ce87ac97 100644 --- a/docs/source/telegram.passportelementerrorunspecified.rst +++ b/docs/source/telegram.passportelementerrorunspecified.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorUnspecified ======================================== diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst index e5577215e6a..a2af1c5f6ec 100644 --- a/docs/source/telegram.passportfile.rst +++ b/docs/source/telegram.passportfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportfile.py - telegram.PassportFile ===================== diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst index 7a072b51c3a..145769f23da 100644 --- a/docs/source/telegram.personaldetails.rst +++ b/docs/source/telegram.personaldetails.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.PersonalDetails ======================== diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index b71eefc7080..978daa364d2 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/photosize.py - telegram.PhotoSize ================== .. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst index ed401d70775..cd369a02756 100644 --- a/docs/source/telegram.poll.rst +++ b/docs/source/telegram.poll.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.Poll ============= diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst index a72a8934016..b74899ebfbc 100644 --- a/docs/source/telegram.pollanswer.rst +++ b/docs/source/telegram.pollanswer.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.PollAnswer =================== diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst index 02663e9324e..53a6cd69e3a 100644 --- a/docs/source/telegram.polloption.rst +++ b/docs/source/telegram.polloption.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.PollOption =================== diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst index 2bac6fa575c..1b389398151 100644 --- a/docs/source/telegram.precheckoutquery.rst +++ b/docs/source/telegram.precheckoutquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/precheckoutquery.py - telegram.PreCheckoutQuery ========================= diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst index 251f3a53f7f..ab01987ab86 100644 --- a/docs/source/telegram.proximityalerttriggered.rst +++ b/docs/source/telegram.proximityalerttriggered.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/proximityalerttriggered.py - telegram.ProximityAlertTriggered ================================ diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst index 87ff3af9f61..8f55975ea95 100644 --- a/docs/source/telegram.replykeyboardmarkup.rst +++ b/docs/source/telegram.replykeyboardmarkup.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardmarkup.py - telegram.ReplyKeyboardMarkup ============================ diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst index 7e7235b0c99..0f318d2ca78 100644 --- a/docs/source/telegram.replykeyboardremove.rst +++ b/docs/source/telegram.replykeyboardremove.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardremove.py - telegram.ReplyKeyboardRemove ============================ diff --git a/docs/source/telegram.request.baserequest.rst b/docs/source/telegram.request.baserequest.rst index 4ab11dbb772..9280772e27f 100644 --- a/docs/source/telegram.request.baserequest.rst +++ b/docs/source/telegram.request.baserequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_baserequest.py - telegram.request.BaseRequest ============================ diff --git a/docs/source/telegram.request.httpxrequest.rst b/docs/source/telegram.request.httpxrequest.rst index 676f3d1d1b0..8d33a943a03 100644 --- a/docs/source/telegram.request.httpxrequest.rst +++ b/docs/source/telegram.request.httpxrequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_httpxrequest.py - telegram.request.HTTPXRequest ============================= diff --git a/docs/source/telegram.request.requestdata.rst b/docs/source/telegram.request.requestdata.rst index f020347bdaa..e5d4e76a774 100644 --- a/docs/source/telegram.request.requestdata.rst +++ b/docs/source/telegram.request.requestdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_requestdata.py - telegram.request.RequestData ============================ diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 71f19fc4dfd..0b9528ec5c5 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request - telegram.request Module ======================= diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst index 6243af42cc2..95be56963c0 100644 --- a/docs/source/telegram.residentialaddress.rst +++ b/docs/source/telegram.residentialaddress.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.ResidentialAddress =========================== diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst index 29091caa227..ec24c8c4c01 100644 --- a/docs/source/telegram.securedata.rst +++ b/docs/source/telegram.securedata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.SecureData =================== diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst index f9ca37a3b7d..ba756a2ccd5 100644 --- a/docs/source/telegram.securevalue.rst +++ b/docs/source/telegram.securevalue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.SecureValue ==================== diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst index c6cee45716c..6b89c4f86df 100644 --- a/docs/source/telegram.shippingaddress.rst +++ b/docs/source/telegram.shippingaddress.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingaddress.py - telegram.ShippingAddress ======================== diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst index 64024ba90f8..f0af54f8568 100644 --- a/docs/source/telegram.shippingoption.rst +++ b/docs/source/telegram.shippingoption.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingoption.py - telegram.ShippingOption ======================= diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst index d2bf7889c15..5e3c6fd1379 100644 --- a/docs/source/telegram.shippingquery.rst +++ b/docs/source/telegram.shippingquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingquery.py - telegram.ShippingQuery ====================== diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 36c71939861..24dc77d57b2 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.Sticker ================ diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst index 1c0f77cb255..3705c2ef890 100644 --- a/docs/source/telegram.stickerset.rst +++ b/docs/source/telegram.stickerset.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.StickerSet =================== diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst index c703bd69206..43228b50508 100644 --- a/docs/source/telegram.successfulpayment.rst +++ b/docs/source/telegram.successfulpayment.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/successfulpayment.py - telegram.SuccessfulPayment ========================== diff --git a/docs/source/telegram.telegramobject.rst b/docs/source/telegram.telegramobject.rst index 422096fa2a9..61432be1838 100644 --- a/docs/source/telegram.telegramobject.rst +++ b/docs/source/telegram.telegramobject.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/telegramobject.py - telegram.TelegramObject ======================= diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst index e19fc411b64..e03ef4bd36a 100644 --- a/docs/source/telegram.update.rst +++ b/docs/source/telegram.update.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/update.py - telegram.Update =============== diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst index 338631f01ce..e6d05c27aa5 100644 --- a/docs/source/telegram.user.rst +++ b/docs/source/telegram.user.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/user.py - telegram.User ============= diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst index be0cd388e0e..8ca19882e1d 100644 --- a/docs/source/telegram.userprofilephotos.rst +++ b/docs/source/telegram.userprofilephotos.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/userprofilephotos.py - telegram.UserProfilePhotos ========================== diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst index a0322f471ae..0cba4d0d14e 100644 --- a/docs/source/telegram.venue.rst +++ b/docs/source/telegram.venue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/venue.py - telegram.Venue ============== diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index 3cea04e11a1..18c607c4bc7 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/video.py - telegram.Video ============== diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index 0bf03041819..937a76d2cdc 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/videonote.py - telegram.VideoNote ================== diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index 89b92cd5ee3..479a143aa5c 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/voice.py - telegram.Voice ============== diff --git a/docs/source/telegram.voicechatended.rst b/docs/source/telegram.voicechatended.rst index f65584884fc..1183f632fc8 100644 --- a/docs/source/telegram.voicechatended.rst +++ b/docs/source/telegram.voicechatended.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py - telegram.VoiceChatEnded ======================= diff --git a/docs/source/telegram.voicechatparticipantsinvited.rst b/docs/source/telegram.voicechatparticipantsinvited.rst index 7f3bb45c5fb..c2e70a9a837 100644 --- a/docs/source/telegram.voicechatparticipantsinvited.rst +++ b/docs/source/telegram.voicechatparticipantsinvited.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py - telegram.VoiceChatParticipantsInvited ===================================== diff --git a/docs/source/telegram.voicechatscheduled.rst b/docs/source/telegram.voicechatscheduled.rst index 29a931d948d..72a0e2371a9 100644 --- a/docs/source/telegram.voicechatscheduled.rst +++ b/docs/source/telegram.voicechatscheduled.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py - telegram.VoiceChatScheduled =========================== diff --git a/docs/source/telegram.voicechatstarted.rst b/docs/source/telegram.voicechatstarted.rst index eeae2dfef71..31981b95afe 100644 --- a/docs/source/telegram.voicechatstarted.rst +++ b/docs/source/telegram.voicechatstarted.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/voicechat.py - telegram.VoiceChatStarted ========================= diff --git a/docs/source/telegram.warnings.rst b/docs/source/telegram.warnings.rst index 10523ba0720..7af6887b1db 100644 --- a/docs/source/telegram.warnings.rst +++ b/docs/source/telegram.warnings.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/warnings.py - telegram.warnings Module ======================== diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst index fabf0e6e712..233b76637bd 100644 --- a/docs/source/telegram.webhookinfo.rst +++ b/docs/source/telegram.webhookinfo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/webhookinfo.py - telegram.WebhookInfo ==================== From 4bf1e869c3336160f495c20cfaf62c64ca088ef0 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 28 Apr 2022 08:17:22 +0200 Subject: [PATCH 13/19] Pimp sidebar some more, convert CoC to RST & include it into docs directly --- CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.rst | 27 ++++++++++++++--------- docs/source/coc.rst | 1 + docs/source/index.rst | 6 +++-- 3 files changed, 21 insertions(+), 13 deletions(-) rename CODE_OF_CONDUCT.md => CODE_OF_CONDUCT.rst (85%) create mode 100644 docs/source/coc.rst diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.rst similarity index 85% rename from CODE_OF_CONDUCT.md rename to CODE_OF_CONDUCT.rst index c61bb3e5050..6920482dcfe 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.rst @@ -1,10 +1,14 @@ -# Contributor Covenant Code of Conduct +==================================== +Contributor Covenant Code of Conduct +==================================== -## Our Pledge +Our Pledge +========== In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. -## Our Standards +Our Standards +============= Examples of behavior that contributes to creating a positive environment include: @@ -23,25 +27,26 @@ Examples of unacceptable behavior by participants include: * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -## Our Responsibilities +Our Responsibilities +==================== Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. -## Scope +Scope +===== This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. -## Enforcement +Enforcement +=========== Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devs@python-telegram-bot.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. -## Attribution +Attribution +=========== -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ +This Code of Conduct is adapted from the `Contributor Covenant `_, version 1.4, available at `http://contributor-covenant.org/version/1/4 `_. diff --git a/docs/source/coc.rst b/docs/source/coc.rst new file mode 100644 index 00000000000..fb1859c75dc --- /dev/null +++ b/docs/source/coc.rst @@ -0,0 +1 @@ +.. include:: ../../CODE_OF_CONDUCT.rst \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index c8778554754..d3b743c2bd4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -14,16 +14,18 @@ telegram telegram.ext telegram_auxil + Telegrams Bot API Docs .. toctree:: :hidden: :caption: Project changelog - contributing Website + GitHub Repository Telegram Channel Telegram User Group - Code of Conduct + contributing + coc From 90f381db323db76722fa7d4e74c28b7b6b404fcd Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Sun, 1 May 2022 22:19:34 +0530 Subject: [PATCH 14/19] don't encourage mentioning the admins --- .github/CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 9e57a275e3e..03044145b48 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -42,7 +42,7 @@ If you already know what you'd like to work on, you can skip this section. If you have an idea for something to do, first check if it's already been filed on the `issue tracker`_. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it. -Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_ (use `@admins` to mention the maintainers), and we'll help you get started. +Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_, and we'll help you get started. That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers. From 779738f0ca85373b0b25ea416a3b921219c8c70a Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Tue, 3 May 2022 10:42:35 +0200 Subject: [PATCH 15/19] Add pre-commit CI badge --- README.rst | 7 ++++++- README_RAW.rst | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f79aeb6e78a..2197f04dbb7 100644 --- a/README.rst +++ b/README.rst @@ -50,12 +50,17 @@ :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge :alt: Code quality: DeepSource +.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg + :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master + :alt: pre-commit.ci status + .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black + :alt: Code Style: Black .. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram :target: https://t.me/pythontelegrambotchannel - :alt: Telegram Group + :alt: Telegram Channel .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup diff --git a/README_RAW.rst b/README_RAW.rst index dc318f95123..d2d18c0d975 100644 --- a/README_RAW.rst +++ b/README_RAW.rst @@ -50,12 +50,17 @@ :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge :alt: Code quality: DeepSource +.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg + :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master + :alt: pre-commit.ci status + .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black + :alt: Code Style: Black .. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram :target: https://t.me/pythontelegrambotchannel - :alt: Telegram Group + :alt: Telegram Channel .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup From bfb014ec7023a40527f1098532f9085b9c56d477 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Wed, 4 May 2022 23:45:55 +0530 Subject: [PATCH 16/19] add seealso for Bot.initalize and shutdown --- telegram/_bot.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/telegram/_bot.py b/telegram/_bot.py index ca267788f66..a3ec594d22c 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -369,6 +369,8 @@ async def initialize(self) -> None: cache :attr:`bot` and calls :meth:`telegram.request.BaseRequest.initialize` for the request objects used by this bot. + .. seealso:: :meth:`shutdown` + .. versionadded:: 20.0 """ if self._initialized: @@ -382,6 +384,8 @@ async def initialize(self) -> None: async def shutdown(self) -> None: """Stop & clear resources used by this class. Currently just calls :meth:`telegram.request.BaseRequest.shutdown` for the request objects used by this bot. + + .. seealso:: :meth:`initialize` .. versionadded:: 20.0 """ From 8b8e355e61a462fbf99f15bdd5c2770c8fa3bdb8 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Thu, 5 May 2022 00:03:20 +0530 Subject: [PATCH 17/19] black --- telegram/_bot.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/telegram/_bot.py b/telegram/_bot.py index a3ec594d22c..9e9954f2a0b 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -384,7 +384,7 @@ async def initialize(self) -> None: async def shutdown(self) -> None: """Stop & clear resources used by this class. Currently just calls :meth:`telegram.request.BaseRequest.shutdown` for the request objects used by this bot. - + .. seealso:: :meth:`initialize` .. versionadded:: 20.0 From 252f0985a6de509a77db005892e28e329d7c1991 Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 5 May 2022 18:14:38 +0200 Subject: [PATCH 18/19] get started on documenting generics --- telegram/ext/_basepersistence.py | 13 +++++++++++++ telegram/ext/_handler.py | 10 ++++++++++ 2 files changed, 23 insertions(+) diff --git a/telegram/ext/_basepersistence.py b/telegram/ext/_basepersistence.py index e34c7cc8dec..09c82f7e729 100644 --- a/telegram/ext/_basepersistence.py +++ b/telegram/ext/_basepersistence.py @@ -98,7 +98,20 @@ class BasePersistence(Generic[UD, CD, BD], ABC): :class:`telegram.TelegramObject`, one may call :meth:`set_bot` to ensure that shortcuts like :meth:`telegram.Message.reply_text` are available. + This class is a :class:`~typing.Generic` class and accepts three type variables: + + 1. The type of the second argument of :meth:`update_user_data`, which must coincide with the + type of the second argument of :meth:`refresh_user_data` and the values in the dictionary + returned by :meth:`get_user_data`. + 2. The type of the second argument of :meth:`update_chat_data`, which must coincide with the + type of the second argument of :meth:`refresh_chat_data` and the values in the dictionary + returned by :meth:`get_chat_data`. + 3. The type of the argument of :meth:`update_bot_data`, which must coincide with the + type of the argument of :meth:`refresh_bot_data` and the return value of + :meth:`get_bot_data`. + .. versionchanged:: 20.0 + * The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. * ``insert/replace_bot`` was dropped. Serialization of bot instances now needs to be handled by the specific implementation - see above note. diff --git a/telegram/ext/_handler.py b/telegram/ext/_handler.py index d7ad6e381fd..d18add06d57 100644 --- a/telegram/ext/_handler.py +++ b/telegram/ext/_handler.py @@ -38,6 +38,16 @@ class Handler(Generic[UT, CCT], ABC): 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. + This class is a :class:`~typing.Generic` class and accepts two type variables: + + 1. The type of the updates that this handler will handle. :meth:`check_update` must only accept + updates of this type and the first argument of the :paramref:`callback` function will be + handled this type of objects. + 2. The type of the second argument of :paramref:`callback`. For this type variable, one should + usually provide a :class:`~typing.TypeVar` that is also used in the annotation for + :paramref:`callback`. That way, a type checker can check whether this handler and the + :attr:`callback` fit the definition of the :class:`~Application`. + .. versionchanged:: 20.0 The attribute ``run_async`` is now :paramref:`block`. From b9d34e1e82a4f86bc4f4c0609fa3e34f404ad77e Mon Sep 17 00:00:00 2001 From: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> Date: Fri, 6 May 2022 08:26:02 +0200 Subject: [PATCH 19/19] finish documentation of generic classes - documented only those that may reasonably be subclassed by users --- telegram/ext/_callbackcontext.py | 7 +++++++ telegram/ext/_handler.py | 20 +++++++++++++------- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index d292dbcc364..a02ffddace5 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -70,6 +70,13 @@ class CallbackContext(Generic[BT, UD, CD, BD]): :obj:`True`. Due to how those work, it will almost certainly execute the callbacks for an update out of order, and the attributes that you think you added will not be present. + This class is a :class:`~typing.Generic` class and accepts four type variables: + + 1. The type of :attr:`bot`. Must be :class:`telegram.Bot` or a subclass of that class. + 2. The type of :attr:`user_data` (if :attr:`user_data` is not :obj:`None`). + 3. The type of :attr:`chat_data` (if :attr:`chat_data` is not :obj:`None`). + 4. The type of :attr:`bot_data` (if :attr:`bot_data` is not :obj:`None`). + Args: application (:class:`telegram.ext.Application`): The application associated with this context. diff --git a/telegram/ext/_handler.py b/telegram/ext/_handler.py index d18add06d57..d5dccd0fed7 100644 --- a/telegram/ext/_handler.py +++ b/telegram/ext/_handler.py @@ -40,13 +40,19 @@ class Handler(Generic[UT, CCT], ABC): This class is a :class:`~typing.Generic` class and accepts two type variables: - 1. The type of the updates that this handler will handle. :meth:`check_update` must only accept - updates of this type and the first argument of the :paramref:`callback` function will be - handled this type of objects. - 2. The type of the second argument of :paramref:`callback`. For this type variable, one should - usually provide a :class:`~typing.TypeVar` that is also used in the annotation for - :paramref:`callback`. That way, a type checker can check whether this handler and the - :attr:`callback` fit the definition of the :class:`~Application`. + 1. The type of the updates that this handler will handle. Must coincide with the type of the + first argument of :paramref:`callback`. :meth:`check_update` must only accept + updates of this type. + 2. The type of the second argument of :paramref:`callback`. Must coincide with the type of the + parameters :paramref:`handle_update.context` and + :paramref:`collect_additional_context.context` as well as the second argument of + :paramref:`callback`. Must be either :class:`~telegram.ext.CallbackContext` or a subclass + of that class. + + .. tip:: + For this type variable, one should usually provide a :class:`~typing.TypeVar` that is + also used for the mentioned method arguments. That way, a type checker can check whether + this handler fits the definition of the :class:`~Application`. .. versionchanged:: 20.0 The attribute ``run_async`` is now :paramref:`block`.