U g@sdZddlmZmZddlmZmZmZmZm Z m Z ddl m Z ddl mZddlmZddlmZmZerxddlmZe d Ze d ZGd d d eeeefeZd S)zLThis module contains the base class for handlers as used by the Application.)ABCabstractmethod) TYPE_CHECKINGAnyGenericOptionalTypeVarUnion) DEFAULT_TRUE)build_repr_with_selected_attrs)DVType)CCTHandlerCallback) ApplicationRTUTc@seZdZdZdZefdeeee fe e dddZ e ddd Zeeeee efd d d Zed eee dddZeed eddddZdS) BaseHandlera The base class for all update handlers. Create custom handlers by inheriting from it. 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. This class is a :class:`~typing.Generic` class and accepts three type variables: 1. The type of the updates that this handler will handle. Must coincide with the type of the first argument of :paramref:`callback`. :meth:`check_update` must only accept updates of this type. 2. The type of the second argument of :paramref:`callback`. Must coincide with the type of the parameters :paramref:`handle_update.context` and :paramref:`collect_additional_context.context` as well as the second argument of :paramref:`callback`. Must be either :class:`~telegram.ext.CallbackContext` or a subclass of that class. .. tip:: For this type variable, one should usually provide a :class:`~typing.TypeVar` that is also used for the mentioned method arguments. That way, a type checker can check whether this handler fits the definition of the :class:`~Application`. 3. The return type of the :paramref:`callback` function accepted by this handler. .. seealso:: :wiki:`Types of Handlers ` .. versionchanged:: 20.0 * The attribute ``run_async`` is now :paramref:`block`. * This class was previously named ``Handler``. 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`. 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. block (:obj:`bool`): Determines whether the callback will run in a blocking way. )blockcallbackzBaseHandler[UT, CCT, RT]selfrrcCs||_||_dS)N)rrrrF/tmp/pip-unpacked-wheel-swnnwir2/telegram/ext/_handlers/basehandler.py__init__\szBaseHandler.__init__)returncCs8z |jj}Wntk r*t|j}YnXt||dS)a!Give a string representation of the handler in the form ``ClassName[callback=...]``. As this class doesn't implement :meth:`object.__str__`, the default implementation will be used, which is equivalent to :meth:`__repr__`. Returns: :obj:`str` )r)r __qualname__AttributeErrorreprr )rZ callback_namerrr__repr__ds  zBaseHandler.__repr__)updatercCsdS)a This method is called to determine if an update should be handled by this handler instance. It should always be overridden. Note: Custom updates types can be handled by the application. Therefore, an implementation of this method should always check the type of :paramref:`update`. Args: update (:obj:`object` | :class:`telegram.Update`): The update to be tested. Returns: Either :obj:`None` or :obj:`False` if the update should not be handled. Otherwise an object that will be passed to :meth:`handle_update` and :meth:`collect_additional_context` when the update gets handled. Nr)rrrrr check_updatesszBaseHandler.check_updatez)Application[Any, CCT, Any, Any, Any, Any])r application check_resultcontextrcs"||||||||IdHS)a This method is called if it was determined that an update should indeed be handled by this instance. Calls :attr:`callback` along with its respectful arguments. To work with the :class:`telegram.ext.ConversationHandler`, this method returns the value returned from :attr:`callback`. Note that it can be overridden if needed by the subclassing handler. Args: update (:obj:`str` | :class:`telegram.Update`): The update to be handled. application (:class:`telegram.ext.Application`): The calling application. check_result (:class:`object`): The result from :meth:`check_update`. context (:class:`telegram.ext.CallbackContext`): The context as provided by the application. N)collect_additional_contextr)rrr!r"r#rrr handle_updateszBaseHandler.handle_updateN)r#rr!r"rcCsdS)aPrepares additional arguments for the context. Override if needed. Args: context (:class:`telegram.ext.CallbackContext`): The context object. update (:class:`telegram.Update`): The update to gather chat/user id from. application (:class:`telegram.ext.Application`): The calling application. check_result: The result (return value) from :meth:`check_update`. Nr)rr#rr!r"rrrr$sz&BaseHandler.collect_additional_context)__name__ __module__r__doc__ __slots__r rrr rr boolrstrrrobjectrr r r%rr$rrrrr#s.3   rN)r(abcrrtypingrrrrrr Ztelegram._utils.defaultvaluer Ztelegram._utils.reprr Ztelegram._utils.typesr Ztelegram.ext._utils.typesr rZ telegram.extrrrrrrrrs