U gM$@sdZddlZddlZddlmZmZmZmZmZm Z m Z m Z m Z ddl mZddlmZddlmZddlmZddlmZmZerdd lmZe d ZGd d d eeeefZdS) z4This module contains the CallbackQueryHandler class.N) TYPE_CHECKINGAnyCallableMatchOptionalPatternTypeVarUnioncast)Update) DEFAULT_TRUE)DVType) BaseHandler)CCTHandlerCallback) ApplicationRTc seZdZdZdZddefdeeee fe e e e e eeege effe e e e e feedfdd Zee e eefdd d Zeed e eee fdd d dZZS)CallbackQueryHandleraHandler class to handle Telegram :attr:`callback queries `. Optionally based on a regex. Read the documentation of the :mod:`re` module for more information. Note: * If your bot allows arbitrary objects as :paramref:`~telegram.InlineKeyboardButton.callback_data`, it may happen that the original :attr:`~telegram.InlineKeyboardButton.callback_data` for the incoming :class:`telegram.CallbackQuery` can not be found. This is the case when either a malicious client tempered with the :attr:`telegram.CallbackQuery.data` or the data was simply dropped from cache or not persisted. In these cases, an instance of :class:`telegram.ext.InvalidCallbackData` will be set as :attr:`telegram.CallbackQuery.data`. .. versionadded:: 13.6 * If neither :paramref:`pattern` nor :paramref:`game_pattern` is set, `any` ``CallbackQuery`` will be handled. If only :paramref:`pattern` is set, queries with :attr:`~telegram.CallbackQuery.game_short_name` will `not` be considered and vice versa. If both patterns are set, queries with either :attr: `~telegram.CallbackQuery.game_short_name` or :attr:`~telegram.CallbackQuery.data` matching the defined pattern will be handled .. versionadded:: 21.5 Warning: When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. Args: callback (:term:`coroutine function`): The callback function for this handler. Will be called when :meth:`check_update` has determined that an update should be processed by this handler. Callback signature:: async def callback(update: Update, context: CallbackContext) The return value of the callback is usually ignored except for the special case of :class:`telegram.ext.ConversationHandler`. pattern (:obj:`str` | :func:`re.Pattern ` | :obj:`callable` | :obj:`type`, optional): Pattern to test :attr:`telegram.CallbackQuery.data` against. If a string or a regex pattern is passed, :func:`re.match` is used on :attr:`telegram.CallbackQuery.data` to determine if an update should be handled by this handler. If your bot allows arbitrary objects as :paramref:`~telegram.InlineKeyboardButton.callback_data`, non-strings will be accepted. To filter arbitrary objects you may pass: - a callable, accepting exactly one argument, namely the :attr:`telegram.CallbackQuery.data`. It must return :obj:`True` or :obj:`False`/:obj:`None` to indicate, whether the update should be handled. - a :obj:`type`. If :attr:`telegram.CallbackQuery.data` is an instance of that type (or a subclass), the update will be handled. If :attr:`telegram.CallbackQuery.data` is :obj:`None`, the :class:`telegram.CallbackQuery` update will not be handled. .. seealso:: :wiki:`Arbitrary callback_data ` .. versionchanged:: 13.6 Added support for arbitrary callback data. game_pattern (:obj:`str` | :func:`re.Pattern ` | optional) Pattern to test :attr:`telegram.CallbackQuery.game_short_name` against. If a string or a regex pattern is passed, :func:`re.match` is used on :attr:`telegram.CallbackQuery.game_short_name` to determine if an update should be handled by this handler. .. versionadded:: 21.5 block (:obj:`bool`, optional): Determines whether the return value of the callback should be awaited before processing the next handler in :meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`. .. seealso:: :wiki:`Concurrency` Attributes: callback (:term:`coroutine function`): The callback function for this handler. pattern (:func:`re.Pattern ` | :obj:`callable` | :obj:`type`): Optional. Regex pattern, callback or type to test :attr:`telegram.CallbackQuery.data` against. .. versionchanged:: 13.6 Added support for arbitrary callback data. game_pattern (:func:`re.Pattern `): Optional. Regex pattern to test :attr:`telegram.CallbackQuery.game_short_name` block (:obj:`bool`): Determines whether the return value of the callback should be awaited before processing the next handler in :meth:`telegram.ext.Application.process_update`. ) game_patternpatternNzCallbackQueryHandler[CCT, RT]selfcallbackrrblockcsbtj||dt|r*t|r*tdt|tr>t |}t|trRt |}||_ ||_ dS)N)rzQThe `pattern` must not be a coroutine function! Use an ordinary function instead.) super__init__callableasyncioiscoroutinefunction TypeError isinstancestrrecompilerrr __class__O/tmp/pip-unpacked-wheel-swnnwir2/telegram/ext/_handlers/callbackqueryhandler.pyrs     zCallbackQueryHandler.__init__)updatereturncCst|tr|jsdS|jj}|jj}t|j|jgs8dS|r|jsFdSt|jtr^t||jSt |jrr||St|t sdSt |j|}r|Sn*|r|jsdSt |j|}r|SndSdS)zDetermines whether an update should be passed to this handler's :attr:`callback`. Args: update (:class:`telegram.Update` | :obj:`object`): Incoming update. Returns: :obj:`bool` NTF) r r Zcallback_querydatagame_short_nameanyrrtyperr!r"match)rr(Z callback_datar+r.r&r&r' check_updates0      z!CallbackQueryHandler.check_updatez)Application[Any, CCT, Any, Any, Any, Any])contextr( application check_resultr)cCs|jrtt|}|g|_dS)zAdd the result of ``re.match(pattern, update.callback_query.data)`` to :attr:`CallbackContext.matches` as list with one element. N)rr rmatches)rr0r(r1r2r&r&r'collect_additional_contexts  z/CallbackQueryHandler.collect_additional_context)__name__ __module__ __qualname____doc__ __slots__r rr rrrr r!rr-robjectboolr rr/rr4 __classcell__r&r&r$r'r$s*X  -r)r8rr"typingrrrrrrrr r Ztelegramr Ztelegram._utils.defaultvaluer Ztelegram._utils.typesr Z"telegram.ext._handlers.basehandlerrZtelegram.ext._utils.typesrrZ telegram.extrrrr&r&r&r's,