U g}@sdZddlmZmZmZmZmZmZddlm Z ddl m Z ddl m Z mZddlmZddlmZddlmZdd lmZmZmZerdd lmZmZmZmZmZmZmZm Z Gd d d eZ!d S)zGThis module contains an object that represents a Telegram CallbackQuery) TYPE_CHECKINGFinalOptionalSequenceTupleUnion) constants)Location)MaybeInaccessibleMessageMessage)TelegramObject)User) DEFAULT_NONE)JSONDictODVInput ReplyMarkup)Bot GameHighScoreInlineKeyboardMarkup InputMediaLinkPreviewOptions MessageEntity MessageIdReplyParameterscseZdZUdZdZdAddeeeeeeeeeeeee dfddZ e dBee ededd fd d Z dCe e e e dd eeeeeeeeeeeeeeeeee ed ddZdDeedddZe dde fde e e e ddeeeedeededeeeeeeeeeeee eeefd ddZdde ddfe e e e dd eeedeeeedeeeeeeeeeeee eeefd ddZdEe e e e dd edeeeeeeeeee eeefddd ZdFe e e e dd d!edeeeeeeeeee eeefd"d#d$ZdGde e e e dd%eeeeedeeeeeeeeeeeeeeeeeeee eeefd&d'd(ZdHe e e e dd edeeeeeeeeee eeefdd)d*ZdIe e e e dd eeeeeeeeeeeeeeee eeefd+ d,d-Ze e e e dd eeeeeeeeeee ed.d/d0d1Z e e e e dd eeeeeeeeee ed2d3d4Z!e fe e e e dd eeeeeeeeeeee ed5d6d7Z"e e e e dd eeeeeeeeee ed2d8d9Z#de de de dddf e de e e e dd:eeefeeeeeedeeee$eeeeed;eeeeeeeeeeeeeeee dd?Z%e&j'j(Z)e*ee+d@<Z,S)J CallbackQuerya( This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field :attr:`message` will be present. If the button was attached to a message sent via the bot (in inline mode), the field :attr:`inline_message_id` will be present. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`id` is equal. Note: * In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead. * Exactly one of the fields :attr:`data` or :attr:`game_short_name` will be present. * After the user presses an inline button, Telegram clients will display a progress bar until you call :attr:`answer`. It is, therefore, necessary to react by calling :attr:`telegram.Bot.answer_callback_query` even if no notification to the user is needed (e.g., without specifying any of the optional parameters). * If you're using :attr:`telegram.ext.ExtBot.callback_data_cache`, :attr:`data` may be an instance of :class:`telegram.ext.InvalidCallbackData`. This will be the case, if the data associated with the button triggering the :class:`telegram.CallbackQuery` was already deleted or if :attr:`data` was manipulated by a malicious client. .. versionadded:: 13.6 Args: id (:obj:`str`): Unique identifier for this query. from_user (:class:`telegram.User`): Sender. chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. message (:class:`telegram.MaybeInaccessibleMessage`, optional): Message sent by the bot with the callback button that originated the query. .. versionchanged:: 20.8 Accept objects of type :class:`telegram.MaybeInaccessibleMessage` since Bot API 7.0. data (:obj:`str`, optional): Data associated with the callback button. Be aware that the message, which originated the query, can contain no callback buttons with this data. inline_message_id (:obj:`str`, optional): Identifier of the message sent via the bot in inline mode, that originated the query. game_short_name (:obj:`str`, optional): Short name of a Game to be returned, serves as the unique identifier for the game. Attributes: id (:obj:`str`): Unique identifier for this query. from_user (:class:`telegram.User`): Sender. chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. message (:class:`telegram.MaybeInaccessibleMessage`): Optional. Message sent by the bot with the callback button that originated the query. .. versionchanged:: 20.8 Objects may be of type :class:`telegram.MaybeInaccessibleMessage` since Bot API 7.0. data (:obj:`str` | :obj:`object`): Optional. Data associated with the callback button. Be aware that the message, which originated the query, can contain no callback buttons with this data. Tip: The value here is the same as the value passed in :paramref:`telegram.InlineKeyboardButton.callback_data`. inline_message_id (:obj:`str`): Optional. Identifier of the message sent via the bot in inline mode, that originated the query. game_short_name (:obj:`str`): Optional. Short name of a Game to be returned, serves as the unique identifier for the game. ) chat_instancedata from_usergame_short_nameidinline_message_idmessageN api_kwargs)rrrr!rr rr#c sNtj|d||_||_||_||_||_||_||_|jf|_ | dS)Nr") super__init__rrrr!rr rZ _id_attrsZ_freeze) selfrrrr!rr rr# __class__;/tmp/pip-unpacked-wheel-swnnwir2/telegram/_callbackquery.pyr%{s  zCallbackQuery.__init__r)rbotreturncsP||}|sdSt|dd||d<t|d||d<tj||dS)z,See :meth:`telegram.TelegramObject.de_json`.Nfromrr!)rr+)Z _parse_datar de_jsonpopr getr$)clsrr+r'r)r*r.s  zCallbackQuery.de_json read_timeout write_timeoutconnect_timeout pool_timeoutr#) text show_alerturl cache_timer3r4r5r6r#r,c s*|j|j||||||||| d IdHS)a1Shortcut for:: await bot.answer_callback_query(update.callback_query.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.answer_callback_query`. Returns: :obj:`bool`: On success, :obj:`True` is returned. ) Zcallback_query_idr7r8r9r:r3r4r5r6r#N)get_botZanswer_callback_queryr) r&r7r8r9r:r3r4r5r6r#r)r)r*answerszCallbackQuery.answeredit)actionr,cCs"t|jtstd|d|jS)zHelper method to get the message for the shortcut methods. Must be called only if :attr:`inline_message_id` is *not* set. zCannot z an inaccessible message) isinstancer!r TypeError)r&r>r)r)r* _get_messages zCallbackQuery._get_message)disable_web_page_previewr3r4r5r6r#rrr) r7 parse_mode reply_markupentitieslink_preview_optionsrBr3r4r5r6r#r,c sd|jr:|j|j|||||||| | | |ddddIdHS|j|||||||| | | |d IdHS)aShortcut for either:: await update.callback_query.message.edit_text(*args, **kwargs) or:: await bot.edit_message_text( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs, ) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_text` and :meth:`telegram.Message.edit_text`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N)r r7rCrBrFrDr3r4r5r6r#rEchat_id message_idbusiness_connection_id) r7rCrBrFrDr3r4r5r6r#rE)r r;edit_message_textrAZ edit_text) r&r7rCrDrErFrBr3r4r5r6r#r)r)r*rJs>' zCallbackQuery.edit_message_text) captionrDrCcaption_entitiesshow_caption_above_mediar3r4r5r6r#r,c s`|jr8|j||j||||| || |dd|ddIdHS|j|||||| || ||d IdHS)a%Shortcut for either:: await update.callback_query.message.edit_caption(*args, **kwargs) or:: await bot.edit_message_caption( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs, ) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_caption` and :meth:`telegram.Message.edit_caption`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N)rKr rDr3r4r5r6rCr#rLrGrHrMrI) rKrDr3r4r5r6rCr#rLrM)r r;edit_message_captionrAZ edit_caption) r&rKrDrCrLrMr3r4r5r6r#r)r)r*rNs:& z"CallbackQuery.edit_message_caption)rDr3r4r5r6r#r,c sP|jr0|j||j|||||dddd IdHS|j||||||dIdHS)a@Shortcut for either:: await update.callback_query.message.edit_reply_markup(*args, **kwargs) or:: await bot.edit_message_reply_markup( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_reply_markup` and :meth:`telegram.Message.edit_reply_markup`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N) rDr r3r4r5r6r#rGrHrIrDr3r4r5r6r#)r r;edit_message_reply_markuprAZedit_reply_markupr&rDr3r4r5r6r#r)r)r*rP_s*# z'CallbackQuery.edit_message_reply_markupr)mediarDr3r4r5r6r#r,c sT|jr2|j|j|||||||dddd IdHS|j|||||||dIdHS)a"Shortcut for either:: await update.callback_query.message.edit_media(*args, **kwargs) or:: await bot.edit_message_media( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_media` and :meth:`telegram.Message.edit_media`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. 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:`TypeError` if :attr:`message` is not accessible. N) r rRrDr3r4r5r6r#rGrHrI)rRrDr3r4r5r6r#)r r;edit_message_mediarAZ edit_media)r&rRrDr3r4r5r6r#r)r)r*rSs.# z CallbackQuery.edit_message_media)locationr3r4r5r6r#)latitude longituderDhorizontal_accuracyheadingproximity_alert_radius live_periodrTr3r4r5r6r#r,csl|jr>|j|j||||| | | | | ||||ddddIdHS|j||||| | | | | ||||d IdHS)aDShortcut for either:: await update.callback_query.message.edit_live_location(*args, **kwargs) or:: await bot.edit_message_live_location( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_live_location` and :meth:`telegram.Message.edit_live_location`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N)r rUrVrTrDr3r4r5r6r#rWrXrYrZrGrHrI) rUrVrTrDr3r4r5r6r#rWrXrYrZ)r r;edit_message_live_locationrAZedit_live_location)r&rUrVrDrWrXrYrZrTr3r4r5r6r#r)r)r*r[sF* z(CallbackQuery.edit_message_live_locationc sP|jr0|j|j||||||dddd IdHS|j||||||dIdHS)aDShortcut for either:: await update.callback_query.message.stop_live_location(*args, **kwargs) or:: await bot.stop_message_live_location( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.stop_message_live_location` and :meth:`telegram.Message.stop_live_location`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N) r rDr3r4r5r6r#rGrHrIrO)r r;stop_message_live_locationrAZstop_live_locationrQr)r)r*r\$s*# z(CallbackQuery.stop_message_live_location) user_idscoreforcedisable_edit_messager3r4r5r6r#r,c sZ|jr4|j|j||||||||| ddd IdHS|j||||||||| d IdHS)aShortcut for either:: await update.callback_query.message.set_game_score(*args, **kwargs) or:: await bot.set_game_score( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.set_game_score` and :meth:`telegram.Message.set_game_score`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. N) r r]r^r_r`r3r4r5r6r#rGrH) r]r^r_r`r3r4r5r6r#)r r;set_game_scorerA) r&r]r^r_r`r3r4r5r6r#r)r)r*ra^s4% zCallbackQuery.set_game_score)r.)r]r3r4r5r6r#r,c sN|jr.|j|j||||||ddd IdHS|j||||||dIdHS)aShortcut for either:: await update.callback_query.message.get_game_high_score(*args, **kwargs) or:: await bot.get_game_high_scores( inline_message_id=update.callback_query.inline_message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.get_game_high_scores` and :meth:`telegram.Message.get_game_high_scores`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: Tuple[:class:`telegram.GameHighScore`] Raises: :exc:`TypeError` if :attr:`message` is not accessible. N) r r]r3r4r5r6r#rGrH)r]r3r4r5r6r#)r r;get_game_high_scoresrA)r&r]r3r4r5r6r#r)r)r*rbs(" z"CallbackQuery.get_game_high_scores)r3r4r5r6r#r,cs"|jddj|||||dIdHS)aShortcut for:: await update.callback_query.message.delete(*args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Message.delete`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. deleter>r2N)rArcr&r3r4r5r6r#r)r)r*delete_messages zCallbackQuery.delete_message)disable_notificationr3r4r5r6r#r,cs$|jddj||||||dIdHS)aShortcut for:: await update.callback_query.message.pin(*args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Message.pin`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. pinrd)rgr3r4r5r6r#N)rArh)r&rgr3r4r5r6r#r)r)r* pin_messages zCallbackQuery.pin_messagecs"|jddj|||||dIdHS)aShortcut for:: await update.callback_query.message.unpin(*args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Message.unpin`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :obj:`bool`: On success, :obj:`True` is returned. Raises: :exc:`TypeError` if :attr:`message` is not accessible. unpinrdr2N)rArjrer)r)r* unpin_messages zCallbackQuery.unpin_message)allow_sending_without_replyreply_to_message_idr3r4r5r6r#rr)rGrKrCrLrgrDprotect_contentmessage_thread_idreply_parametersrMrlrmr3r4r5r6r#r,c s:|jddj|||||| | || ||||||| | dIdHS)aShortcut for:: await update.callback_query.message.copy( from_chat_id=update.message.chat_id, message_id=update.message.message_id, *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Message.copy`. .. versionchanged:: 20.8 Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: :class:`telegram.MessageId`: On success, returns the MessageId of the sent message. Raises: :exc:`TypeError` if :attr:`message` is not accessible. copyrd)rGrKrCrLrgrmrlrDr3r4r5r6r#rnrorprMN)rArq)r&rGrKrCrLrgrDrnrorprMrlrmr3r4r5r6r#r)r)r* copy_message8s&) zCallbackQuery.copy_messageMAX_ANSWER_TEXT_LENGTH)NNNN)N)NNNN)r=)N)N)NNNNNNN)N)NN)-__name__ __module__ __qualname____doc__ __slots__strr rr rr% classmethodr.rboolintrfloatr<r rArrrJrNrPrSr r[r\rarrbrfrirkrrrrZCallbackQueryLimitZ!ANSWER_CALLBACK_QUERY_TEXT_LENGTHrsr__annotations__ __classcell__r)r)r'r*r,sH D  %   J  G = >  Q > D : # % #    >rN)"rwtypingrrrrrrZtelegramrZtelegram._files.locationr Ztelegram._messager r Ztelegram._telegramobjectr Ztelegram._userr Ztelegram._utils.defaultvaluerZtelegram._utils.typesrrrrrrrrrrrrr)r)r)r*s      (