U g@sdZddlmZmZmZmZddlmZddlm Z ddl m Z ddl m Z mZmZerdddlmZGdd d e ee efZd S) z4This module contains the StringCommandHandler class.) TYPE_CHECKINGAnyListOptional) DEFAULT_TRUE)DVType) BaseHandler)CCTRTHandlerCallback) ApplicationcsxeZdZdZdZefdeeeee fe e dfdd Z e eeeddd Zeed eeed d d dZZS)StringCommandHandleraHandler class to handle string commands. Commands are string updates that start with ``/``. The handler will add a :obj:`list` to the :class:`CallbackContext` named :attr:`CallbackContext.args`. It will contain a list of strings, which is the text following the command split on single whitespace characters. Note: This handler is not used to handle Telegram :class:`telegram.Update`, but strings manually put in the queue. For example to send messages with the bot using command line or API. 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: command (:obj:`str`): The command this handler should listen for. 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: str, context: CallbackContext) The return value of the callback is usually ignored except for the special case of :class:`telegram.ext.ConversationHandler`. 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: command (:obj:`str`): The command this handler should listen for. callback (:term:`coroutine function`): The callback function for this handler. 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`. )commandzStringCommandHandler[CCT, RT]selfrcallbackblockcstj||d||_dS)N)r)super__init__rr __class__O/tmp/pip-unpacked-wheel-swnnwir2/telegram/ext/_handlers/stringcommandhandler.pyrIszStringCommandHandler.__init__)updatereturncCsDt|tr@|dr@|ddd}|d|jkr@|ddSdS)a Determines whether an update should be passed to this handler's :attr:`callback`. Args: update (:obj:`object`): The incoming update. Returns: List[:obj:`str`]: List containing the text command split on whitespace. /N r) isinstancestr startswithsplitr)rrargsrrr check_updateRs  z!StringCommandHandler.check_updatez)Application[Any, CCT, Any, Any, Any, Any]N)contextr application check_resultrcCs ||_dS)zqAdd text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces. N)r")rr$rr%r&rrrcollect_additional_contextbs z/StringCommandHandler.collect_additional_context)__name__ __module__ __qualname____doc__ __slots__rrr r r rboolrobjectrrr#r' __classcell__rrrrr s &   r N)r+typingrrrrZtelegram._utils.defaultvaluerZtelegram._utils.typesrZ"telegram.ext._handlers.basehandlerrZtelegram.ext._utils.typesr r r Z telegram.extr rr rrrrs