U g)@s dZddlZddlZddlZddlZddlmZddlmZddlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZmZz ddlmZddlmZdZWn ek rdZdZd ZYnXdd lm Z dd l!m"Z"dd l#m$Z$m%Z%dd l&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9ddl:m;Z;ddlm?Z?ddl@mAZAddlBmCZCmDZDddlEmFZFddlGmHZHddlImJZJmKZKmLZLddlMmNZNdd lOmPZPdd!lQmRZRdd"lSmTZTdd#lUmVZVdd$lWmXZXdd%lYmZZZdd&l[m\Z\dd'l]m^Z^dd(l_m`Z`dd)lambZbdd*lcmdZdmeZedd+lfmgZgmhZhmiZidd,ljmkZkdd-llmmZmdd.lnmoZodd/lpmqZqdd0lrmsZsdd1ltmuZudd2lvmwZwmxZxdd3lymzZzm{Z{dd4l|m}Z}m~Z~dd5lmZdd6lmZdd7lmZdd8lmZmZmZmZmZdd9lmZdd:lmZdd;lmZmZddlmZdd?lmZdd@lmZmZe rddAlmZmZmZmZmZmZmZmZmZmZmZmZmZedBdCdDZGdEdCdCeoe dCZdS)Fz>This module contains an object that represents a Telegram Bot.N)datetime) TracebackType) TYPE_CHECKINGAnyAsyncContextManagerCallableDictListNoReturnOptionalSequenceSetTupleTypeTypeVarUnioncast no_type_check)default_backend) serializationTF) BotCommand)BotCommandScope)BotDescriptionBotShortDescription)BotName)BusinessConnection)ChatAdministratorRights)UserChatBoosts) ChatFullInfo)ChatInviteLink) ChatMember)ChatPermissions) Animation)Audio) ChatPhoto)Contact)Document)File) InputMediaInputPaidMedia)Location) PhotoSize) MaskPositionSticker StickerSet)Venue)Video) VideoNote)Voice) ForumTopic) GameHighScore)InlineQueryResultsButton) MenuButton)Message) MessageId)StarTransactions)InputPollOptionPoll) ReactionTypeReactionTypeCustomEmojiReactionTypeEmoji)ReplyParameters)SentWebAppMessage)TelegramObject)Update)User)UserProfilePhotos)parse_lpo_and_dwppparse_sequence_arg) DEFAULT_NONE DefaultValue) is_local_fileparse_file_input) get_logger)build_repr_with_selected_attrs) to_camel_case)CorrectOptionID FileInputJSONDictODVInput ReplyMarkupwarn) WebhookInfo)InlineQueryLimit ReactionEmoji)EndPointNotFound InvalidToken) BaseRequest RequestData) HTTPXRequest)RequestParameter)PTBDeprecationWarningPTBUserWarning) InlineKeyboardMarkupInlineQueryResult InputFileInputMediaAudioInputMediaDocumentInputMediaPhotoInputMediaVideo InputSticker LabeledPriceLinkPreviewOptions MessageEntityPassportElementErrorShippingOptionBTBot)boundc's9eZdZdZeeZdZdeeeee ee ee ee e dfdd Z e e d d d Zeeeeeeedd ddZedddZeeefedddZee dfdd Zedfdd ZedddZeedddZeeddd Zeedd!d"Zee dd#d$Z eee!dd%d&Z"ee dd'd(Z#ee$dd)d*Z%eedd+d,Z&eedd-d.Z'eedd/d0Z(eedd1d2Z)eedd3d4Z*ee dd5d6Z+ee dd7d8Z,ee dd9d:Z-eedd;d<Z.e/e0d=fe1ee0fee2edd>d?d@Z3de1e4dAfeedAeee e1edBe!fdCdDdEZ5eeefddFdGdHZ6de7e7e7e7ddIeee8e9e:e9e:e9e:e9e:ee8e!dJdKdLZ;e7e7e7e7dMee8e9e:e9e:e9e:e9e:e1e e8ee9e eeeee9eee?dRe9dSedTeeeee9e eee9e:e9e:e9e:e9e:ee8e!dUdVdWZ@dddXdYZAdddZd[ZBde7e7e7e7dMeee8eeeCe9e:e9e:e9e:e9e:e!d\d]d^ZDe7e7e7e7ddIe9e:e9e:e9e:e9e:ee8e$d_d`daZEe7de7e7dde7dddf e7dde7e7e7e7ddbe1eefee9eee?dRe9e e9e ee>eee9dSedTeeeee9e eeee e9e:e9e:e9e:e9e:ee8eFdcdddeZGe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dfdgdhZHe7e7e7e7ddIe1eefe?ee9e:e9e:e9e:e9e:ee8e didjdkZIe7e7dfe7e7e7e7ddIe1eefe1eefee9e e9e eee9e:e9e:e9e:e9e:ee8eFdl dmdnZJe7e7dfe7e7e7e7ddIe1eefe1eefe?ee9e e9e eee9e:e9e:e9e:e9e:ee8eKeLdofdp dqdrZMde7de7de7ddddddf e7dde7e7e7e7ddse1eefe1e4dtfeee9e ee>e9eee?dRe9e eeee edTeeeeee e9e eeeee9e:e9e:e9e:e9e:ee8eFdudvdwZNdddde7de7de7dddddfe7dde7e7e7e7ddse1eefe1e4dxfeeeeeeeee9e ee>e9eee?dRe9e eeee4edTeeeee9e eeeee9e:e9e:e9e:e9e:ee8eFdydzd{ZOde7de7dde7dddddf e7dde7e7e7e7ddse1eefe1e4d|feee9e ee>e9eee ee?dRe9e eeee4edTeeeee9e eeeee9e:e9e:e9e:e9e:ee8eFd}d~dZPe7de7dddddfe7de7e7e7e7ddQe1eefe1e4dfe9e ee>e9e eeeeedTeeeee9e eee9e:e9e:e9e:e9e:ee8eFdddZQdde7ddde7dde7dddddddfe7dde7e7e7e7ddse1eefe1e4dfeeeee9e ee>eeeee9eee ee?dRe9e eeee ee4edTeeeeee e9e eeeee9e:e9e:e9e:e9e:ee8eFdddZRdde7de7dddddf e7dde7e7e7e7ddse1eefe1e4dfeeeee9e ee>e9e eeee4edTeeeee9e eeeee9e:e9e:e9e:e9e:ee8eFdddZSdddde7e7dde7dddddddfe7dde7e7e7e7ddse1eefe1e4dfeeeeeeeee9ee9e ee>ee?dRe9e eeee ee4edTeeeeee e9e eeeee9e:e9e:e9e:e9e:ee8eFdddZTdde7de7de7ddddf e7dde7e7e7e7ddse1eefe1e4dfeeeee9e ee>e9eee?dRe9e eeedTeeeee9e eeeee9e:e9e:e9e:e9e:ee8eFdddZUe7e7ddddfe7de7e7e7e7dde7dd e1eefe?e1de9e e9e eeedTeeeee9e eee9e:e9e:e9e:e9e:ee8eee9eee?dReKeFdofdddZVdde7ddddde7ddddf e7dde7e7e7e7dde1eefee:ee:e9e ee>eeee:eeeee9e eeedTeeeee9e eeeeWe9e:e9e:e9e:e9e:ee8eFdddZXdde7e7e7e7ddee1eefeeeeee:ee:edee:eeeeeeeeeeWe9e:e9e:e9e:e9e:ee8e1eFe fdddZYde7e7e7e7ddIee1eefeeeeedeee9e:e9e:e9e:e9e:ee8e1eFe fd ddZZddddde7dddde7ddddfe7dde7e7e7e7dde1eefee:ee:eeeeeee9e ee>eeeeeee9e eeedTeeeee9e eeee[e9e:e9e:e9e:e9e:ee8eFdddZ\ddde7dde7ddddf e7dde7e7e7e7dde1eefeeeeeee9e ee>eee9e eeedTeeeee9e eeee]e9e:e9e:e9e:e9e:ee8eFdddZ^e7de7ddddfe7de7e7e7e7ddQeee9e ede9e eeedTeeeee9e eee9e:e9e:e9e:e9e:ee8eFdddZ_de7e7e7e7ddIe1eefeeeeee9e:e9e:e9e:e9e:ee8e d ddZ`de1e?deaegee?dffeeeeeKe?deefdddZbecdddddZddde7e7e7e7ddee1e?deaegee?dffeeee eeeeeeee9e:e9e:e9e:e9e:ee8e d ddZfde7e7e7e7ddIeeeeee9e:e9e:e9e:e9e:ee8egd ddZhe7e7e7e7ddIe1eeiejekelemeneoepeqf e9e:e9e:e9e:e9e:ee8erdddÄZsde7e7e7e7ddIe1eefeee1eetfee e9e:e9e:e9e:e9e:ee8e dĜ ddƄZue7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dǜddɄZvde7e7e7e7ddIe1eefeee e9e:e9e:e9e:e9e:ee8e dʜ dd̄Zwe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dǜdd΄Zxde7e7e7e7ddIeeeee eeeee9e:e9e:e9e:e9e:ee8e dϜ ddфZyddde7dde7dfde7e7e7e7ddҜeee1eefeeeee9eedee?dRe9dSeeee e9e:e9e:e9e:e9e:ee8e1eFe fdӜddՄZzddddde7dddf e7e7e7e7ddIee1eefeeeeeeede9eee?dRee eee9e:e9e:e9e:e9e:ee8e1eFe fd֜dd؄Z{de7e7e7e7ddIdee1eefeeeeedeee9e:e9e:e9e:e9e:ee8e1eFe fdڜ dd܄Z|de7e7e7e7ddIee1eefeeeeedeee9e:e9e:e9e:e9e:ee8e1eFe fd ddބZ}de7e7e7e7ddIeeeeeeee?ee9e:e9e:e9e:e9e:ee8eKe~dofdߜ ddZde7e7e7e7ddIeee4eeee?eeeee eee9e:e9e:e9e:e9e:ee8e d ddZde7e7e7e7ddIee e9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8edddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8eKedofdddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8edddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8edddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe9e:e9e:e9e:e9e:ee8ed_ddZde7e7e7e7ddIeeeeeeeeee ee e9e:e9e:e9e:e9e:ee8e1eFe fd ddZde7e7e7e7ddIeeeeeeee9e:e9e:e9e:e9e:ee8eKedofd ddZdddddddddde7dddddde7dddfe7de7e7e7e7ddQe1eefeeeeeee?deeeeeeeeeeee ee ee ee ee e9e edee1eefee ee eeee?ee9e eeedTeee9e eee9e:e9e:e9e:e9e:ee8eFd$ddZde7e7e7e7ddIee ee?deee9e:e9e:e9e:e9e:ee8e d ddZde7e7e7e7ddIee eee9e:e9e:e9e:e9e:ee8e d d d Ze7e7e7e7ddIede9e:e9e:e9e:e9e:ee8ed d dZde7e7e7e7ddIe1eefeeee1eetfee e9e:e9e:e9e:e9e:ee8e d ddZde7e7e7e7ddIe1eefeee ee ee ee ee ee ee ee ee ee ee ee ee ee ee e9e:e9e:e9e:e9e:ee8e dddZde7e7e7e7ddIe1eefeee e9e:e9e:e9e:e9e:ee8e d ddZe7e7e7e7ddIe1eefeee9e:e9e:e9e:e9e:ee8e d ddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8edddZde7e7e7e7ddIe1eefee1eetfeeeeee e9e:e9e:e9e:e9e:ee8ed ddZde7e7e7e7ddIe1eefe1ed fee1eetfeeeeee e9e:e9e:e9e:e9e:ee8ed! d"d#Ze7e7e7e7ddIe1eefe1ed fe9e:e9e:e9e:e9e:ee8ed$d%d&Ze7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dd'd(Ze7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dd)d*Ze7e7e7e7ddIe1eefe4e9e:e9e:e9e:e9e:ee8e d+d,d-Ze7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dd.d/Ze7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e d0d1d2Zde7e7e7e7ddIe1eefeee9e:e9e:e9e:e9e:ee8e d3d4d5Ze7dfe7e7e7e7ddIe1eefee9e eee9e:e9e:e9e:e9e:ee8e d6 d7d8Zde7e7e7e7ddIe1eefeeeee9e:e9e:e9e:e9e:ee8e d9 d:d;Ze7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dd<d=Ze7e7e7e7ddIee9e:e9e:e9e:e9e:ee8ed>d?d@Ze7e7e7e7ddIe?ee9e:e9e:e9e:e9e:ee8eKendofdAdBdCZe7e7e7e7ddIee4ee9e:e9e:e9e:e9e:ee8erdD dEdFZe7e7e7e7ddIeedGe9e:e9e:e9e:e9e:ee8e dH dIdJZe7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8e dKdLdMZde7e7e7e7ddIeeee?dGeeee e9e:e9e:e9e:e9e:ee8e dN dOdPZe7e7e7e7ddIee9e:e9e:e9e:e9e:ee8e dQdRdSZe7e7e7e7ddIee9e:e9e:e9e:e9e:ee8e d>dTdUZde7e7e7e7ddIeeeee4e9e:e9e:e9e:e9e:ee8e dV dWdXZe7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8e dYdZd[Ze7e7e7e7ddIee?ee9e:e9e:e9e:e9e:ee8e d\d]d^Zde7e7e7e7ddIeee?ee9e:e9e:e9e:e9e:ee8e d_d`daZde7e7e7e7ddIeeee9e:e9e:e9e:e9e:ee8e dbdcddZde7e7e7e7ddIeeee9e:e9e:e9e:e9e:ee8e dedfdgZe7e7e7e7ddIee?dhe9e:e9e:e9e:e9e:ee8e didjdkZddddde7dde7ddde7ddde7ddfe7de7e7e7e7ddQe1eefee?e1edlfee eeee eeee e9e ee>eee9eeeee1eetfee?dRe9e eeedTeee9eee?dReee9e eee9e:e9e:e9e:e9e:ee8eFdmdndoZde7e7e7e7ddIe1eefeedeee9e:e9e:e9e:e9e:ee8edp dqdrZe7dde7ddddfe7de7e7e7e7ddQe1eefe9e ee>eee9e eeedTeeeee9e eee9e:e9e:e9e:e9e:ee8eFdsdtduZde7e7e7e7ddIee e9e:e9e:e9e:e9e:ee8edvdwdxZde7e7e7e7ddIeeee e9e:e9e:e9e:e9e:ee8e dydzd{Zd e7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8eKedofd|d}d~ZÐd e7e7e7e7ddIe?e1eeKeeffeeeee9e:e9e:e9e:e9e:ee8e d ddZĐd e7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8e d|ddZe7e7e7e7ddIe9e:e9e:e9e:e9e:ee8e d_ddZe7e7e7e7ddIe9e:e9e:e9e:e9e:ee8e d_ddZde7de7de7dddf e7de7e7e7e7ddQe1eefe1eefeeee9eee?dRe9e ee>e9e eeedTee e9e eee9e:e9e:e9e:e9e:ee8eLdddZe7e7ddfe7e7e7e7ddIe1eefe1eefe?ee9e e9e eeee e9e:e9e:e9e:e9e:ee8eKdd ddZɐd e7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8e dddZːd e7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8edddZ̐de7e7e7e7ddIeeeeeee?deeee?eee1eefeeeeeeeeee ee ee ee ee ee ee e9e:e9e:e9e:e9e:ee8edddZe7e7e7e7ddIe9e:e9e:e9e:e9e:ee8eKendofd_ddZΐde7e7e7e7ddIe1eefeeeeee9e:e9e:e9e:e9e:ee8eϐd ddZАde7e7e7e7ddIe1eefeeeeee9e:e9e:e9e:e9e:ee8e d ddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZe7e7e7e7ddIe1eefe9e:e9e:e9e:e9e:ee8e dddZېde7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8e dddZܐde7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8e dddZݐde7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8eސdddZߐde7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8edddZde7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8e ddd„Zde7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8eddÐdĄZe7e7e7e7ddIe1eefee9e:e9e:e9e:e9e:ee8eddŐdƄZde7e7e7e7ddIe1eefeee1e?e1eefeefee e9e:e9e:e9e:e9e:ee8e dǜ dȐdɄZe7e7e7e7ddIee9e:e9e:e9e:e9e:ee8edʜdːd̄Ze7e7e7e7ddIeeedGe9e:e9e:e9e:e9e:ee8e d͜ dΐdτZe7e7e7e7ddIeee9e:e9e:e9e:e9e:ee8e dМdѐd҄Zde7e7e7e7ddIeeeee9e:e9e:e9e:e9e:ee8edӜdԐdՄZde7dde7e7ddddf e7de7e7e7e7ddQe1eefee?deee9eee?dRee e9e e9e edTee>eeeee9e eee9e:e9e:e9e:e9e:ee8eFdלdؐdلZde7e7e7e7ddIe1eefeeeee9e:e9e:e9e:e9e:ee8edڜ dېd܄Zde7e7e7e7ddIe1eefe1ed feee9e:e9e:e9e:e9e:ee8edݜ dސd߄Zde e8dddZeEZeGZeHZeIZeJZeMZeNZeOZePZeQZeRZeTZeUZeSZeVZeXZeYZeZZe\Ze^Ze_Ze`ZefZ ehZ esZ euZ evZ ewZexZeyZezZe{Ze|Ze}ZeZeZeZeZeZeZeZeZeZeZeZeZ eZ!eZ"eZ#eZ$eZ%eZ&eZ'eZ(eZ)eZ*eZ+eZ,eZ-eZ.eZ/eZ0eZ1eZ2eZ3eZ4eZ5eZ6eZ7eZ8eZ9eZ:eZ;eZeZ?eZ@eZAeZBeÐZCeĐZDeŐZEeƐZFeȐZGeɐZHe̐ZIeːZJeZKeZLe͐ZMeΐZNeАZOeѐZPeҐZQeӐZReԐZSeՐZTeאZUeؐZVeِZWeڐZXeېZYeܐZZeݐZ[eߐZ\eZ]eZ^eZ_eZ`eZaeZbeZceZdeZee֐ZfeZgeZheZieZjeZkeZleZmeZneZoZpS(rnaThis object represents a Telegram Bot. Instances of this class can be used as asyncio context managers, where .. code:: python async with bot: # code is roughly equivalent to .. code:: python try: await bot.initialize() # code finally: await bot.shutdown() .. seealso:: :meth:`__aenter__` and :meth:`__aexit__`. Note: * Most bot methods have the argument ``api_kwargs`` which allows passing arbitrary keywords to the Telegram API. This can be used to access new features of the API before they are incorporated into PTB. The limitations to this argument are the same as the ones described in :meth:`do_api_request`. * Bots should not be serialized since if you for e.g. change the bots token, then your serialized instance will not reflect that change. Trying to pickle a bot instance will raise :exc:`pickle.PicklingError`. Trying to deepcopy a bot instance will raise :exc:`TypeError`. Examples: :any:`Raw API Bot ` .. seealso:: :wiki:`Your First Bot `, :wiki:`Builder Pattern ` .. versionadded:: 13.2 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:: 20.0 * Removed the deprecated methods ``kick_chat_member``, ``kickChatMember``, ``get_chat_members_count`` and ``getChatMembersCount``. * Removed the deprecated property ``commands``. * Removed the deprecated ``defaults`` parameter. If you want to use :class:`telegram.ext.Defaults`, please use the subclass :class:`telegram.ext.ExtBot` instead. * Attempting to pickle a bot instance will now raise :exc:`pickle.PicklingError`. * Attempting to deepcopy a bot instance will now raise :exc:`TypeError`. * The following are now keyword-only arguments in Bot methods: ``location``, ``filename``, ``venue``, ``contact``, ``{read, write, connect, pool}_timeout``, ``api_kwargs``. Use a named argument for those, and notice that some positional arguments changed position as a result. * For uploading files, file paths are now always accepted. If :paramref:`local_mode` is :obj:`False`, the file contents will be read in binary mode and uploaded. Otherwise, the file path will be passed in the `file URI scheme `_. .. versionchanged:: 20.5 Removed deprecated methods ``set_sticker_set_thumb`` and ``setStickerSetThumb``. Use :meth:`set_sticker_set_thumbnail` and :meth:`setStickerSetThumbnail` instead. Args: token (:obj:`str`): Bot's unique authentication token. base_url (:obj:`str`, optional): Telegram Bot API service URL. base_file_url (:obj:`str`, optional): Telegram Bot API file URL. request (:class:`telegram.request.BaseRequest`, optional): Pre initialized :class:`telegram.request.BaseRequest` instances. Will be used for all bot methods *except* for :meth:`get_updates`. If not passed, an instance of :class:`telegram.request.HTTPXRequest` will be used. get_updates_request (:class:`telegram.request.BaseRequest`, optional): Pre initialized :class:`telegram.request.BaseRequest` instances. Will be used exclusively for :meth:`get_updates`. If not passed, an instance of :class:`telegram.request.HTTPXRequest` will be used. private_key (:obj:`bytes`, optional): Private key for decryption of telegram passport data. private_key_password (:obj:`bytes`, optional): Password for above private key. local_mode (:obj:`bool`, optional): Set to :obj:`True`, if the :paramref:`base_url` is the URI of a `Local Bot API Server `_ that runs with the ``--local`` flag. Currently, the only effect of this is that files are uploaded using their local path in the `file URI scheme `_. Defaults to :obj:`False`. .. versionadded:: 20.0. .. include:: inclusions/bot_methods.rst .. |removed_thumb_arg| replace:: Removed deprecated argument ``thumb``. Use ``thumbnail`` instead. )_base_file_url _base_url _bot_user _initialized _local_mode _private_key_request_tokenhttps://api.telegram.org/bot!https://api.telegram.org/file/botNF)tokenbase_url base_file_urlrequestget_updates_request private_keyprivate_key_password local_modec s6tjdd|std||_||j|_||j|_||_d|_d|_d|_ |dkr^t n||dkrnt n|f|_ d} t |j dt r|j dj dkr|dsd} t |j d t r|j d j dkr|ds| r| d 7} nd } | r|jd | d tdd|r*tstdtj||td|_|dS)N) api_kwargszAYou must pass the token you received from https://t.me/Botfather!Fr2rxr~z and requestr}z!You set the HTTP version for the z HTTPXRequest instance to HTTP/2. The self hosted bot api instances only support HTTP/1.1. You should either run a HTTP proxy in front of it which supports HTTP/2 or use HTTP/1.1. stacklevelzcTo use Telegram Passports, PTB must be installed via `pip install "python-telegram-bot[passport]"`.)passwordbackend)super__init__rYrwrqrprtrrrursr\rv isinstance http_version startswith_warnr_CRYPTO_INSTALLED RuntimeErrorrZload_pem_private_keyrZ_freeze) selfrzr{r|r}r~rrrZwarning_string __class__1/tmp/pip-unpacked-wheel-swnnwir2/telegram/_bot.pyrs^      z Bot.__init__)rreturncs<z|IdHWn$tk r6|IdHYnX|S)a( |async_context_manager| :meth:`initializes ` the Bot. Returns: The initialized Bot instance. Raises: :exc:`Exception`: If an exception is raised during initialization, :meth:`shutdown` is called in this case. N) initialize Exceptionshutdownrrrr __aenter__;s zBot.__aenter__)exc_typeexc_valexc_tbrcs|IdHdS)z>|async_context_manager| :meth:`shuts down ` the Bot.N)r)rrrrrrr __aexit__Ms z Bot.__aexit__)rcCstddS)zCustomizes how :func:`copy.deepcopy` processes objects of this type. Bots can not be pickled and this method will always raise an exception. .. versionadded:: 20.0 Raises: :exc:`pickle.PicklingError` zBot objects cannot be pickled!N)pickle PicklingErrorrrrr __reduce__Xs zBot.__reduce__)memodictrcCs tddS)zCustomizes how :func:`copy.deepcopy` processes objects of this type. Bots can not be deepcopied and this method will always raise an exception. .. versionadded:: 20.0 Raises: :exc:`TypeError` z!Bot objects cannot be deepcopied!N) TypeError)rrrrr __deepcopy__cs zBot.__deepcopy__)otherrcs"t|tr|j|jkSt|S)a%Defines equality condition for the :class:`telegram.Bot` object. Two objects of this class are considered to be equal if their attributes :attr:`bot` are equal. Returns: :obj:`True` if both attributes :attr:`bot` are equal. :obj:`False` otherwise. )rrnbotr__eq__)rrrrrrns  z Bot.__eq__cs"|jdkrtSt|jtfS)z,See :meth:`telegram.TelegramObject.__hash__`N)rrr__hash__hashrrnrrrrrzs  z Bot.__hash__cCst||jdS)aGive a string representation of the bot in the form ``Bot[token=...]``. As this class doesn't implement :meth:`object.__str__`, the default implementation will be used, which is equivalent to :meth:`__repr__`. Returns: :obj:`str` )rz)rLrzrrrr__repr__s z Bot.__repr__cCs|jS)zW:obj:`str`: Bot's unique authentication token. .. versionadded:: 20.0 )rwrrrrrzsz Bot.tokencCs|jS)z:obj:`str`: Telegram Bot API service URL, built from :paramref:`Bot.base_url` and :paramref:`Bot.token`. .. versionadded:: 20.0 )rqrrrrr{sz Bot.base_urlcCs|jS)z:obj:`str`: Telegram Bot API file URL, built from :paramref:`Bot.base_file_url` and :paramref:`Bot.token`. .. versionadded:: 20.0 )rprrrrr|szBot.base_file_urlcCs|jS)z`:obj:`bool`: Whether this bot is running in local mode. .. versionadded:: 20.0 )rtrrrrrszBot.local_modecCs|jS)zkDeserialized private key for decryption of telegram passport data. .. versionadded:: 20.0 )rurrrrrszBot.private_keycCs |jdS)zThe :class:`~telegram.request.BaseRequest` object used by this bot. Warning: Requests to the Bot API are made by the various methods of this class. This attribute should *not* be used manually. r)rvrrrrr}sz Bot.requestcCs,|jdkr&t|jjd|jjd|jS)ak:class:`telegram.User`: User instance for the bot as returned by :meth:`get_me`. Warning: This value is the cached return value of :meth:`get_me`. If the bots profile is changed during runtime, this value won't reflect the changes until :meth:`get_me` is called again. .. seealso:: :meth:`initialize` Nz$ is not properly initialized. Call `z,.initialize` before accessing this property.)rrrr__name__rrrrrs zBot.botcCs|jjS)zu:obj:`int`: Unique identifier for this bot. Shortcut for the corresponding attribute of :attr:`bot`. )ridrrrrrszBot.idcCs|jjS)zg:obj:`str`: Bot's first name. Shortcut for the corresponding attribute of :attr:`bot`. )r first_namerrrrrszBot.first_namecCs|jjS)zp:obj:`str`: Optional. Bot's last name. Shortcut for the corresponding attribute of :attr:`bot`. )r last_namerrrrrsz Bot.last_namecCs|jjS)ze:obj:`str`: Bot's username. Shortcut for the corresponding attribute of :attr:`bot`. )rusernamerrrrrsz Bot.usernamecCs d|jS)zC:obj:`str`: Convenience property. Returns the t.me link of the bot.z https://t.me/rrrrrlinkszBot.linkcCs|jjS)z:obj:`bool`: Bot's :attr:`telegram.User.can_join_groups` attribute. Shortcut for the corresponding attribute of :attr:`bot`. )rcan_join_groupsrrrrrszBot.can_join_groupscCs|jjS)z:obj:`bool`: Bot's :attr:`telegram.User.can_read_all_group_messages` attribute. Shortcut for the corresponding attribute of :attr:`bot`. )rcan_read_all_group_messagesrrrrrszBot.can_read_all_group_messagescCs|jjS)z:obj:`bool`: Bot's :attr:`telegram.User.supports_inline_queries` attribute. Shortcut for the corresponding attribute of :attr:`bot`. )rsupports_inline_queriesrrrrrszBot.supports_inline_queriescCs d|jS)zU:obj:`str`: Bot's @username. Shortcut for the corresponding attribute of :attr:`bot`.@rrrrrname szBot.namer)messagecategoryrrcCst|||dddS)zConvenience method to issue a warning. This method is here mostly to make it easier for ExtBot to add 1 level to all warning calls. r)rrrNrS)clsrrrrrrrs z Bot._warnrArb) file_inputtg_typefilenameattachrcCst|||||jdS)N)rrrrr)rJrt)rrrrrrrr_parse_file_inputszBot._parse_file_input)datarc Cs|D]\}}t|trPt|}|t|j|_W5QRX|||<q|dkrt|trt|dt sdd|D}|D]&}|t|j|_W5QRXq|||<qt|||<qdS)aThis method is here to make ext.Defaults work. Because we need to be able to tell e.g. `send_message(chat_id, text)` from `send_message(chat_id, text, parse_mode=None)`, the default values for `parse_mode` etc are not `None` but `DEFAULT_NONE`. While this *could* be done in ExtBot instead of Bot, shortcuts like `Message.reply_text` need to work for both Bot and ExtBot, so they also have the `DEFAULT_NONE` default values. This makes it necessary to convert `DefaultValue(obj)` to `obj` at some point between `Message.reply_text` and the request to TG. Doing this here in a centralized manner is a rather clean and minimally invasive solution, i.e. the link between tg and tg.ext is as small as possible. See also _insert_defaults_for_ilq ExtBot overrides this method to actually insert default values. If in the future we come up with a better way of making `Defaults` work, we can cut this link as well. mediarcSsg|]}t|qSr)copy).0rrrr Lsz(Bot._insert_defaults..N) itemsrr(r _unfrozenrH get_value parse_moder r))rrkeyvalnewZ copy_listrrrr_insert_defaults*s$       zBot._insert_defaults read_timeout write_timeoutconnect_timeout pool_timeoutr)endpointrrrrrrrcsR|dkr i}|r||||dd|D}|j||||||dIdHS)NcSsi|]\}}|dk r||qSNrrrvaluerrr mszBot._post..)rrrrrr)updaterr_do_post)rrrrrrrrrrr_postUs  z Bot._post)rrrr)rrrrrrrc stdd|Dd}|dkr*|jdn|jd}|jd|||j|jd||||||d IdH} |jd || | S) NcSsg|]\}}t||qSr)r]Z from_inputrrrrrsz Bot._do_post..) parameters getUpdatesrrz2Calling Bot API endpoint `%s` with parameters `%s`/)url request_datarrrrz=Call to Bot API endpoint `%s` finished with return value `%s`)r[rrv_LOGGERdebugpostrq) rrrrrrrrr}resultrrrrxs&  z Bot._do_post)allow_sending_without_replyreply_to_message_idrrrrrrjrir?)rrdisable_notification reply_markupprotect_contentmessage_thread_idcaptionrcaption_entitieslink_preview_optionsreply_parametersbusiness_connection_idmessage_effect_idrrrrrrrrc s|tk r| dk rtd|dk r0| dk r0td|dk rDt||d} ||d<||d<||d<| dk rl| |d<| dk r|| |d <|dk r||d <|dk r||d <|dk r||d <| dk r| |d <| dk r| |d<| dk r| |d<|j|||||||dIdH}|dkr|St||S)aProtected method to send or edit messages of any type. It is here to reduce repetition of if-else closes in the different bot methods, i.e. this method takes care of adding its parameters to `data` if appropriate. Depending on the bot method, returns either `True` or the message. However, it's hard to tell mypy which methods expects which of these return values and using `Any` instead saves us a lot of `type: ignore` comments NL`allow_sending_without_reply` and `reply_parameters` are mutually exclusive.D`reply_to_message_id` and `reply_parameters` are mutually exclusive. message_idrrrrrrrrrrrrrT)rG ValueErrorr?rr7de_json)rrrrrrrrrrrrrrrrrrrrrrrrr _send_messagesX# zBot._send_messagec s|jr|jddSt|jd|jdIdHz|IdHWn6tk r}ztd|j d|W5d}~XYnXd|_dS)a Initialize resources used by this class. Currently calls :meth:`get_me` to cache :attr:`bot` and calls :meth:`telegram.request.BaseRequest.initialize` for the request objects used by this bot. .. seealso:: :meth:`shutdown` .. versionadded:: 20.0 z This Bot is already initialized.Nrrz The token `z` was rejected by the server.T) rsrrasynciogatherrvrget_merYrw)rexcrrrrs  &&zBot.initializecsF|js|jddSt|jd|jdIdHd|_dS)zStop & 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 z)This Bot is already shut down. Returning.NrrF)rsrrrrrvrrrrrrs  &z Bot.shutdown)rr return_typerrrrrc st||r&|jd|d|dddt|}z |j||||||dIdH} WnLtk r} z.|jrxtd|d | td |d | W5d} ~ XYnX|dkst| tr| St| t r| | |S| | |S) aDo a request to the Telegram API. This method is here to make it easier to use new API methods that are not yet supported by this library. Hint: Since PTB does not know which arguments are passed to this method, some caution is necessary in terms of PTBs utility functionalities. In particular * passing objects of any class defined in the :mod:`telegram` module is supported * when uploading files, a :class:`telegram.InputFile` must be passed as the value for the corresponding argument. Passing a file path or file-like object will not work. File paths will work only in combination with :paramref:`~Bot.local_mode`. * when uploading files, PTB can still correctly determine that a special write timeout value should be used instead of the default :paramref:`telegram.request.HTTPXRequest.write_timeout`. * insertion of default values specified via :class:`telegram.ext.Defaults` will not work (only relevant for :class:`telegram.ext.ExtBot`). * The only exception is :class:`telegram.ext.Defaults.tzinfo`, which will be correctly applied to :class:`datetime.datetime` objects. .. versionadded:: 20.8 Args: endpoint (:obj:`str`): The API endpoint to use, e.g. ``getMe`` or ``get_me``. api_kwargs (:obj:`dict`, optional): The keyword arguments to pass to the API call. If not specified, no arguments are passed. return_type (:class:`telegram.TelegramObject`, optional): If specified, the result of the API call will be deserialized into an instance of this class or tuple of instances of this class. If not specified, the raw result of the API call will be returned. Returns: The result of the API call. If :paramref:`return_type` is not specified, this is a :obj:`dict` or :obj:`bool`, otherwise an instance of :paramref:`return_type` or a tuple of :paramref:`return_type`. Raises: :class:`telegram.error.TelegramError` zPlease use 'Bot.z"' instead of 'Bot.do_api_request("z", ...)'rr)rrrrrNz Endpoint 'z' not found in Bot APIz?Either the bot token was rejected by Telegram or the endpoint 'z' does not exist.) hasattrrrMrrYrsrXrboollistde_listr) rrrrrrrrZcamel_case_endpointrrrrrdo_api_requests@3     zBot.do_api_request)rrrrrrcs0|jd|||||dIdH}t|||_|jS)aFA simple method for testing your bot's auth token. Requires no parameters. Returns: :class:`telegram.User`: A :class:`telegram.User` instance representing that bot if the credentials are valid, :obj:`None` otherwise. Raises: :class:`telegram.error.TelegramError` getMerN)rrCrrrrrrrrrrrrrrzs z Bot.get_me)rrdisable_web_page_previewrrrrr)chat_idtextrentitiesrrrrrrrrrrrrrrrrrc sJ|||d}t|| } |jd||||| ||| || | | |||||dIdHS)aUse this method to send text messages. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| text (:obj:`str`): Text of the message to be sent. Max :tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): |parse_mode| entities (Sequence[:class:`telegram.MessageEntity`], optional): Sequence of special entities that appear in message text, which can be specified instead of :paramref:`parse_mode`. .. versionchanged:: 20.0 |sequenceargs| link_preview_options (:obj:`LinkPreviewOptions`, optional): Link preview generation options for the message. Mutually exclusive with :paramref:`disable_web_page_preview`. .. versionadded:: 20.8 disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in this message. Convenience parameter for setting :paramref:`link_preview_options`. Mutually exclusive with :paramref:`link_preview_options`. .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`link_preview_options` replacing this argument. PTB will automatically convert this argument to that one, but for advanced options, please use :paramref:`link_preview_options` directly. .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent message is returned. Raises: :exc:`ValueError`: If both :paramref:`disable_web_page_preview` and :paramref:`link_preview_options` are passed. :class:`telegram.error.TelegramError`: For other errors. )rrr sendMessage)rrrrrrrrrrrrrrrrNrEr)rrrrrrrrrrrrrrrrrrrrrrrrr send_messages,j  zBot.send_message)rrrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted :attr:`~telegram.ChatMemberAdministrator.can_post_messages` permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has :attr:`~telegram.ChatMemberAdministrator.can_delete_messages` permission in a supergroup or a channel, it can delete any message there. .. The method CallbackQuery.delete_message() will not be found when automatically generating "Shortcuts" admonitions for Bot methods because it has no calls to Bot methods in its return statement(s). So it is manually included in "See also". .. seealso:: :meth:`telegram.CallbackQuery.delete_message` (calls :meth:`delete_message` indirectly, via :meth:`telegram.Message.delete`) Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_id (:obj:`int`): Identifier of the message to delete. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rr deleteMessagerNr) rrrrrrrrrrrrdelete_messages/ zBot.delete_message)r message_idsrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. .. versionadded:: 20.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_ids (Sequence[:obj:`int`]): A list of :tg-const:`telegram.constants.BulkRequestLimit.MIN_LIMIT`- :tg-const:`telegram.constants.BulkRequestLimit.MAX_LIMIT` identifiers of messages to delete. See :meth:`delete_message` for limitations on which messages can be deleted. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrdeleteMessagesrNr ) rrrrrrrrrrrrdelete_messagesTs zBot.delete_messages) r from_chat_idrrrrrrrrrrc s0|||d} |jd| |||||| | | d IdHS)a Use this method to forward messages of any kind. Service messages can't be forwarded. Note: Since the release of Bot API 5.5 it can be impossible to forward messages from some chats. Use the attributes :attr:`telegram.Message.has_protected_content` and :attr:`telegram.ChatFullInfo.has_protected_content` to check this. As a workaround, it is still possible to use :meth:`copy_message`. However, this behaviour is undocumented and might be changed by Telegram. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the original message was sent (or channel username in the format ``@channelusername``). message_id (:obj:`int`): Message identifier in the chat specified in :paramref:`from_chat_id`. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` )rrrforwardMessage)rrrrrrrrNr) rrrrrrrrrrrrrrrrforward_message~s /zBot.forward_message.) rrrrrrrrrrrrc s<||||||d} |jd| ||| | | dIdH} t| |S)a~ Use this method to forward messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. .. versionadded:: 20.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the original message was sent (or channel username in the format ``@channelusername``). message_ids (Sequence[:obj:`int`]): A list of :tg-const:`telegram.constants.BulkRequestLimit.MIN_LIMIT`- :tg-const:`telegram.constants.BulkRequestLimit.MAX_LIMIT` identifiers of messages in the chat :paramref:`from_chat_id` to forward. The identifiers must be specified in a strictly increasing order. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| message_thread_id (:obj:`int`, optional): |message_thread_id_arg| Returns: Tuple[:class:`telegram.Message`]: On success, a tuple of ``MessageId`` of sent messages is returned. Raises: :class:`telegram.error.TelegramError` )rrrrrrforwardMessagesrNrr8r)rrrrrrrrrrrrrrrrrforward_messagess"+  zBot.forward_messages)rrrrrrrrr+)rphotorrrrrrr has_spoilerrrrshow_caption_above_mediarrrrrrrrrcsP||j|t|d| |d}|jd||||||| |||| |||||| | dIdHS)a[Use this method to send photos. .. seealso:: :wiki:`Working with Files and Media ` Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| photo (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.PhotoSize`): Photo to send. |fileinput| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. Caution: * The photo must be at most 10MB in size. * The photo's width and height must not exceed 10000 in total. * Width and height ratio must be at most 20. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. caption (:obj:`str`, optional): Photo caption (may also be used when resending photos by file_id), 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. has_spoiler (:obj:`bool`, optional): Pass :obj:`True` if the photo needs to be covered with a spoiler animation. .. versionadded:: 20.0 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the photo, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` r)rrrr sendPhotorrrrrrrrrrrrrrrrrN)rr+r)rrrrrrrrrrrrrrrrrrrrrrrrrrr send_photos4wzBot.send_photor#)raudioduration performertitlerrrrrrr thumbnailrrrrrrrrrrrrcsf||j|t|d|||| r(|j| ddndd}|jd|||||| | || | ||||||||dIdHS)aA Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the ``.mp3`` or ``.m4a`` format. Bots can currently send audio files of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_UPLOAD` in size, this limit may be changed in the future. For sending voice messages, use the :meth:`send_voice` method instead. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_arg| Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| audio (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Audio`): Audio file to send. |fileinput| Lastly you can pass an existing :class:`telegram.Audio` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. caption (:obj:`str`, optional): Audio caption, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| duration (:obj:`int`, optional): Duration of sent audio in seconds. performer (:obj:`str`, optional): Performer. title (:obj:`str`, optional): Track name. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstring| .. versionadded:: 20.2 reply_parameters (:obj:`ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the audio, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` rTrN)rrr r!r"r# sendAudior)rr#r)rrrr r!r"rrrrrrrr#rrrrrrrrrrrrrrr send_audios8 zBot.send_audior&)rdocumentrrrrdisable_content_type_detectionrrrr#rrrrrrrrrrrrcsb||j|t|d|| r$|j| ddndd}|jd|||||| | |||| |||||| |dIdHS)a  Use this method to send general files. Bots can currently send files of any type of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_UPLOAD` in size, this limit may be changed in the future. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_arg| Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| document (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Document`): File to send. |fileinput| Lastly you can pass an existing :class:`telegram.Document` object to send. Note: Sending by URL will currently only work ``GIF``, ``PDF`` & ``ZIP`` files. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. caption (:obj:`str`, optional): Document caption (may also be used when resending documents by file_id), 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. disable_content_type_detection (:obj:`bool`, optional): Disables automatic server-side content type detection for files uploaded using multipart/form-data. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstring| .. versionadded:: 20.2 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the document, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` rTr$N)rr'r(r# sendDocumentr)rr&r)rrr'rrrrr(rrrr#rrrrrrrrrrrrrrr send_document-s4zzBot.send_documentr-)rstickerrrrremojirrrrrrrrrrrc sD|||t|d}|jd|| ||| |||| ||||| | dIdHS)a Use this method to send static ``.WEBP``, animated ``.TGS``, or video ``.WEBM`` stickers. .. seealso:: :wiki:`Working with Files and Media ` Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| sticker (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Sticker`): Sticker to send. |fileinput| Video stickers can only be sent by a ``file_id``. Video and animated stickers can't be sent via an HTTP URL. Lastly you can pass an existing :class:`telegram.Sticker` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. emoji (:obj:`str`, optional): Emoji associated with the sticker; only for just uploaded stickers .. versionadded:: 20.2 disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` )rr+r, sendStickerrrrrrrrrrrrrrrN)rr-r)rrr+rrrrr,rrrrrrrrrrrrrr send_stickers,_ zBot.send_stickerr0)rvideor rrrwidthheightrsupports_streamingrrrrr#rrrrrrrrrrrrrcsl||j|t|d|||| |r*|j|ddnd||d }|jd|||||| | || | ||||||||dIdHS)aUse this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). Bots can currently send video files of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_UPLOAD` in size, this limit may be changed in the future. Note: :paramref:`thumbnail` will be ignored for small video files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_arg| Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| video (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Video`): Video file to send. |fileinput| Lastly you can pass an existing :class:`telegram.Video` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. duration (:obj:`int`, optional): Duration of sent video in seconds. width (:obj:`int`, optional): Video width. height (:obj:`int`, optional): Video height. caption (:obj:`str`, optional): Video caption (may also be used when resending videos by file_id), 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is suitable for streaming. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. has_spoiler (:obj:`bool`, optional): Pass :obj:`True` if the video needs to be covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstring| .. versionadded:: 20.2 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the video, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` rTr$N) rr0r r1r2r3r#rr sendVideor)rr0r)rrr0r rrrr1r2rr3rrrrr#rrrrrrrrrrrrrrrr send_video9s@ zBot.send_videor1)r video_noter lengthrrrrr#rrrrrrrrrrrrc s^||j|t|d||| r&|j| ddndd}|jd||||| ||| |||||| | dIdHS)a As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. Note: :paramref:`thumbnail` will be ignored for small video files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_arg| Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| video_note (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.VideoNote`): Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. |uploadinput| Lastly you can pass an existing :class:`telegram.VideoNote` object to send. Sending video notes by a URL is currently unsupported. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. duration (:obj:`int`, optional): Duration of sent video in seconds. length (:obj:`int`, optional): Video width and height, i.e. diameter of the video message. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstring| .. versionadded:: 20.2 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the video note, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` rTr$N)rr6r r7r# sendVideoNoter.)rr1r)rrr6r r7rrrrr#rrrrrrrrrrrrrrrsend_video_notes0uzBot.send_video_noter")r animationr r1r2rrrrrrrrr#rrrrrrrrrrrrrcsj||j|t|d||||r(|j|ddnd| |d}|jd|||| || | ||| ||||||||dIdHS)a Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). Bots can currently send animation files of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_UPLOAD` in size, this limit may be changed in the future. Note: :paramref:`thumbnail` will be ignored for small files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_arg| Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| animation (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Animation`): Animation to send. |fileinput| Lastly you can pass an existing :class:`telegram.Animation` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. duration (:obj:`int`, optional): Duration of sent animation in seconds. width (:obj:`int`, optional): Animation width. height (:obj:`int`, optional): Animation height. caption (:obj:`str`, optional): Animation caption (may also be used when resending animations by file_id), 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. has_spoiler (:obj:`bool`, optional): Pass :obj:`True` if the animation needs to be covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstring| .. versionadded:: 20.2 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the animation, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` rTr$N)rr:r r1r2r#rr sendAnimationr)rr"r)rrr:r r1r2rrrrrrrrr#rrrrrrrrrrrrrrrrsend_animationvs> zBot.send_animationr2)rvoicer rrrrrrrrrrrrrrrrrrrcsN||j|t|d|d}|jd|||||| | |||| |||||| | dIdHS)a Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an ``.ogg`` file encoded with OPUS , or in .MP3 format, or in .M4A format (other formats may be sent as :class:`~telegram.Audio` or :class:`~telegram.Document`). Bots can currently send voice messages of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_UPLOAD` in size, this limit may be changed in the future. Note: To use this method, the file must have the type :mimetype:`audio/ogg` and be no more than :tg-const:`telegram.constants.FileSizeLimit.VOICE_NOTE_FILE_SIZE` in size. :tg-const:`telegram.constants.FileSizeLimit.VOICE_NOTE_FILE_SIZE`- :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_DOWNLOAD` voice notes will be sent as files. .. seealso:: :wiki:`Working with Files and Media ` Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| voice (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Voice`): Voice file to send. |fileinput| Lastly you can pass an existing :class:`telegram.Voice` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. caption (:obj:`str`, optional): Voice message caption, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| duration (:obj:`int`, optional): Duration of the voice message in seconds. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| filename (:obj:`str`, optional): Custom file name for the voice, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` r)rr=r  sendVoicerN)rr2r)rrr=r rrrrrrrrrrrrrrrrrrrrrr send_voice s2xzBot.send_voice) rrrrrrrrrr)rcrdrerf)rrrrrrrrrrrrrrrrrrrc  s|rDttdd|Dtdd|Dtdd|DgrDtd|rt|d}|$||_|tk rt||_t||_W5QRXt |}||d<| tk r|dk rtd| dk r|dk rtd | dk rt | | d }||||||||d }|j d || | | ||d IdH}t ||S)aUse this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. Note: If you supply a :paramref:`caption` (along with either :paramref:`parse_mode` or :paramref:`caption_entities`), then items in :paramref:`media` must have no captions, and vice versa. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| media (Sequence[:class:`telegram.InputMediaAudio`, :class:`telegram.InputMediaDocument`, :class:`telegram.InputMediaPhoto`, :class:`telegram.InputMediaVideo`]): An array describing messages to be sent, must include :tg-const:`telegram.constants.MediaGroupLimit.MIN_MEDIA_LENGTH`- :tg-const:`telegram.constants.MediaGroupLimit.MAX_MEDIA_LENGTH` items. .. versionchanged:: 20.0 |sequenceargs| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| caption (:obj:`str`, optional): Caption that will be added to the first element of :paramref:`media`, so that it will be used as caption for the whole media group. Defaults to :obj:`None`. .. versionadded:: 20.0 parse_mode (:obj:`str` | :obj:`None`, optional): Parse mode for :paramref:`caption`. See the constants in :class:`telegram.constants.ParseMode` for the available modes. .. versionadded:: 20.0 caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): List of special entities for :paramref:`caption`, which can be specified instead of :paramref:`parse_mode`. Defaults to :obj:`None`. .. versionadded:: 20.0 Returns: Tuple[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` css|] }|jVqdSr)rritemrrr  sz'Bot.send_media_group..css|] }|jVqdSr)rr@rrrrB scss|]}|jtk VqdSr)rrGr@rrrrB" sz@You can only supply either group caption or media with captions.rNrrr)rrrrrrrrsendMediaGroupr)anyrrrrrGrrFrrr?rr7r)rrrrrrrrrrrrrrrrrrrZitem_to_get_captionrrrrrsend_media_group s`n   zBot.send_media_group)rrlocationrrrrr)rlatitude longituderr live_periodhorizontal_accuracyheadingproximity_alert_radiusrrrrrrrrFrrrrrrcs|dk r|dk s|std|dk p*|dk t|As`_.) disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| venue (:class:`telegram.Venue`, optional): The venue to send. Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` zSEither venue or latitude, longitude, address and title must be passed as arguments.z]Either venue or latitude, longitude, address and title must be passed as arguments. Not both.) rrGrHr[r"r\r]r^r_ sendVenuer.N)rTrrrDrr/rFrGrHr[r"r\r]r^r_r)rrrGrHr"r[r\rrr]r^r_rrrrrrrrZrrrrrrrrr send_venue sZh  zBot.send_venue)rrcontactrrrrr)r phone_numberrrrrvcardrrrrrrrrbrrrrrrc s|st||gstdt|t||gAs4tdt|trV|j}|j}|j}|j }|||||d}|j d||||| || | |||||| | dIdHS)aS Use this method to send phone contacts. Note: You can either supply :paramref:`contact` or :paramref:`phone_number` and :paramref:`first_name` with optionally :paramref:`last_name` and optionally :paramref:`vcard`. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| phone_number (:obj:`str`, optional): Contact's phone number. first_name (:obj:`str`, optional): Contact's first name. last_name (:obj:`str`, optional): Contact's last name. vcard (:obj:`str`, optional): Additional data about the contact in the form of a vCard, 0-:tg-const:`telegram.constants.ContactLimit.VCARD` bytes. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| contact (:class:`telegram.Contact`, optional): The contact to send. Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` zJEither contact or phone_number and first_name must be passed as arguments.zTEither contact or phone_number and first_name must be passed as arguments. Not both.)rrcrrrd sendContactr.N) rTrrrDrr%rcrrrdr)rrrcrrrrrdrrrrrrrrbrrrrrrrrr send_contact- sJZ zBot.send_contact)rgame_short_namerrrrrrrrrrrrrrrc s:||d}|jd|| ||| |||| | ||||| dIdHS)aUse this method to send a game. Args: chat_id (:obj:`int`): Unique identifier for the target chat. game_short_name (:obj:`str`): Short name of the game, serves as the unique identifier for the game. Set up your games via `@BotFather `_. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new inline keyboard. If empty, one "Play game_title" button will be shown. If not empty, the first button must launch the game. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` )rrgsendGamer.Nr)rrrgrrrrrrrrrrrrrrrrrr send_game s&J z Bot.send_game) ractionrrrrrrrrc s,||||d} |jd| ||||| dIdHS)a4 Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Telegram only recommends using this method when a response from the bot will take a noticeable amount of time to arrive. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| action(:obj:`str`): Type of action to broadcast. Choose one, depending on what the user is about to receive. For convenience look at the constants in :class:`telegram.constants.ChatAction`. message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrjrrsendChatActionrNr ) rrrjrrrrrrrrrrrsend_chat_action s'zBot.send_chat_actionra)results next_offsetcurrent_offsetrcCs|dk r|dk rtd|dk r|s(dnt|}d}t|r`||}|sNg}q|}t|d}qt||dtjkr|d}t|}||tj|tj}q||tjd}n|}||fS)z Builds the effective results from the results input. We make this a stand-alone method so tg.ext.ExtBot can wrap it. Returns: Tuple of 1. the effective results and 2. correct the next_offset Nz:`current_offset` and `next_offset` are mutually exclusive!rrr)rintcallablestrlenrVZRESULTS)rrmrnroZcurrent_offset_intZcallable_outputeffective_resultsZnext_offset_intrrr_effective_inline_resultsG s2zBot._effective_inline_results)resrc Cs$d}t|dr>t|}d}|t|j|_W5QRXt|dr |jr t|jdr|spt|}d}|t|j|_W5QRX|jt|jj|j_W5QRXt|jdr |st|}|t|j|_W5QRX|jt|jj|j_W5QRX|S)ayThe reason why this method exists is similar to the description of _insert_defaults The reason why we do this in rather than in _insert_defaults is because converting DEFAULT_NONE to NONE *before* calling to_dict() makes it way easier to drop None entries from the json data. Must return the correct object instead of editing in-place! FrTinput_message_contentr)rrrrHrrrwr)rrvcopiedrrr _insert_defaults_for_ilq_results| s6           z$Bot._insert_defaults_for_ilq_results)rorrrrr) inline_query_idrm cache_time is_personalrnbuttonrorrrrrrc sVj|||d\} }fdd| D} || ||||d}jd||| | | | dIdHS)a Use this method to send answers to an inline query. No more than :tg-const:`telegram.InlineQuery.MAX_RESULTS` results per query are allowed. Warning: In most use cases :paramref:`current_offset` should not be passed manually. Instead of calling this method directly, use the shortcut :meth:`telegram.InlineQuery.answer` with :paramref:`telegram.InlineQuery.answer.auto_pagination` set to :obj:`True`, which will take care of passing the correct value. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 Removed deprecated arguments ``switch_pm_text`` and ``switch_pm_parameter``. Args: inline_query_id (:obj:`str`): Unique identifier for the answered query. results (List[:class:`telegram.InlineQueryResult`] | Callable): A list of results for the inline query. In case :paramref:`current_offset` is passed, :paramref:`results` may also be a callable that accepts the current page index starting from 0. It must return either a list of :class:`telegram.InlineQueryResult` instances or :obj:`None` if there are no more results. cache_time (:obj:`int`, optional): The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to ``300``. is_personal (:obj:`bool`, optional): Pass :obj:`True`, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. next_offset (:obj:`str`, optional): Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed :tg-const:`telegram.InlineQuery.MAX_OFFSET_LENGTH` bytes. button (:class:`telegram.InlineQueryResultsButton`, optional): A button to be shown above the inline query results. .. versionadded:: 20.3 Keyword Args: current_offset (:obj:`str`, optional): The :attr:`telegram.InlineQuery.offset` of the inline query to answer. If passed, PTB will automatically take care of the pagination for you, i.e. pass the correct :paramref:`next_offset` and truncate the results list/get the results from the callable you passed. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rmrnrocsg|]}|qSr)ry)rrrrrr sz+Bot.answer_inline_query..)rzrmrnr{r|r}answerInlineQueryrN)rur)rrzrmr{r|rnr}rorrrrrrtrrrranswer_inline_query s0E   zBot.answer_inline_query) user_idoffsetlimitrrrrrrc s6|||d} |jd| |||||dIdH} t| |S)aUse this method to get a list of profile pictures for a user. Args: user_id (:obj:`int`): Unique identifier of the target user. offset (:obj:`int`, optional): Sequential number of the first photo to be returned. By default, all photos are returned. limit (:obj:`int`, optional): Limits the number of photos to be retrieved. Values between :tg-const:`telegram.constants.UserProfilePhotosLimit.MIN_LIMIT`- :tg-const:`telegram.constants.UserProfilePhotosLimit.MAX_LIMIT` are accepted. Defaults to ``100``. Returns: :class:`telegram.UserProfilePhotos` Raises: :class:`telegram.error.TelegramError` )rrrgetUserProfilePhotosrN)rrDr) rrrrrrrrrrrrrrget_user_profile_photoss  zBot.get_user_profile_photos)file_idrrrrrrc s~tt |j}W5QRXd|i}|jd||||||dIdH}tt|d} | rrt| sr|j d| |d<t ||S)a Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_DOWNLOAD` in size. The file can then be e.g. downloaded with :meth:`telegram.File.download_to_drive`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling get_file again. Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. .. seealso:: :wiki:`Working with Files and Media ` Args: file_id (:obj:`str` | :class:`telegram.Animation` | :class:`telegram.Audio` | :class:`telegram.ChatPhoto` | :class:`telegram.Document` | :class:`telegram.PhotoSize` | :class:`telegram.Sticker` | :class:`telegram.Video` | :class:`telegram.VideoNote` | :class:`telegram.Voice`): Either the file identifier or an object that has a file_id attribute to get file information about. Returns: :class:`telegram.File` Raises: :class:`telegram.error.TelegramError` rgetFilerN file_pathr) contextlibsuppressAttributeErrorrrrdictgetrIrpr'r) rrrrrrrrrrrrrget_file2s ,   z Bot.get_file) rr until_daterevoke_messagesrrrrrrc s,||||d} |jd| ||||| dIdHS)a Use this method to ban a user from a group, supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. .. versionadded:: 13.7 Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target group or username of the target supergroup or channel (in the format ``@channelusername``). user_id (:obj:`int`): Unique identifier of the target user. until_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. revoke_messages (:obj:`bool`, optional): Pass :obj:`True` to delete all messages from the chat for the user that is being removed. If :obj:`False`, the user will be able to see messages in the group that were sent before the user was removed. Always :obj:`True` for supergroups and channels. .. versionadded:: 13.4 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrr banChatMemberrNr ) rrrrrrrrrrrrrrban_chat_memberss/zBot.ban_chat_member)rsender_chat_idrrrrrrc s(||d}|jd||||||dIdHS)aE Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. .. versionadded:: 13.9 Args: chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target group or username of the target supergroup or channel (in the format ``@channelusername``). sender_chat_id (:obj:`int`): Unique identifier of the target sender chat. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rrbanChatSenderChatrNr  rrrrrrrrrrrrban_chat_sender_chats zBot.ban_chat_sender_chat) rronly_if_bannedrrrrrrc s*|||d} |jd| |||||dIdHS)aUse this method to unban a previously kicked user in a supergroup or channel. The user will *not* return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be *removed* from the chat. If you don't want this, use the parameter :paramref:`only_if_banned`. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. only_if_banned (:obj:`bool`, optional): Do nothing if the user is not banned. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrunbanChatMemberrNr ) rrrrrrrrrrrrrunban_chat_members zBot.unban_chat_memberc s(||d}|jd||||||dIdHS)a)Use this method to unban a previously banned channel in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. .. versionadded:: 13.9 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| sender_chat_id (:obj:`int`): Unique identifier of the target sender chat. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` runbanChatSenderChatrNr rrrrunban_chat_sender_chat s zBot.unban_chat_sender_chat) callback_query_idr show_alertrr{rrrrrrc s.|||||d} |jd| |||| | dIdHS)al Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via `@BotFather `_ and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. Args: callback_query_id (:obj:`str`): Unique identifier for the query to be answered. text (:obj:`str`, optional): Text of the notification. If not specified, nothing will be shown to the user, 0-:tg-const:`telegram.CallbackQuery.MAX_ANSWER_TEXT_LENGTH` characters. show_alert (:obj:`bool`, optional): If :obj:`True`, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to :obj:`False`. url (:obj:`str`, optional): URL that will be opened by the user's client. If you have created a Game and accepted the conditions via `@BotFather `_, specify the URL that opens your game - note that this will only work if the query comes from a callback game button. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. cache_time (:obj:`int`, optional): The maximum amount of time in seconds that the result of the callback query may be cached client-side. Defaults to 0. Returns: :obj:`bool` On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rr{rrranswerCallbackQueryrNr ) rrrrrr{rrrrrrrrranswer_callback_query1s0zBot.answer_callback_query)rrrrrr)rrrrQrrrrrrrrrrrrc  s@|||||d}t| |}|jd||||| | | | ||d IdHS)a} Use this method to edit text and game messages. Note: * |editreplymarkup| * |bcid_edit_time| .. seealso:: :attr:`telegram.Game.text` Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if :paramref:`inline_message_id` is not specified. |chat_id_channel| message_id (:obj:`int`, optional): Required if :paramref:`inline_message_id` is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if :paramref:`chat_id` and :paramref:`message_id` are not specified. Identifier of the inline message. text (:obj:`str`): New text of the message, :tg-const:`telegram.constants.MessageLimit.MIN_TEXT_LENGTH`- :tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| entities (Sequence[:class:`telegram.MessageEntity`], optional): Sequence of special entities that appear in message text, which can be specified instead of :paramref:`parse_mode`. .. versionchanged:: 20.0 |sequenceargs| link_preview_options (:obj:`LinkPreviewOptions`, optional): Link preview generation options for the message. Mutually exclusive with :paramref:`disable_web_page_preview`. .. versionadded:: 20.8 reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an inline keyboard. business_connection_id (:obj:`str`, optional): |business_id_str_edit| .. versionadded:: 21.4 Keyword Args: disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in this message. Convenience parameter for setting :paramref:`link_preview_options`. Mutually exclusive with :paramref:`link_preview_options`. .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`link_preview_options` replacing this argument. PTB will automatically convert this argument to that one, but for advanced options, please use :paramref:`link_preview_options` directly. .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, if edited message is not an inline message, the edited message is returned, otherwise :obj:`True` is returned. Raises: :exc:`ValueError`: If both :paramref:`disable_web_page_preview` and :paramref:`link_preview_options` are passed. :class:`telegram.error.TelegramError`: For other errors. )rrrrQreditMessageText) rrrrrrrrrNr )rrrrrQrrrrrrrrrrrrrrredit_message_textrs(T zBot.edit_message_text)rrrQrrrrrrrrrrrrc s6||||d}|jd|||||| | | | | |d IdHS)a Use this method to edit captions of messages. Note: * |editreplymarkup| * |bcid_edit_time| Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. |chat_id_channel| message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not specified. Identifier of the inline message. caption (:obj:`str`, optional): New caption of the message, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an inline keyboard. show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 business_connection_id (:obj:`str`, optional): |business_id_str_edit| .. versionadded:: 21.4 Returns: :class:`telegram.Message`: On success, if edited message is not an inline message, the edited message is returned, otherwise :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrQreditMessageCaption) rrrrrrrrrrNr)rrrrQrrrrrrrrrrrrrrredit_message_captions&;zBot.edit_message_captionr() rrrrQrrrrrrrrc s0||||d} |jd| ||||| | | d IdHS)a Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its :attr:`~telegram.File.file_id` or specify a URL. Note: * |editreplymarkup| * |bcid_edit_time| .. seealso:: :wiki:`Working with Files and Media ` Args: media (:class:`telegram.InputMedia`): An object for a new media content of the message. chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. |chat_id_channel| message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not specified. Identifier of the inline message. reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an inline keyboard. business_connection_id (:obj:`str`, optional): |business_id_str_edit| .. versionadded:: 21.4 Returns: :class:`telegram.Message`: On success, if edited message is not an inline message, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrrQeditMessageMediarSNr) rrrrrQrrrrrrrrrrredit_message_media-s 3zBot.edit_message_mediac s.|||d} |jd| |||||| | d IdHS)a Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). Note: * |editreplymarkup| * |bcid_edit_time| Args: chat_id (:obj:`int` | :obj:`str`, optional): Required if inline_message_id is not specified. |chat_id_channel| message_id (:obj:`int`, optional): Required if inline_message_id is not specified. Identifier of the message to edit. inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not specified. Identifier of the inline message. reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an inline keyboard. business_connection_id (:obj:`str`, optional): |business_id_str_edit| .. versionadded:: 21.4 Returns: :class:`telegram.Message`: On success, if edited message is not an inline message, the edited message is returned, otherwise :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rVeditMessageReplyMarkuprSNrrXrrredit_message_reply_markuprs,zBot.edit_message_reply_markup) rrtimeoutallowed_updatesrrrrrrc s ||||d} t|ts"|pd} nTz|jdjp2d} Wn>tk rtd} |jtdd|jdjjdddYnXt t t |j d| |r| |n| |||| d Id H} | r|j d d d | Dn |j dzt| |WStk r} z|j jd| | dW5d } ~ XYnXd S)a/ Use this method to receive incoming updates using long polling. Note: 1. This method will not work if an outgoing webhook is set up. 2. In order to avoid getting duplicate updates, recalculate offset after each server response. 3. To take full advantage of this library take a look at :class:`telegram.ext.Updater` .. seealso:: :meth:`telegram.ext.Application.run_polling`, :meth:`telegram.ext.Updater.start_polling` .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: offset (:obj:`int`, optional): Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as this method is called with an offset higher than its :attr:`telegram.Update.update_id`. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten. limit (:obj:`int`, optional): Limits the number of updates to be retrieved. Values between :tg-const:`telegram.constants.PollingLimit.MIN_LIMIT`- :tg-const:`telegram.constants.PollingLimit.MAX_LIMIT` are accepted. Defaults to ``100``. timeout (:obj:`int`, optional): Timeout in seconds for long polling. Defaults to ``0``, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. allowed_updates (Sequence[:obj:`str`]), optional): A sequence the types of updates you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See :class:`telegram.Update` for a complete list of available update types. Specify an empty sequence to receive all updates except :attr:`telegram.Update.chat_member`, :attr:`telegram.Update.message_reaction` and :attr:`telegram.Update.message_reaction_count` (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time. .. versionchanged:: 20.0 |sequenceargs| Returns: Tuple[:class:`telegram.Update`] Raises: :class:`telegram.error.TelegramError` )rrrrrrz20.7z The class z does not override the property `read_timeout`. Overriding this property will be mandatory in future versions. Using 2 seconds as fallback.rrrNzGetting updates: %scSsg|] }|dqS)Z update_idr)rurrrrsz#Bot.get_updates..zNo new updates found.z1Error while parsing updates! Received data was %r)exc_info)rrHrvrNotImplementedErrorrr^rrrr rPrrrrBrrcritical)rrrrrrrrrrrZarg_read_timeoutrrrrr get_updatessT@      zBot.get_updates) r certificatemax_connectionsr ip_addressdrop_pending_updates secret_tokenrrrrrrc s8||||||||d} |jd| || | | | dIdHS)a Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, Telegram will send an HTTPS POST request to the specified url, containing An Update. In case of an unsuccessful request, Telegram will give up after a reasonable amount of attempts. If you'd like to make sure that the Webhook was set by you, you can specify secret data in the parameter :paramref:`secret_token`. If specified, the request will contain a header ``X-Telegram-Bot-Api-Secret-Token`` with the secret token as content. Note: 1. You will not be able to receive updates using :meth:`get_updates` for long as an outgoing webhook is set up. 2. To use a self-signed certificate, you need to upload your public key certificate using :paramref:`certificate` parameter. Please upload as :class:`~telegram.InputFile`, sending a String will not work. 3. Ports currently supported for Webhooks: :attr:`telegram.constants.SUPPORTED_WEBHOOK_PORTS`. If you're having any trouble setting up webhooks, please check out this `guide to Webhooks`_. .. seealso:: :meth:`telegram.ext.Application.run_webhook`, :meth:`telegram.ext.Updater.start_webhook` Examples: :any:`Custom Webhook Bot ` Args: url (:obj:`str`): HTTPS url to send updates to. Use an empty string to remove webhook integration. certificate (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`): Upload your public key certificate so that the root certificate in use can be checked. See our :wiki:`self-signed guide ` for details. |uploadinputnopath| ip_address (:obj:`str`, optional): The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS. max_connections (:obj:`int`, optional): Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, :tg-const:`telegram.constants.WebhookLimit.MIN_CONNECTIONS_LIMIT`- :tg-const:`telegram.constants.WebhookLimit.MAX_CONNECTIONS_LIMIT`. Defaults to ``40``. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. allowed_updates (Sequence[:obj:`str`], optional): A sequence of the types of updates you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See :class:`telegram.Update` for a complete list of available update types. Specify an empty sequence to receive all updates except :attr:`telegram.Update.chat_member`, :attr:`telegram.Update.message_reaction` and :attr:`telegram.Update.message_reaction_count` (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the set_webhook, so unwanted update may be received for a short period of time. .. versionchanged:: 20.0 |sequenceargs| drop_pending_updates (:obj:`bool`, optional): Pass :obj:`True` to drop all pending updates. secret_token (:obj:`str`, optional): A secret token to be sent in a header ``X-Telegram-Bot-Api-Secret-Token`` in every webhook request, :tg-const:`telegram.constants.WebhookLimit.MIN_SECRET_TOKEN_LENGTH`- :tg-const:`telegram.constants.WebhookLimit.MAX_SECRET_TOKEN_LENGTH` characters. Only characters ``A-Z``, ``a-z``, ``0-9``, ``_`` and ``-`` are allowed. The header is useful to ensure that the request comes from a webhook set by you. .. versionadded:: 20.0 Returns: :obj:`bool` On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` .. _`guide to Webhooks`: https://core.telegram.org/bots/webhooks )rrrrrrr setWebhookrNrr)rrrrrrrrrrrrrrrrr set_webhook)s"` zBot.set_webhook)rrrrrrrc s&d|i}|jd||||||dIdHS)a Use this method to remove webhook integration if you decide to switch back to :meth:`get_updates()`. Args: drop_pending_updates (:obj:`bool`, optional): Pass :obj:`True` to drop all pending updates. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` r deleteWebhookrNr )rrrrrrrrrrrdelete_webhookszBot.delete_webhook)rrrrrrrc s&d|i}|jd||||||dIdHS)a2Use this method for your bot to leave a group, supergroup or channel. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` r leaveChatrNr rrrrrrrrrrr leave_chatszBot.leave_chatc s2d|i}|jd||||||dIdH}t||S)a Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). .. versionchanged:: 21.2 In accordance to Bot API 7.3, this method now returns a :class:`telegram.ChatFullInfo`. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :class:`telegram.ChatFullInfo` Raises: :class:`telegram.error.TelegramError` rgetChatrN)rrr rrrrrrrrrrrrget_chats z Bot.get_chatc s2d|i}|jd||||||dIdH}t||S)a Use this method to get a list of administrators in a chat. .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: Tuple[:class:`telegram.ChatMember`]: On success, returns a tuple of ``ChatMember`` objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. Raises: :class:`telegram.error.TelegramError` rgetChatAdministratorsrN)rr rrrrrget_chat_administrators s zBot.get_chat_administratorsc s&d|i}|jd||||||dIdHS)a=Use this method to get the number of members in a chat. .. versionadded:: 13.7 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :obj:`int`: Number of members in the chat. Raises: :class:`telegram.error.TelegramError` rgetChatMemberCountrNr rrrrget_chat_member_count5szBot.get_chat_member_count)rrrrrrrrc s4||d}|jd||||||dIdH} t| |S)aUse this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. Returns: :class:`telegram.ChatMember` Raises: :class:`telegram.error.TelegramError` rr getChatMemberrN)rr r) rrrrrrrrrrrrrget_chat_memberXs  zBot.get_chat_member)rsticker_set_namerrrrrrc s(||d}|jd||||||dIdHS)azUse this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field :attr:`telegram.ChatFullInfo.can_set_sticker_set` optionally returned in :meth:`get_chat` requests to check if the bot can use this method. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| sticker_set_name (:obj:`str`): Name of the sticker set to be set as the group sticker set. Returns: :obj:`bool`: On success, :obj:`True` is returned. )rrsetChatStickerSetrNr ) rrrrrrrrrrrrset_chat_sticker_set}s zBot.set_chat_sticker_setc s&d|i}|jd||||||dIdHS)aUse this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field :attr:`telegram.ChatFullInfo.can_set_sticker_set` optionally returned in :meth:`get_chat` requests to check if the bot can use this method. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. rdeleteChatStickerSetrNr rrrrdelete_chat_sticker_setszBot.delete_chat_sticker_setcs(|jd|||||dIdH}t||S)aUse this method to get current webhook status. Requires no parameters. If the bot is using :meth:`get_updates`, will return an object with the :attr:`telegram.WebhookInfo.url` field empty. Returns: :class:`telegram.WebhookInfo` getWebhookInforN)rrUrrrrrget_webhook_infos zBot.get_webhook_info) rscorerrrQforcedisable_edit_messagerrrrrrc s2|||||||d} |jd| || | | | dIdHS)a Use this method to set the score of the specified user in a game message. .. seealso:: :attr:`telegram.Game.text` Args: user_id (:obj:`int`): User identifier. score (:obj:`int`): New score, must be non-negative. force (:obj:`bool`, optional): Pass :obj:`True`, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. disable_edit_message (:obj:`bool`, optional): Pass :obj:`True`, if the game message should not be automatically edited to include the current scoreboard. chat_id (:obj:`int`, optional): Required if :paramref:`inline_message_id` is not specified. Unique identifier for the target chat. message_id (:obj:`int`, optional): Required if :paramref:`inline_message_id` is not specified. Identifier of the sent message. inline_message_id (:obj:`str`, optional): Required if :paramref:`chat_id` and :paramref:`message_id` are not specified. Identifier of the inline message. Returns: :class:`telegram.Message`: The edited message. If the message is not an inline message , :obj:`True`. Raises: :class:`telegram.error.TelegramError`: If the new score is not greater than the user's current score in the chat and :paramref:`force` is :obj:`False`. )rrrrrrrQ setGameScorerNr)rrrrrrQrrrrrrrrrrrset_game_scores"- zBot.set_game_score) rrrrQrrrrrrc s8||||d} |jd| ||||| dIdH} t| |S)a Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Note: This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: user_id (:obj:`int`): Target user id. chat_id (:obj:`int`, optional): Required if :paramref:`inline_message_id` is not specified. Unique identifier for the target chat. message_id (:obj:`int`, optional): Required if :paramref:`inline_message_id` is not specified. Identifier of the sent message. inline_message_id (:obj:`str`, optional): Required if :paramref:`chat_id` and :paramref:`message_id` are not specified. Identifier of the inline message. Returns: Tuple[:class:`telegram.GameHighScore`] Raises: :class:`telegram.error.TelegramError` )rrrrQgetGameHighScoresrN)rr4r) rrrrrQrrrrrrrrrrget_game_high_scoress* zBot.get_game_high_scoresrh)$rr" descriptionpayloadprovider_tokencurrencypricesstart_parameter photo_url photo_size photo_width photo_height need_nameneed_phone_number need_emailneed_shipping_address is_flexiblerr provider_datasend_phone_number_to_providersend_email_to_providermax_tip_amountsuggested_tip_amountsrrrrrrrrrrrrc%s`|||||||||||| | | | | ||||||d}$|jd|$||||||||| |!|"|#|dIdHS)aUse this method to send invoices. Warning: 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. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| title (:obj:`str`): Product name. :tg-const:`telegram.Invoice.MIN_TITLE_LENGTH`- :tg-const:`telegram.Invoice.MAX_TITLE_LENGTH` characters. description (:obj:`str`): Product description. :tg-const:`telegram.Invoice.MIN_DESCRIPTION_LENGTH`- :tg-const:`telegram.Invoice.MAX_DESCRIPTION_LENGTH` characters. payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be displayed to the user, use it for your internal processes. provider_token (:obj:`str`): Payments provider token, obtained via `@BotFather `_. Pass an empty string for payments in |tg_stars|. .. deprecated:: 21.3 As of Bot API 7.4, this parameter is now optional and future versions of the library will make it optional as well. currency (:obj:`str`): Three-letter ISO 4217 currency code, see `more on currencies `_. Pass ``XTR`` for payment in |tg_stars|. prices (Sequence[:class:`telegram.LabeledPrice`]): Price breakdown, a sequence of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payment in |tg_stars|. .. versionchanged:: 20.0 |sequenceargs| max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the ``exp`` parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to ``0``. Not supported for payment in |tg_stars|. .. versionadded:: 13.5 suggested_tip_amounts (Sequence[:obj:`int`], optional): An array of suggested amounts of tips in the *smallest units* of the currency (integer, **not** float/double). At most :tg-const:`telegram.Invoice.MAX_TIP_AMOUNTS` suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed :paramref:`max_tip_amount`. .. versionadded:: 13.5 .. versionchanged:: 20.0 |sequenceargs| start_parameter (:obj:`str`, optional): Unique deep-linking parameter. If left empty, *forwarded copies* of the sent message will have a *Pay* button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a *URL* button with a deep link to the bot (instead of a *Pay* button), with the value used as the start parameter. .. versionchanged:: 13.5 As of Bot API 5.2, this parameter is optional. provider_data (:obj:`str` | :obj:`object`, optional): data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON. photo_url (:obj:`str`, optional): URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. photo_size (:obj:`str`, optional): Photo size. photo_width (:obj:`int`, optional): Photo width. photo_height (:obj:`int`, optional): Photo height. need_name (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's full name to complete the order. Ignored for payments in |tg_stars|. need_phone_number (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's phone number to complete the order. Ignored for payments in |tg_stars|. need_email (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's email to complete the order. Ignored for payments in |tg_stars|. need_shipping_address (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's shipping address to complete the order. Ignored for payments in |tg_stars|. send_phone_number_to_provider (:obj:`bool`, optional): Pass :obj:`True`, if user's phone number should be sent to provider. Ignored for payments in |tg_stars|. send_email_to_provider (:obj:`bool`, optional): Pass :obj:`True`, if user's email address should be sent to provider. Ignored for payments in |tg_stars|. is_flexible (:obj:`bool`, optional): Pass :obj:`True`, if the final price depends on the shipping method. Ignored for payments in |tg_stars|. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` )rr"rrrrrrrrrrrrrrrrrrrr sendInvoice) rrrrrrrrrrrrrNr)%rrr"rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr send_invoiceXsR1zBot.send_invoicerl) shipping_query_idokshipping_options error_messagerrrrrrc s,||||d} |jd| ||||| dIdHS)a If you sent an invoice requesting a shipping address and the parameter :paramref:`send_invoice.is_flexible` was specified, the Bot API will send an :class:`telegram.Update` with a :attr:`telegram.Update.shipping_query` field to the bot. Use this method to reply to shipping queries. Args: shipping_query_id (:obj:`str`): Unique identifier for the query to be answered. ok (:obj:`bool`): Specify :obj:`True` if delivery to the specified address is possible and :obj:`False` if there are any problems (for example, if delivery to the specified address is not possible). shipping_options (Sequence[:class:`telegram.ShippingOption`]), optional): Required if :paramref:`ok` is :obj:`True`. A sequence of available shipping options. .. versionchanged:: 20.0 |sequenceargs| error_message (:obj:`str`, optional): Required if :paramref:`ok` is :obj:`False`. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable"). Telegram will display this message to the user. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrranswerShippingQueryrNr ) rrrrrrrrrrrrrranswer_shipping_query2s*zBot.answer_shipping_query) pre_checkout_query_idrrrrrrrrc s*|||d} |jd| |||||dIdHS)a} Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an :class:`telegram.Update` with the field :attr:`telegram.Update.pre_checkout_query`. Use this method to respond to such pre-checkout queries. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. Args: pre_checkout_query_id (:obj:`str`): Unique identifier for the query to be answered. ok (:obj:`bool`): Specify :obj:`True` if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use :obj:`False` if there are any problems. error_message (:obj:`str`, optional): Required if :paramref:`ok` is :obj:`False`. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. Returns: :obj:`bool`: On success, :obj:`True` is returned Raises: :class:`telegram.error.TelegramError` )rrranswerPreCheckoutQueryrNr ) rrrrrrrrrrrrranswer_pre_checkout_queryls)zBot.answer_pre_checkout_query)web_app_query_idrrrrrrrc s:|||d}|jd||||||dIdH} t| |S)aUse this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. .. versionadded:: 20.0 Args: web_app_query_id (:obj:`str`): Unique identifier for the query to be answered. result (:class:`telegram.InlineQueryResult`): An object describing the message to be sent. Returns: :class:`telegram.SentWebAppMessage`: On success, a sent :class:`telegram.SentWebAppMessage` is returned. Raises: :class:`telegram.error.TelegramError` )rranswerWebAppQueryrN)ryrr@r) rrrrrrrrrZ api_resultrrranswer_web_app_querys zBot.answer_web_app_query) rr permissionsr use_independent_chat_permissionsrrrrrrc s.|||||d} |jd| |||| | dIdHS)a, Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass :obj:`True` for all boolean parameters to lift restrictions from a user. .. seealso:: :meth:`telegram.ChatPermissions.all_permissions` Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| user_id (:obj:`int`): Unique identifier of the target user. until_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. permissions (:class:`telegram.ChatPermissions`): An object for new user permissions. use_independent_chat_permissions (:obj:`bool`, optional): Pass :obj:`True` if chat permissions are set independently. Otherwise, the :attr:`~telegram.ChatPermissions.can_send_other_messages` and :attr:`~telegram.ChatPermissions.can_add_web_page_previews` permissions will imply the :attr:`~telegram.ChatPermissions.can_send_messages`, :attr:`~telegram.ChatPermissions.can_send_audios`, :attr:`~telegram.ChatPermissions.can_send_documents`, :attr:`~telegram.ChatPermissions.can_send_photos`, :attr:`~telegram.ChatPermissions.can_send_videos`, :attr:`~telegram.ChatPermissions.can_send_video_notes`, and :attr:`~telegram.ChatPermissions.can_send_voice_notes` permissions; the :attr:`~telegram.ChatPermissions.can_send_polls` permission will imply the :attr:`~telegram.ChatPermissions.can_send_messages` permission. .. versionadded: 20.1 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrrrrestrictChatMemberrNr ) rrrrrrrrrrrrrrrrestrict_chat_members8zBot.restrict_chat_member)rrcan_change_infocan_post_messagescan_edit_messagescan_delete_messagescan_invite_userscan_restrict_memberscan_pin_messagescan_promote_members is_anonymouscan_manage_chatcan_manage_video_chatscan_manage_topicscan_post_storiescan_edit_storiescan_delete_storiesrrrrrrcsF||| ||||||| | | | ||||d}|jd||||||dIdHS)a Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass :obj:`False` for all boolean parameters to demote a user. .. versionchanged:: 20.0 The argument ``can_manage_voice_chats`` was renamed to :paramref:`can_manage_video_chats` in accordance to Bot API 6.0. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. is_anonymous (:obj:`bool`, optional): Pass :obj:`True`, if the administrator's presence in the chat is hidden. can_manage_chat (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege. .. versionadded:: 13.4 can_manage_video_chats (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can manage video chats. .. versionadded:: 20.0 can_change_info (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can change chat title, photo and other settings. can_post_messages (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can post messages in the channel, or access channel statistics; for channels only. can_edit_messages (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can edit messages of other users and can pin messages, for channels only. can_delete_messages (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can delete messages of other users. can_invite_users (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can invite new users to the chat. can_restrict_members (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can restrict, ban or unban chat members, or access supergroup statistics. can_pin_messages (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can pin messages, for supergroups only. can_promote_members (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user). can_manage_topics (:obj:`bool`, optional): Pass :obj:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only. .. versionadded:: 20.0 can_post_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can post stories to the chat. .. versionadded:: 20.6 can_edit_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive .. versionadded:: 20.6 can_delete_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can delete stories posted by other users. .. versionadded:: 20.6 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrrrrrrrrrrrrrrrpromoteChatMemberrNr )rrrrrrrrrrrrrrrrrrrrrrrrrrrpromote_chat_members6`zBot.promote_chat_member) rrrrrrrrrc s*|||d} |jd| |||||dIdHS)al Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the :attr:`telegram.ChatMemberAdministrator.can_restrict_members` admin rights. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| permissions (:class:`telegram.ChatPermissions`): New default chat permissions. use_independent_chat_permissions (:obj:`bool`, optional): Pass :obj:`True` if chat permissions are set independently. Otherwise, the :attr:`~telegram.ChatPermissions.can_send_other_messages` and :attr:`~telegram.ChatPermissions.can_add_web_page_previews` permissions will imply the :attr:`~telegram.ChatPermissions.can_send_messages`, :attr:`~telegram.ChatPermissions.can_send_audios`, :attr:`~telegram.ChatPermissions.can_send_documents`, :attr:`~telegram.ChatPermissions.can_send_photos`, :attr:`~telegram.ChatPermissions.can_send_videos`, :attr:`~telegram.ChatPermissions.can_send_video_notes`, and :attr:`~telegram.ChatPermissions.can_send_voice_notes` permissions; the :attr:`~telegram.ChatPermissions.can_send_polls` permission will imply the :attr:`~telegram.ChatPermissions.can_send_messages` permission. .. versionadded: 20.1 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrsetChatPermissionsrNr ) rrrrrrrrrrrrrset_chat_permissionss,zBot.set_chat_permissions) rr custom_titlerrrrrrc s*|||d} |jd| |||||dIdHS)a Use this method to set a custom title for administrators promoted by the bot in a supergroup. The bot must be an administrator for this to work. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| user_id (:obj:`int`): Unique identifier of the target administrator. custom_title (:obj:`str`): New custom title for the administrator; 0-:tg-const:`telegram.constants.ChatLimit.CHAT_ADMINISTRATOR_CUSTOM_TITLE_LENGTH` characters, emoji are not allowed. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrr setChatAdministratorCustomTitlerNr ) rrrr rrrrrrrrr#set_chat_administrator_custom_titles z'Bot.set_chat_administrator_custom_titlec s&d|i}|jd||||||dIdHS)a Use this method to generate a new primary invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using :meth:`export_chat_invite_link` or by calling the :meth:`get_chat` method. If your bot needs to generate a new primary invite link replacing its previous one, use :meth:`export_chat_invite_link` again. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :obj:`str`: New invite link on success. Raises: :class:`telegram.error.TelegramError` rexportChatInviteLinkrNr rrrrexport_chat_invite_links zBot.export_chat_invite_link) r expire_date member_limitrcreates_join_requestrrrrrrc s:|||||d} |jd| |||| | dIdH} t| |S)a Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. The link can be revoked using the method :meth:`revoke_chat_invite_link`. Note: When joining *public* groups via an invite link, Telegram clients may display the usual "Join" button, effectively ignoring the invite link. In particular, the parameter :paramref:`creates_join_request` has no effect in this case. However, this behavior is undocument and may be subject to change. See `this GitHub thread `_ for some discussion. .. versionadded:: 13.4 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. Integer input will be interpreted as Unix timestamp. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. member_limit (:obj:`int`, optional): Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; :tg-const:`telegram.constants.ChatInviteLinkLimit.MIN_MEMBER_LIMIT`- :tg-const:`telegram.constants.ChatInviteLinkLimit.MAX_MEMBER_LIMIT`. name (:obj:`str`, optional): Invite link name; 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. .. versionadded:: 13.8 creates_join_request (:obj:`bool`, optional): :obj:`True`, if users joining the chat via the link need to be approved by chat administrators. If :obj:`True`, :paramref:`member_limit` can't be specified. .. versionadded:: 13.8 Returns: :class:`telegram.ChatInviteLink` Raises: :class:`telegram.error.TelegramError` )rrrrrcreateChatInviteLinkrNrrr) rrrrrrrrrrrrrrrrcreate_chat_invite_link's : zBot.create_chat_invite_linkr) r invite_linkrrrrrrrrrrc sPt|tr|jn|} || ||||d} |jd| ||| | | dIdH}t||S)ay Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Note: Though not stated explicitly in the official docs, Telegram changes not only the optional parameters that are explicitly passed, but also replaces all other optional parameters to the default values. However, since not documented, this behaviour may change unbeknown to PTB. .. versionadded:: 13.4 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| invite_link (:obj:`str` | :class:`telegram.ChatInviteLink`): The invite link to edit. .. versionchanged:: 20.0 Now also accepts :class:`telegram.ChatInviteLink` instances. expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. member_limit (:obj:`int`, optional): Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; :tg-const:`telegram.constants.ChatInviteLinkLimit.MIN_MEMBER_LIMIT`- :tg-const:`telegram.constants.ChatInviteLinkLimit.MAX_MEMBER_LIMIT`. name (:obj:`str`, optional): Invite link name; 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. .. versionadded:: 13.8 creates_join_request (:obj:`bool`, optional): :obj:`True`, if users joining the chat via the link need to be approved by chat administrators. If :obj:`True`, :paramref:`member_limit` can't be specified. .. versionadded:: 13.8 Returns: :class:`telegram.ChatInviteLink` Raises: :class:`telegram.error.TelegramError` )rrrrrreditChatInviteLinkrNrrrrr)rrrrrrrrrrrrrrrrrredit_chat_invite_linkts$;  zBot.edit_chat_invite_link)rrrrrrrrc sHt|tr|jn|}||d} |jd| |||||dIdH} t| |S)a Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. .. versionadded:: 13.4 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| invite_link (:obj:`str` | :class:`telegram.ChatInviteLink`): The invite link to revoke. .. versionchanged:: 20.0 Now also accepts :class:`telegram.ChatInviteLink` instances. Returns: :class:`telegram.ChatInviteLink` Raises: :class:`telegram.error.TelegramError` )rrrevokeChatInviteLinkrNr) rrrrrrrrrrrrrrrevoke_chat_invite_links   zBot.revoke_chat_invite_linkc s(||d}|jd||||||dIdHS)a+Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the :attr:`telegram.ChatPermissions.can_invite_users` administrator right. .. versionadded:: 13.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rapproveChatJoinRequestrNr  rrrrrrrrrrrrapprove_chat_join_requests zBot.approve_chat_join_requestc s(||d}|jd||||||dIdHS)a+Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the :attr:`telegram.ChatPermissions.can_invite_users` administrator right. .. versionadded:: 13.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rdeclineChatJoinRequestrNr rrrrdecline_chat_join_requests zBot.decline_chat_join_request)rrrrrrrrc s.|||d}|jd||||||dIdHS)a[Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| photo (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path`): New chat photo. |uploadinput| .. versionchanged:: 13.2 Accept :obj:`bytes` as input. .. versionchanged:: 20.0 File paths as input is also accepted for bots *not* running in :paramref:`~telegram.Bot.local_mode`. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rr setChatPhotorNr) rrrrrrrrrrrrset_chat_photoDs#zBot.set_chat_photoc s&d|i}|jd||||||dIdHS)a Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rdeleteChatPhotorNr rrrrdelete_chat_photorszBot.delete_chat_photo)rr"rrrrrrc s(||d}|jd||||||dIdHS)a Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| title (:obj:`str`): New chat title, :tg-const:`telegram.constants.ChatLimit.MIN_CHAT_TITLE_LENGTH`- :tg-const:`telegram.constants.ChatLimit.MAX_CHAT_TITLE_LENGTH` characters. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rr" setChatTitlerNr ) rrr"rrrrrrrrrset_chat_titles zBot.set_chat_title)rrrrrrrrc s(||d}|jd||||||dIdHS)au Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| description (:obj:`str`, optional): New chat description, 0-:tg-const:`telegram.constants.ChatLimit.CHAT_DESCRIPTION_LENGTH` characters. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrsetChatDescriptionrNr ) rrrrrrrrrrrrset_chat_descriptions zBot.set_chat_description) rrrrrrrrrrc s,||||d} |jd| ||||| dIdHS)a Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` admin right in a supergroup or :attr:`~telegram.ChatMemberAdministrator.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_id (:obj:`int`): Identifier of a message to pin. disable_notification (:obj:`bool`, optional): Pass :obj:`True`, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. business_connection_id (:obj:`str`, optional): Unique identifier of the business connection on behalf of which the message will be pinned. .. versionadded:: 21.5 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrrpinChatMessagerNr ) rrrrrrrrrrrrrrpin_chat_messages'zBot.pin_chat_message) rrrrrrrrrc s*|||d} |jd| |||||dIdHS)ab Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` admin right in a supergroup or :attr:`~telegram.ChatMemberAdministrator.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_id (:obj:`int`, optional): Identifier of the message to unpin. Required if :paramref:`business_connection_id` is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. business_connection_id (:obj:`str`, optional): Unique identifier of the business connection on behalf of which the message will be unpinned. .. versionadded:: 21.5 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrunpinChatMessagerNr ) rrrrrrrrrrrrrunpin_chat_messages%zBot.unpin_chat_messagec s&d|i}|jd||||||dIdHS)a| Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` admin right in a supergroup or :attr:`~telegram.ChatMemberAdministrator.can_edit_messages` admin right in a channel. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` runpinAllChatMessagesrNr rrrrunpin_all_chat_messagesRszBot.unpin_all_chat_messages)rrrrrrrc s2d|i}|jd||||||dIdH}t||S)zUse this method to get a sticker set. Args: name (:obj:`str`): Name of the sticker set. Returns: :class:`telegram.StickerSet` Raises: :class:`telegram.error.TelegramError` r getStickerSetrN)rr.r) rrrrrrrrrrrrget_sticker_setxs zBot.get_sticker_set)custom_emoji_idsrrrrrrc s2d|i}|jd||||||dIdH}t||S)a Use this method to get information about emoji stickers by their identifiers. .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: custom_emoji_ids (Sequence[:obj:`str`]): Sequence of custom emoji identifiers. At most :tg-const:`telegram.constants.CustomEmojiStickerLimit.CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified. .. versionchanged:: 20.0 |sequenceargs| Returns: Tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` r3getCustomEmojiStickersrNrr-r) rr3rrrrrrrrrrget_custom_emoji_stickerss zBot.get_custom_emoji_stickers) rr+sticker_formatrrrrrrc s<||||d} |jd| |||||dIdH} t| |S)a Use this method to upload a file with a sticker for later use in the :meth:`create_new_sticker_set` and :meth:`add_sticker_to_set` methods (can be used multiple times). .. versionchanged:: 20.5 Removed deprecated parameter ``png_sticker``. Args: user_id (:obj:`int`): User identifier of sticker file owner. sticker (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path`): A file with the sticker in the ``".WEBP"``, ``".PNG"``, ``".TGS"`` or ``".WEBM"`` format. See `here `_ for technical requirements . |uploadinput| .. versionadded:: 20.2 sticker_format (:obj:`str`): Format of the sticker. Must be one of :attr:`telegram.constants.StickerFormat.STATIC`, :attr:`telegram.constants.StickerFormat.ANIMATED`, :attr:`telegram.constants.StickerFormat.VIDEO`. .. versionadded:: 20.2 Returns: :class:`telegram.File`: On success, the uploaded File is returned. Raises: :class:`telegram.error.TelegramError` )rr+r7uploadStickerFilerN)rrr'r) rrr+r7rrrrrrrrrrupload_sticker_files- zBot.upload_sticker_filerg) rrr+rrrrrrc s*|||d} |jd| |||||dIdHS)ac Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to :tg-const:`telegram.constants.StickerSetLimit.MAX_EMOJI_STICKERS` stickers. Other sticker sets can have up to :tg-const:`telegram.constants.StickerSetLimit.MAX_STATIC_STICKERS` stickers. .. versionchanged:: 20.2 Since Bot API 6.6, the parameter :paramref:`sticker` replace the parameters ``png_sticker``, ``tgs_sticker``, ``webm_sticker``, ``emojis``, and ``mask_position``. .. versionchanged:: 20.5 Removed deprecated parameters ``png_sticker``, ``tgs_sticker``, ``webm_sticker``, ``emojis``, and ``mask_position``. Args: user_id (:obj:`int`): User identifier of created sticker set owner. name (:obj:`str`): Sticker set name. sticker (:class:`telegram.InputSticker`): An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. .. versionadded:: 20.2 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrr+addStickerToSetrNr ) rrrr+rrrrrrrrradd_sticker_to_sets,zBot.add_sticker_to_set)r+positionrrrrrrc s(||d}|jd||||||dIdHS)aUse this method to move a sticker in a set created by the bot to a specific position. Args: sticker (:obj:`str`): File identifier of the sticker. position (:obj:`int`): New sticker position in the set, zero-based. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )r+r<setStickerPositionInSetrNr ) rr+r<rrrrrrrrrset_sticker_position_in_set<s zBot.set_sticker_position_in_set) rrr"stickers sticker_typeneeds_repaintingrrrrrrc s0||||||d} |jd| ||| | | dIdHS)a2 Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set thus created. .. versionchanged:: 20.0 The parameter ``contains_masks`` has been removed. Use :paramref:`sticker_type` instead. .. versionchanged:: 20.2 Since Bot API 6.6, the parameters :paramref:`stickers` and :paramref:`sticker_format` replace the parameters ``png_sticker``, ``tgs_sticker``,``webm_sticker``, ``emojis``, and ``mask_position``. .. versionchanged:: 20.5 Removed the deprecated parameters mentioned above and adjusted the order of the parameters. .. versionremoved:: 21.2 Removed the deprecated parameter ``sticker_format``. Args: user_id (:obj:`int`): User identifier of created sticker set owner. name (:obj:`str`): Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_". is case insensitive. :tg-const:`telegram.constants.StickerLimit.MIN_NAME_AND_TITLE`- :tg-const:`telegram.constants.StickerLimit.MAX_NAME_AND_TITLE` characters. title (:obj:`str`): Sticker set title, :tg-const:`telegram.constants.StickerLimit.MIN_NAME_AND_TITLE`- :tg-const:`telegram.constants.StickerLimit.MAX_NAME_AND_TITLE` characters. stickers (Sequence[:class:`telegram.InputSticker`]): A sequence of :tg-const:`telegram.constants.StickerSetLimit.MIN_INITIAL_STICKERS`- :tg-const:`telegram.constants.StickerSetLimit.MAX_INITIAL_STICKERS` initial stickers to be added to the sticker set. .. versionadded:: 20.2 sticker_type (:obj:`str`, optional): Type of stickers in the set, pass :attr:`telegram.Sticker.REGULAR` or :attr:`telegram.Sticker.MASK`, or :attr:`telegram.Sticker.CUSTOM_EMOJI`. By default, a regular sticker set is created .. versionadded:: 20.0 needs_repainting (:obj:`bool`, optional): Pass :obj:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only. .. versionadded:: 20.2 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrr"r?r@rAcreateNewStickerSetrNr ) rrrr"r?r@rArrrrrrrrrcreate_new_sticker_set_s J zBot.create_new_sticker_set)r+rrrrrrc s&d|i}|jd||||||dIdHS)a0Use this method to delete a sticker from a set created by the bot. Args: sticker (:obj:`str`): File identifier of the sticker. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` r+deleteStickerFromSetrNr )rr+rrrrrrrrrdelete_sticker_from_setszBot.delete_sticker_from_setc s&d|i}|jd||||||dIdHS)aJ Use this method to delete a sticker set that was created by the bot. .. versionadded:: 20.2 Args: name (:obj:`str`): Sticker set name. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rdeleteStickerSetrNr )rrrrrrrrrrrdelete_sticker_setszBot.delete_sticker_set) rrformatr#rrrrrrc s:|||r||nd|d} |jd| ||||| dIdHS)a Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. .. versionadded:: 20.2 .. versionchanged:: 21.1 As per Bot API 7.2, the new argument :paramref:`format` will be required, and thus the order of the arguments had to be changed. Args: name (:obj:`str`): Sticker set name user_id (:obj:`int`): User identifier of created sticker set owner. format (:obj:`str`): Format of the added sticker, must be one of :tg-const:`telegram.constants.StickerFormat.STATIC` for a ``.WEBP`` or ``.PNG`` image, :tg-const:`telegram.constants.StickerFormat.ANIMATED` for a ``.TGS`` animation, :tg-const:`telegram.constants.StickerFormat.VIDEO` for a WEBM video. .. versionadded:: 21.1 thumbnail (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path`, optional): A **.WEBP** or **.PNG** image with the thumbnail, must be up to :tg-const:`telegram.constants.StickerSetLimit.MAX_STATIC_THUMBNAIL_SIZE` kilobytes in size and have width and height of exactly :tg-const:`telegram.constants.StickerSetLimit.STATIC_THUMB_DIMENSIONS` px, or a **.TGS** animation with the thumbnail up to :tg-const:`telegram.constants.StickerSetLimit.MAX_ANIMATED_THUMBNAIL_SIZE` kilobytes in size; see `the docs `_ for animated sticker technical requirements, or a **.WEBM** video with the thumbnail up to :tg-const:`telegram.constants.StickerSetLimit.MAX_ANIMATED_THUMBNAIL_SIZE` kilobytes in size; see `this `_ for video sticker technical requirements. |fileinput| Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` N)rrr#rHsetStickerSetThumbnailrr) rrrrHr#rrrrrrrrrset_sticker_set_thumbnails?zBot.set_sticker_set_thumbnail)rr"rrrrrrc s(||d}|jd||||||dIdHS)a Use this method to set the title of a created sticker set. .. versionadded:: 20.2 Args: name (:obj:`str`): Sticker set name. title (:obj:`str`): Sticker set title, :tg-const:`telegram.constants.StickerLimit.MIN_NAME_AND_TITLE`- :tg-const:`telegram.constants.StickerLimit.MAX_NAME_AND_TITLE` characters. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rr"setStickerSetTitlerNr ) rrr"rrrrrrrrrset_sticker_set_titleOs zBot.set_sticker_set_title)r+ emoji_listrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. .. versionadded:: 20.2 Args: sticker (:obj:`str`): File identifier of the sticker. emoji_list (Sequence[:obj:`str`]): A sequence of :tg-const:`telegram.constants.StickerLimit.MIN_STICKER_EMOJI`- :tg-const:`telegram.constants.StickerLimit.MAX_STICKER_EMOJI` emoji associated with the sticker. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )r+rMsetStickerEmojiListrNr ) rr+rMrrrrrrrrrset_sticker_emoji_listws zBot.set_sticker_emoji_list)r+keywordsrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. .. versionadded:: 20.2 Args: sticker (:obj:`str`): File identifier of the sticker. keywords (Sequence[:obj:`str`]): A sequence of 0-:tg-const:`telegram.constants.StickerLimit.MAX_SEARCH_KEYWORDS` search keywords for the sticker with total length up to :tg-const:`telegram.constants.StickerLimit.MAX_KEYWORD_LENGTH` characters. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )r+rPsetStickerKeywordsrNr ) rr+rPrrrrrrrrrset_sticker_keywordss zBot.set_sticker_keywords)r+ mask_positionrrrrrrc s(||d}|jd||||||dIdHS)a} Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. .. versionadded:: 20.2 Args: sticker (:obj:`str`): File identifier of the sticker. mask_position (:class:`telegram.MaskPosition`, optional): A object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )r+rSsetStickerMaskPositionrNr ) rr+rSrrrrrrrrrset_sticker_mask_positions zBot.set_sticker_mask_position)rcustom_emoji_idrrrrrrc s(||d}|jd||||||dIdHS)a/ Use this method to set the thumbnail of a custom emoji sticker set. .. versionadded:: 20.2 Args: name (:obj:`str`): Sticker set name. custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrV!setCustomEmojiStickerSetThumbnailrNr ) rrrVrrrrrrrrr&set_custom_emoji_sticker_set_thumbnails z*Bot.set_custom_emoji_sticker_set_thumbnailrk)rerrorsrrrrrrc s(||d}|jd||||||dIdHS)a Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. Args: user_id (:obj:`int`): User identifier errors (Sequence[:class:`PassportElementError`]): A Sequence describing the errors. .. versionchanged:: 20.0 |sequenceargs| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrYsetPassportDataErrorsrNr ) rrrYrrrrrrrrrset_passport_data_errorss# zBot.set_passport_data_errorsr:)rquestionoptionsrtypeallows_multiple_answerscorrect_option_id is_closedrr explanationexplanation_parse_mode open_period close_dateexplanation_entitiesrrrrquestion_parse_modequestion_entitiesrrrrrrrrrcs^||dd|D| |||||| || |||d}|jd||| | |||||||||||dIdHS)a' Use this method to send a native poll. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| question (:obj:`str`): Poll question, :tg-const:`telegram.Poll.MIN_QUESTION_LENGTH`- :tg-const:`telegram.Poll.MAX_QUESTION_LENGTH` characters. options (Sequence[:obj:`str` | :class:`telegram.InputPollOption`]): Sequence of :tg-const:`telegram.Poll.MIN_OPTION_NUMBER`- :tg-const:`telegram.Poll.MAX_OPTION_NUMBER` answer options. Each option may either be a string with :tg-const:`telegram.Poll.MIN_OPTION_LENGTH`- :tg-const:`telegram.Poll.MAX_OPTION_LENGTH` characters or an :class:`~telegram.InputPollOption` object. Strings are converted to :class:`~telegram.InputPollOption` objects automatically. .. versionchanged:: 20.0 |sequenceargs| .. versionchanged:: 21.2 Bot API 7.3 adds support for :class:`~telegram.InputPollOption` objects. is_anonymous (:obj:`bool`, optional): :obj:`True`, if the poll needs to be anonymous, defaults to :obj:`True`. type (:obj:`str`, optional): Poll type, :tg-const:`telegram.Poll.QUIZ` or :tg-const:`telegram.Poll.REGULAR`, defaults to :tg-const:`telegram.Poll.REGULAR`. allows_multiple_answers (:obj:`bool`, optional): :obj:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :obj:`False`. correct_option_id (:obj:`int`, optional): 0-based identifier of the correct answer option, required for polls in quiz mode. explanation (:obj:`str`, optional): Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-:tg-const:`telegram.Poll.MAX_EXPLANATION_LENGTH` characters with at most :tg-const:`telegram.Poll.MAX_EXPLANATION_LINE_FEEDS` line feeds after entities parsing. explanation_parse_mode (:obj:`str`, optional): Mode for parsing entities in the explanation. See the constants in :class:`telegram.constants.ParseMode` for the available modes. explanation_entities (Sequence[:class:`telegram.MessageEntity`], optional): Sequence of special entities that appear in message text, which can be specified instead of :paramref:`explanation_parse_mode`. .. versionchanged:: 20.0 |sequenceargs| open_period (:obj:`int`, optional): Amount of time in seconds the poll will be active after creation, :tg-const:`telegram.Poll.MIN_OPEN_PERIOD`- :tg-const:`telegram.Poll.MAX_OPEN_PERIOD`. Can't be used together with :paramref:`close_date`. close_date (:obj:`int` | :obj:`datetime.datetime`, optional): Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least :tg-const:`telegram.Poll.MIN_OPEN_PERIOD` and no more than :tg-const:`telegram.Poll.MAX_OPEN_PERIOD` seconds in the future. Can't be used together with :paramref:`open_period`. For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. is_closed (:obj:`bool`, optional): Pass :obj:`True`, if the poll needs to be immediately closed. This can be useful for poll preview. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 question_parse_mode (:obj:`str`, optional): Mode for parsing entities in the question. See the constants in :class:`telegram.constants.ParseMode` for the available modes. Currently, only custom emoji entities are allowed. .. versionadded:: 21.2 question_entities (Sequence[:class:`telegram.Message`], optional): Special entities that appear in the poll :paramref:`question`. It can be specified instead of :paramref:`question_parse_mode`. .. versionadded:: 21.2 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` cSs"g|]}t|trt|n|qSr)rrrr:)roptionrrrrsz!Bot.send_poll..)rr\r]rcrr^r_r`rarbrfrdrergrhsendPollr.Nr)rrr\r]rr^r_r`rarrrbrcrdrerfrrrrrgrhrrrrrrrrrrrr send_pollHsJz Bot.send_poll) rrrrrrrrrrc s8||||d} |jd| ||||| dIdH} t| |S)a Use this method to stop a poll which was sent by the bot. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_id (:obj:`int`): Identifier of the original message with the poll. reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new message inline keyboard. business_connection_id (:obj:`str`, optional): |business_id_str_edit| .. versionadded:: 21.4 Returns: :class:`telegram.Poll`: On success, the stopped Poll is returned. Raises: :class:`telegram.error.TelegramError` )rrrrstopPollrN)rr;r) rrrrrrrrrrrrrrr stop_polls! z Bot.stop_poll)rrrr,rrrrrrrrrrrrrc s:||d}|jd|| ||| |||| | ||||| dIdHS)a Use this method to send an animated emoji that will display a random value. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| disable_notification (:obj:`bool`, optional): |disable_notification| reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user emoji (:obj:`str`, optional): Emoji on which the dice throw animation is based. Currently, must be one of :class:`telegram.constants.DiceEmoji`. Dice can have values :tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BOWLING` for :tg-const:`telegram.Dice.DICE`, :tg-const:`telegram.Dice.DARTS` and :tg-const:`telegram.Dice.BOWLING`, values :tg-const:`telegram.Dice.MIN_VALUE`-:tg-const:`telegram.Dice.MAX_VALUE_BASKETBALL` for :tg-const:`telegram.Dice.BASKETBALL` and :tg-const:`telegram.Dice.FOOTBALL`, and values :tg-const:`telegram.Dice.MIN_VALUE`- :tg-const:`telegram.Dice.MAX_VALUE_SLOT_MACHINE` for :tg-const:`telegram.Dice.SLOT_MACHINE`. Defaults to :tg-const:`telegram.Dice.DICE`. .. versionchanged:: 13.4 Added the :tg-const:`telegram.Dice.BOWLING` emoji. protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.1 message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.Message`: On success, the sent Message is returned. Raises: :class:`telegram.error.TelegramError` )rr,sendDicer.Nr)rrrrr,rrrrrrrrrrrrrrrr send_dice7s&Y z Bot.send_dice) for_channelsrrrrrrc s2d|i}|jd||||||dIdH}t||S)a\Use this method to get the current default administrator rights of the bot. .. seealso:: :meth:`set_my_default_administrator_rights` .. versionadded:: 20.0 Args: for_channels (:obj:`bool`, optional): Pass :obj:`True` to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. Returns: :class:`telegram.ChatAdministratorRights`: On success. Raises: :class:`telegram.error.TelegramError` rpgetMyDefaultAdministratorRightsrN)rrr) rrprrrrrrrrrr#get_my_default_administrator_rightss z'Bot.get_my_default_administrator_rights)rightsrprrrrrrc s(||d}|jd||||||dIdHS)a,Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. .. seealso:: :meth:`get_my_default_administrator_rights` .. versionadded:: 20.0 Args: rights (:class:`telegram.ChatAdministratorRights`, optional): A :class:`telegram.ChatAdministratorRights` object describing new default administrator rights. If not specified, the default administrator rights will be cleared. for_channels (:obj:`bool`, optional): Pass :obj:`True` to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. Returns: :obj:`bool`: Returns :obj:`True` on success. Raises: :exc:`telegram.error.TelegramError` )rsrpsetMyDefaultAdministratorRightsrNr ) rrsrprrrrrrrrr#set_my_default_administrator_rightss" z'Bot.set_my_default_administrator_rights)scope language_coderrrrrrc s4||d}|jd||||||dIdH} t| |S)a Use this method to get the current list of the bot's commands for the given scope and user language. .. seealso:: :meth:`set_my_commands`, :meth:`delete_my_commands` .. versionchanged:: 20.0 Returns a tuple instead of a list. Args: scope (:class:`telegram.BotCommandScope`, optional): An object, describing scope of users. Defaults to :class:`telegram.BotCommandScopeDefault`. .. versionadded:: 13.7 language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code or an empty string. .. versionadded:: 13.7 Returns: Tuple[:class:`telegram.BotCommand`]: On success, the commands set for the bot. An empty tuple is returned if commands are not set. Raises: :class:`telegram.error.TelegramError` rvrw getMyCommandsrN)rrr) rrvrwrrrrrrrrrrget_my_commandss'  zBot.get_my_commands) commandsrvrwrrrrrrc s8dd|D} | ||d} |jd| |||||dIdHS)a` Use this method to change the list of the bot's commands. See the `Telegram docs `_ for more details about bot commands. .. seealso:: :meth:`get_my_commands`, :meth:`delete_my_commands` Args: commands (Sequence[:class:`BotCommand` | (:obj:`str`, :obj:`str`)]): A sequence of bot commands to be set as the list of the bot's commands. At most :tg-const:`telegram.constants.BotCommandLimit.MAX_COMMAND_NUMBER` commands can be specified. Note: If you pass in a sequence of :obj:`tuple`, the order of elements in each :obj:`tuple` must correspond to the order of positional arguments to create a :class:`BotCommand` instance. .. versionchanged:: 20.0 |sequenceargs| scope (:class:`telegram.BotCommandScope`, optional): An object, describing scope of users for which the commands are relevant. Defaults to :class:`telegram.BotCommandScopeDefault`. .. versionadded:: 13.7 language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. .. versionadded:: 13.7 Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` cSs,g|]$}t|tr|nt|d|dqS)rr)rr)rcrrrrdsz'Bot.set_my_commands..)r{rvrw setMyCommandsrNr ) rr{rvrwrrrrrZcmdsrrrrset_my_commands1s3 zBot.set_my_commandsc s(||d}|jd||||||dIdHS)a Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, `higher level commands `_ will be shown to affected users. .. versionadded:: 13.7 .. seealso:: :meth:`get_my_commands`, :meth:`set_my_commands` Args: scope (:class:`telegram.BotCommandScope`, optional): An object, describing scope of users for which the commands are relevant. Defaults to :class:`telegram.BotCommandScopeDefault`. language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rxdeleteMyCommandsrNr ) rrvrwrrrrrrrrrdelete_my_commandsqs# zBot.delete_my_commandscs|jd|||||dIdHS)a0 Use this method to log out from the cloud Bot API server before launching the bot locally. You *must* log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns: :obj:`True`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` logOutrNr rrrrrrrrrlog_outsz Bot.log_outcs|jd|||||dIdHS)a Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns: :obj:`True`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` closerNr rrrrrsz Bot.close)rrrrrrrrrrrrrrrrrrrrc  s| tk r| dk rtd|dk r0| dk r0td|dk rDt|| d} |||||| |||| | | d }|jd||||||dIdH}t||S)a) Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. The method is analogous to the method :meth:`forward_message`, but the copied message doesn't have a link to the original message. Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the original message was sent (or channel username in the format ``@channelusername``). message_id (:obj:`int`): Message identifier in the chat specified in from_chat_id. caption (:obj:`str`, optional): New caption for media, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. If not specified, the original caption is kept. parse_mode (:obj:`str`, optional): Mode for parsing entities in the new caption. See the constants in :class:`telegram.constants.ParseMode` for the available modes. caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceargs| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| .. versionadded:: 13.10 message_thread_id (:obj:`int`, optional): |message_thread_id_arg| .. versionadded:: 20.0 reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| .. versionadded:: 20.8 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for .. versionchanged:: 20.8 Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated| .. versionchanged:: 21.0 |keyword_only_arg| Returns: :class:`telegram.MessageId`: On success, the :class:`telegram.MessageId` of the sent message is returned. Raises: :class:`telegram.error.TelegramError` Nrrr) rrrrrrrrrrrr copyMessager)rGrr?rr8r)rrrrrrrrrrrrrrrrrrrrrrrrr copy_messagesHZ zBot.copy_message)r8.) rrrrrrremove_captionrrrrrrc s>|||||||d} |jd| || | | | dIdH}t||S)aV Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field :attr:`telegram.Poll.correct_option_id` is known to the bot. The method is analogous to the method :meth:`forward_messages`, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. .. versionadded:: 20.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| from_chat_id (:obj:`int` | :obj:`str`): Unique identifier for the chat where the original message was sent (or channel username in the format ``@channelusername``). message_ids (Sequence[:obj:`int`]): A list of :tg-const:`telegram.constants.BulkRequestLimit.MIN_LIMIT` - :tg-const:`telegram.constants.BulkRequestLimit.MAX_LIMIT` identifiers of messages in the chat :paramref:`from_chat_id` to copy. The identifiers must be specified in a strictly increasing order. disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| message_thread_id (:obj:`int`, optional): |message_thread_id_arg| remove_caption (:obj:`bool`, optional): Pass :obj:`True` to copy the messages without their captions. Returns: Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. Raises: :class:`telegram.error.TelegramError` )rrrrrrr copyMessagesrNr)rrrrrrrrrrrrrrrrrr copy_messagescs$3  zBot.copy_messages)r menu_buttonrrrrrrc s(||d}|jd||||||dIdHS)aUse this method to change the bot's menu button in a private chat, or the default menu button. .. seealso:: :meth:`get_chat_menu_button`, :meth:`telegram.Chat.get_menu_button` :meth:`telegram.User.get_menu_button` .. versionadded:: 20.0 Args: chat_id (:obj:`int`, optional): Unique identifier for the target private chat. If not specified, default bot's menu button will be changed menu_button (:class:`telegram.MenuButton`, optional): An object for the new bot's menu button. Defaults to :class:`telegram.MenuButtonDefault`. Returns: :obj:`bool`: On success, :obj:`True` is returned. )rrsetChatMenuButtonrNr ) rrrrrrrrrrrrset_chat_menu_buttons zBot.set_chat_menu_buttonc s4d|i}|jd||||||dIdH}tj||dS)aTUse this method to get the current value of the bot's menu button in a private chat, or the default menu button. .. seealso:: :meth:`set_chat_menu_button`, :meth:`telegram.Chat.set_menu_button`, :meth:`telegram.User.set_menu_button` .. versionadded:: 20.0 Args: chat_id (:obj:`int`, optional): Unique identifier for the target private chat. If not specified, default bot's menu button will be returned. Returns: :class:`telegram.MenuButton`: On success, the current menu button is returned. rgetChatMenuButtonrNr)rr6rrrrrget_chat_menu_buttons zBot.get_chat_menu_button)r"rrrrrrrrrrrrrrrrrrrrrrrrrcsL||||||||| | | | | |||||||d}|jd||||||dIdHS)asUse this method to create a link for an invoice. .. versionadded:: 20.0 Args: title (:obj:`str`): Product name. :tg-const:`telegram.Invoice.MIN_TITLE_LENGTH`- :tg-const:`telegram.Invoice.MAX_TITLE_LENGTH` characters. description (:obj:`str`): Product description. :tg-const:`telegram.Invoice.MIN_DESCRIPTION_LENGTH`- :tg-const:`telegram.Invoice.MAX_DESCRIPTION_LENGTH` characters. payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be displayed to the user, use it for your internal processes. provider_token (:obj:`str`): Payments provider token, obtained via `@BotFather `_. Pass an empty string for payments in |tg_stars|. .. deprecated:: 21.3 As of Bot API 7.4, this parameter is now optional and future versions of the library will make it optional as well. currency (:obj:`str`): Three-letter ISO 4217 currency code, see `more on currencies `_. Pass ``XTR`` for payments in |tg_stars|. prices (Sequence[:class:`telegram.LabeledPrice`)]: Price breakdown, a sequence of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in |tg_stars|. .. versionchanged:: 20.0 |sequenceargs| max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the ``exp`` parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to ``0``. Not supported for payments in |tg_stars|. suggested_tip_amounts (Sequence[:obj:`int`], optional): An array of suggested amounts of tips in the *smallest units* of the currency (integer, **not** float/double). At most :tg-const:`telegram.Invoice.MAX_TIP_AMOUNTS` suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed :paramref:`max_tip_amount`. .. versionchanged:: 20.0 |sequenceargs| provider_data (:obj:`str` | :obj:`object`, optional): Data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. When an object is passed, it will be encoded as JSON. photo_url (:obj:`str`, optional): URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. photo_size (:obj:`int`, optional): Photo size in bytes. photo_width (:obj:`int`, optional): Photo width. photo_height (:obj:`int`, optional): Photo height. need_name (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's full name to complete the order. Ignored for payments in |tg_stars|. need_phone_number (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's phone number to complete the order. Ignored for payments in |tg_stars|. need_email (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's email address to complete the order. Ignored for payments in |tg_stars|. need_shipping_address (:obj:`bool`, optional): Pass :obj:`True`, if you require the user's shipping address to complete the order. Ignored for payments in |tg_stars|. send_phone_number_to_provider (:obj:`bool`, optional): Pass :obj:`True`, if user's phone number should be sent to provider. Ignored for payments in |tg_stars|. send_email_to_provider (:obj:`bool`, optional): Pass :obj:`True`, if user's email address should be sent to provider. Ignored for payments in |tg_stars|. is_flexible (:obj:`bool`, optional): Pass :obj:`True`, if the final price depends on the shipping method. Ignored for payments in |tg_stars|. Returns: :class:`str`: On success, the created invoice link is returned. )r"rrrrrrrrrrrrrrrrrrrcreateInvoiceLinkrNr )rr"rrrrrrrrrrrrrrrrrrrrrrrrrrrrcreate_invoice_links<izBot.create_invoice_linkcs(|jd|||||dIdH}t||S)a.Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. .. versionadded:: 20.0 Returns: Tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` getForumTopicIconStickersrNr5rrrrget_forum_topic_icon_stickerss z!Bot.get_forum_topic_icon_stickers) rr icon_coloricon_custom_emoji_idrrrrrrc s8||||d} |jd| ||||| dIdH} t| |S)a Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| name (:obj:`str`): New topic name, :tg-const:`telegram.constants.ForumTopicLimit.MIN_NAME_LENGTH`- :tg-const:`telegram.constants.ForumTopicLimit.MAX_NAME_LENGTH` characters. icon_color (:obj:`int`, optional): Color of the topic icon in RGB format. Currently, must be one of :attr:`telegram.constants.ForumIconColor.BLUE`, :attr:`telegram.constants.ForumIconColor.YELLOW`, :attr:`telegram.constants.ForumIconColor.PURPLE`, :attr:`telegram.constants.ForumIconColor.GREEN`, :attr:`telegram.constants.ForumIconColor.PINK`, or :attr:`telegram.constants.ForumIconColor.RED`. icon_custom_emoji_id (:obj:`str`, optional): New unique identifier of the custom emoji shown as the topic icon. Use :meth:`~telegram.Bot.get_forum_topic_icon_stickers` to get all allowed custom emoji identifiers. Returns: :class:`telegram.ForumTopic` Raises: :class:`telegram.error.TelegramError` )rrrrcreateForumTopicrN)rr3r) rrrrrrrrrrrrrrrcreate_forum_topics+ zBot.create_forum_topic) rrrrrrrrrrc s,||||d} |jd| ||||| dIdHS)a* Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the :paramref:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights, unless it is the creator of the topic. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| message_thread_id (:obj:`int`): |message_thread_id| name (:obj:`str`, optional): New topic name, :tg-const:`telegram.constants.ForumTopicLimit.MIN_NAME_LENGTH`- :tg-const:`telegram.constants.ForumTopicLimit.MAX_NAME_LENGTH` characters. If not specified or empty, the current name of the topic will be kept. icon_custom_emoji_id (:obj:`str`, optional): New unique identifier of the custom emoji shown as the topic icon. Use :meth:`~telegram.Bot.get_forum_topic_icon_stickers` to get all allowed custom emoji identifiers.Pass an empty string to remove the icon. If not specified, the current icon will be kept. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrreditForumTopicrNr ) rrrrrrrrrrrrrredit_forum_topics)zBot.edit_forum_topic)rrrrrrrrc s(||d}|jd||||||dIdHS)aw Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights, unless it is the creator of the topic. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| message_thread_id (:obj:`int`): |message_thread_id| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rrcloseForumTopicrNr  rrrrrrrrrrrrclose_forum_topic szBot.close_forum_topicc s(||d}|jd||||||dIdHS)ay Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights, unless it is the creator of the topic. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| message_thread_id (:obj:`int`): |message_thread_id| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rreopenForumTopicrNr rrrrreopen_forum_topicA szBot.reopen_forum_topicc s(||d}|jd||||||dIdHS)ag Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_delete_messages` administrator rights. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| message_thread_id (:obj:`int`): |message_thread_id| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rdeleteForumTopicrNr rrrrdelete_forum_topicm szBot.delete_forum_topicc s(||d}|jd||||||dIdHS)ae Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` administrator rights in the supergroup. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| message_thread_id (:obj:`int`): |message_thread_id| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` runpinAllForumTopicMessagesrNr rrrrunpin_all_forum_topic_messages sz"Bot.unpin_all_forum_topic_messagesc s&d|i}|jd||||||dIdHS)a, Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` administrator rights in the supergroup. .. versionadded:: 20.5 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` r!unpinAllGeneralForumTopicMessagesrNr rrrr&unpin_all_general_forum_topic_messages sz*Bot.unpin_all_general_forum_topic_messages)rrrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| name (:obj:`str`): New topic name, :tg-const:`telegram.constants.ForumTopicLimit.MIN_NAME_LENGTH`- :tg-const:`telegram.constants.ForumTopicLimit.MAX_NAME_LENGTH` characters. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rreditGeneralForumTopicrNr ) rrrrrrrrrrrredit_general_forum_topic s zBot.edit_general_forum_topicc s&d|i}|jd||||||dIdHS)a Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rcloseGeneralForumTopicrNr rrrrclose_general_forum_topic!szBot.close_general_forum_topicc s&d|i}|jd||||||dIdHS)aS Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. The topic will be automatically unhidden if it was hidden. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rreopenGeneralForumTopicrNr rrrrreopen_general_forum_topic=!szBot.reopen_general_forum_topicc s&d|i}|jd||||||dIdHS)aH Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. The topic will be automatically closed if it was open. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` rhideGeneralForumTopicrNr rrrrhide_general_forum_topice!szBot.hide_general_forum_topicc s&d|i}|jd||||||dIdHS)a  Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. .. versionadded:: 20.0 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_group| Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` runhideGeneralForumTopicrNr rrrrunhide_general_forum_topic!szBot.unhide_general_forum_topic)rrwrrrrrrc s(||d}|jd||||||dIdHS)aN Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. .. versionadded:: 20.2 Args: description (:obj:`str`, optional): New bot description; 0-:tg-const:`telegram.constants.BotDescriptionLimit.MAX_DESCRIPTION_LENGTH` characters. Pass an empty string to remove the dedicated description for the given language. language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrwsetMyDescriptionrNr ) rrrwrrrrrrrrrset_my_description!s! zBot.set_my_description)short_descriptionrwrrrrrrc s(||d}|jd||||||dIdHS)a Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. .. versionadded:: 20.2 Args: short_description (:obj:`str`, optional): New short description for the bot; 0-:tg-const:`telegram.constants.BotDescriptionLimit.MAX_SHORT_DESCRIPTION_LENGTH` characters. Pass an empty string to remove the dedicated description for the given language. language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrwsetMyShortDescriptionrNr ) rrrwrrrrrrrrrset_my_short_description!s! zBot.set_my_short_description)rwrrrrrrc s0d|i}tj|jd||||||dIdH|dS)a Use this method to get the current bot description for the given user language. Args: language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code or an empty string. Returns: :class:`telegram.BotDescription`: On success, the bot description is returned. Raises: :class:`telegram.error.TelegramError` rwgetMyDescriptionrNr)rrrrrwrrrrrrrrrget_my_description"s zBot.get_my_descriptionc s0d|i}tj|jd||||||dIdH|dS)a Use this method to get the current bot short description for the given user language. Args: language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code or an empty string. Returns: :class:`telegram.BotShortDescription`: On success, the bot short description is returned. Raises: :class:`telegram.error.TelegramError` rwgetMyShortDescriptionrNr)rrrrrrrget_my_short_description4"s zBot.get_my_short_description)rrwrrrrrrc s(||d}|jd||||||dIdHS)ai Use this method to change the bot's name. .. versionadded:: 20.3 Args: name (:obj:`str`, optional): New bot name; 0-:tg-const:`telegram.constants.BotNameLimit.MAX_NAME_LENGTH` characters. Pass an empty string to remove the dedicated name for the given language. Caution: If :paramref:`language_code` is not specified, a :paramref:`name` *must* be specified. language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty, the name will be applied to all users for whose language there is no dedicated name. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrw setMyNamerNr ) rrrwrrrrrrrrr set_my_name["s$ zBot.set_my_namec s0d|i}tj|jd||||||dIdH|dS)a Use this method to get the current bot name for the given user language. Args: language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code or an empty string. Returns: :class:`telegram.BotName`: On success, the bot name is returned. Raises: :class:`telegram.error.TelegramError` rw getMyNamerNr)rrrrrrr get_my_name"s zBot.get_my_namec s2||d}tj|jd||||||dIdH|dS)a Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. .. versionadded:: 20.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| user_id (:obj:`int`): Unique identifier of the target user. Returns: :class:`telegram.UserChatBoosts`: On success, the object containing the list of boosts is returned. Raises: :class:`telegram.error.TelegramError` rgetUserChatBoostsrNr)rrrrrrrget_user_chat_boosts"s  zBot.get_user_chat_boosts) rrreactionis_bigrrrrrrc sftt|dk r6fddt|ttfr.|gn|Dnd} ||| |d} |jd| ||||| dIdHS)a Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. .. versionadded:: 20.8 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| message_id (:obj:`int`): Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead. reaction (Sequence[:class:`telegram.ReactionType` | :obj:`str`] | :class:`telegram.ReactionType` | :obj:`str`, optional): A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. Tip: Passed :obj:`str` values will be converted to either :class:`telegram.ReactionTypeEmoji` or :class:`telegram.ReactionTypeCustomEmoji` depending on whether they are listed in :class:`~telegram.constants.ReactionEmoji`. is_big (:obj:`bool`, optional): Pass :obj:`True` to set the reaction with a big animation. Returns: :obj:`bool` On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` Ncs6g|].}t|tr|n|kr(t|dnt|dqS))r,)rV)rr<r>r=)rentryZallowed_reactionsrrr #s   z,Bot.set_message_reaction..)rrrrsetMessageReactionr)setrWrr<rrr) rrrrrrrrrrZparsed_reactionrrrrset_message_reaction"s*0 zBot.set_message_reaction)rrrrrrrc s0d|i}tj|jd||||||dIdH|dS)a Use this method to get information about the connection of the bot with a business account. .. versionadded:: 21.1 Args: business_connection_id (:obj:`str`): Unique identifier of the business connection. Returns: :class:`telegram.BusinessConnection`: On success, the object containing the business connection information is returned. Raises: :class:`telegram.error.TelegramError` rgetBusinessConnectionrNr)rrr)rrrrrrrrrrrget_business_connection0#s zBot.get_business_connection) rr old_stickerr+rrrrrrc s,||||d} |jd| ||||| dIdHS)aoUse this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling :meth:`delete_sticker_from_set`, then :meth:`add_sticker_to_set`, then :meth:`set_sticker_position_in_set`. .. versionadded:: 21.1 Args: user_id (:obj:`int`): User identifier of the sticker set owner. name (:obj:`str`): Sticker set name. old_sticker (:obj:`str`): File identifier of the replaced sticker. sticker (:class:`telegram.InputSticker`): An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrr+replaceStickerInSetrNr ) rrrrr+rrrrrrrrrreplace_sticker_in_setW#s"zBot.replace_sticker_in_set)rtelegram_payment_charge_idrrrrrrc s(||d}|jd||||||dIdHS)aRefunds a successful payment in |tg_stars|. .. versionadded:: 21.3 Args: user_id (:obj:`int`): User identifier of the user whose payment will be refunded. telegram_payment_charge_id (:obj:`str`): Telegram payment identifier. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :class:`telegram.error.TelegramError` )rrrefundStarPaymentrNr ) rrrrrrrrrrrrrefund_star_payment#szBot.refund_star_payment)rrrrrrrrc s2||d}tj|jd||||||dIdH|dS)aReturns the bot's Telegram Star transactions in chronological order. .. versionadded:: 21.4 Args: offset (:obj:`int`, optional): Number of transactions to skip in the response. limit (:obj:`int`, optional): The maximum number of transactions to be retrieved. Values between :tg-const:`telegram.constants.StarTransactionsLimit.MIN_LIMIT`- :tg-const:`telegram.constants.StarTransactionsLimit.MAX_LIMIT` are accepted. Defaults to :tg-const:`telegram.constants.StarTransactionsLimit.MAX_LIMIT`. Returns: :class:`telegram.StarTransactions`: On success. Raises: :class:`telegram.error.TelegramError` )rrgetStarTransactionsrNr)r9rr) rrrrrrrrrrrrget_star_transactions#s  zBot.get_star_transactionsr))r star_countrrrrrrrrrrrrrrrrrrrcsB||||| d}|jd|||||| | | |||||||| dIdHS)aB Use this method to send paid media. .. versionadded:: 21.4 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. star_count (:obj:`int`): The number of Telegram Stars that must be paid to buy access to the media; :tg-const:`telegram.constants.InvoiceLimit.MIN_STAR_COUNT` - :tg-const:`telegram.constants.InvoiceLimit.MAX_STAR_COUNT`. media (Sequence[:class:`telegram.InputPaidMedia`]): A list describing the media to be sent; up to :tg-const:`telegram.constants.MediaGroupLimit.MAX_MEDIA_LENGTH` items. payload (:obj:`str`, optional): Bot-defined paid media payload, 0-:tg-const:`telegram.constants.InvoiceLimit.MAX_PAYLOAD_LENGTH` bytes. This will not be displayed to the user, use it for your internal processes. .. versionadded:: 21.6 caption (:obj:`str`, optional): Caption of the media to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| disable_notification (:obj:`bool`, optional): |disable_notification| protect_content (:obj:`bool`, optional): |protect_content| reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters| reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.5 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id| Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience parameter for Returns: :class:`telegram.Message`: On success, the sent message is returned. Raises: :class:`telegram.error.TelegramError` )rrrrr sendPaidMedia)rrrrrrrrrrrrrrrNr)rrrrrrrrrrrrrrrrrrrrrrrrrsend_paid_media#s2LzBot.send_paid_media) rsubscription_periodsubscription_pricerrrrrrrc s8||||d} |jd| ||||| dIdH} t| |S)a Use this method to create a `subscription invite link `_ for a channel chat. The bot must have the :attr:`~telegram.ChatPermissions.can_invite_users` administrator right. The link can be edited using the :meth:`edit_chat_subscription_invite_link` or revoked using the :meth:`revoke_chat_invite_link`. .. versionadded:: 21.5 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| subscription_period (:obj:`int`): The number of seconds the subscription will be active for before the next payment. Currently, it must always be :tg-const:`telegram.constants.ChatSubscriptionLimit.SUBSCRIPTION_PERIOD` (30 days). subscription_price (:obj:`int`): The number of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; :tg-const:`telegram.constants.ChatSubscriptionLimit.MIN_PRICE`- :tg-const:`telegram.constants.ChatSubscriptionLimit.MAX_PRICE`. name (:obj:`str`, optional): Invite link name; 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. Returns: :class:`telegram.ChatInviteLink` Raises: :class:`telegram.error.TelegramError` )rrrr createChatSubscriptionInviteLinkrNr) rrrrrrrrrrrrrrr$create_chat_subscription_invite_linkE$s* z(Bot.create_chat_subscription_invite_link) rrrrrrrrrc sJt|tr|jn|} || |d} |jd| |||||dIdH} t| |S)a  Use this method to edit a subscription invite link created by the bot. The bot must have :attr:`telegram.ChatPermissions.can_invite_users` administrator right. .. versionadded:: 21.5 Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit. name (:obj:`str`, optional): Invite link name; 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. Tip: Omitting this argument removes the name of the invite link. Returns: :class:`telegram.ChatInviteLink` Raises: :class:`telegram.error.TelegramError` )rrreditChatSubscriptionInviteLinkrNr) rrrrrrrrrrrrrrr"edit_chat_subscription_invite_link$s" z&Bot.edit_chat_subscription_invite_linkT) recursivercCs&|j|j|jd}|jr"|j|d<|S)z,See :meth:`telegram.TelegramObject.to_dict`.)rrrr)rrrr)rrrrrrto_dict$s z Bot.to_dict)rxryNNNNF)NNF)N)NN) NNNNNNNNNNN)NNNNN)NN)NN)NNNN)NN)NN)N)NNNN)NNNNN)NNNNN)NNNN)NNNNNN)N)NNNNN)NNN)NN)N)NN)NNNNNNNNNNNNNNN)N)NNNN)NNNN)N)NN)NN)N)N)N)N)NN)N)NN)NN)NN)NN)NN)N)NNNNNNNNNNNNNN)NN)NN)NN)NN)N)N)NN)N)NN)NN)N)N)T(qr __module__ __qualname____doc__rKr __slots__rrr rZbytesrrrmrr BaseExceptionrrr rrrpobjectrrrrpropertyrzr{r|rrrr}rCrrrrrrrrrr classmethodr_rWarningrrOrrrGrPrQfloatrr rrRr rrrrArrr7r r rrrr8rrr&r*r/r5r9r<r?rEr*rPrUrYr/rar%rfrirlrrurryr5rrDrr"r#r$r&r+r-r0r1r2r'rrrrrrrrrrrrBrrrrrrr rrrrrrUrrr4rrrrr@rr!rr r rrrrrrr r"r$r&r(r*r,r.r0r.r2r6r9r;r>rCrErGrJrLrOrRr,rUrXr[rNrkr;rmrorrrrurrrzr~rrrrrr6rrrrr3rrrrrrrrrrrrrrrrrrrrrrrr<rrrrrr9rrrrrrrr rrrrr%r)r-r4r;r>r8rCrOrRrWr`rerhrkr~rrrrrrrrrrrrrrrrrrrrrrrrrrrrrr r rrrrrrr!r#r%r'r)r+r-r/r4r1r8rBr:r=rDrIrZrjrlrnryr}rrrrrrrqrtrrrrrrrrrrrrrrrrrrWrKrFrNrQrTrrrrrrrrrrrr __classcell__rrrrrns`H            . ( &  ^  ` "     ?  /    F    B        "        z    3       +        1   p 7        c  ; 5.  d 2 E  D  /  1  + D   m   S  G ?  }   u )  &  -  -  (  *  '  #   C E  _ >=3 M  @ . . Q   V  4 - - 2 ) + - : 8 *& 1B@) `%)T-, ,+.3   B 5  p+0 8B2#$       I+/   # ? = 1 1 0 0 , / + , , )//()2+ . Y.7+1  l @  5 )rrrrrrtypesrtypingrrrrrr r r r r rrrrrrZcryptography.hazmat.backendsrZcryptography.hazmat.primitivesrr ImportErrorZtelegram._botcommandrZtelegram._botcommandscoperZtelegram._botdescriptionrrZtelegram._botnamerZtelegram._businessrZ!telegram._chatadministratorrightsrZtelegram._chatboostrZtelegram._chatfullinforZtelegram._chatinvitelinkrZtelegram._chatmemberr Ztelegram._chatpermissionsr!Ztelegram._files.animationr"Ztelegram._files.audior#Ztelegram._files.chatphotor$Ztelegram._files.contactr%Ztelegram._files.documentr&Ztelegram._files.filer'Ztelegram._files.inputmediar(r)Ztelegram._files.locationr*Ztelegram._files.photosizer+Ztelegram._files.stickerr,r-r.Ztelegram._files.venuer/Ztelegram._files.videor0Ztelegram._files.videonoter1Ztelegram._files.voicer2Ztelegram._forumtopicr3Ztelegram._games.gamehighscorer4Z)telegram._inline.inlinequeryresultsbuttonr5Ztelegram._menubuttonr6Ztelegram._messager7Ztelegram._messageidr8Ztelegram._payment.starsr9Ztelegram._pollr:r;Ztelegram._reactionr<r=r>Ztelegram._replyr?Ztelegram._sentwebappmessager@Ztelegram._telegramobjectrAZtelegram._updaterBZtelegram._userrCZtelegram._userprofilephotosrDZtelegram._utils.argumentparsingrErFZtelegram._utils.defaultvaluerGrHZtelegram._utils.filesrIrJZtelegram._utils.loggingrKZtelegram._utils.reprrLZtelegram._utils.stringsrMZtelegram._utils.typesrNrOrPrQrRZtelegram._utils.warningsrTZtelegram._webhookinforUZtelegram.constantsrVrWZtelegram.errorrXrYZtelegram.requestrZr[Ztelegram.request._httpxrequestr\Z"telegram.request._requestparameterr]Ztelegram.warningsr^r_Ztelegramr`rarbrcrdrerfrgrhrirjrkrlrmrnrrrrs  H                                             <