՟fE dZddlmZmZmZmZmZmZmZm Z m Z m Z m Z m Z mZddlmZddlmZddlmZddlmZddlmZmZmZmZerddlmZmZdd lm Z m!Z!m"Z"dd lm#Z#d Z$e d d Z%GddeeeeefZ&y)z/This module contains the CallbackContext class.) TYPE_CHECKINGAny AwaitableDict GeneratorGenericListMatchNoReturnOptionalTypeTypeVarUnion) CallbackQuery)Update)warn)ExtBot)BDBTCDUD)FutureQueue) ApplicationJobJobQueue)CCTzihttps://github.com/python-telegram-bot/python-telegram-bot/wiki/Storing-bot%2C-user-and-chat-related-dataSTz#CallbackContext[Any, Any, Any, Any])boundcxeZdZdZdZ d+dedddeedeefd Ze d,d Z e d e fd Z e jd ed efdZ e d eefdZejd ed efdZe d eefdZejd ed efdZd-dZded dfdZe d+deddededddeddeeeeddefeefd dfdZededdedd d dfd!Zededdd"dd d dfd#Z d$e!e"efd dfd%Z#e d e$fd&Z%e d ed'fd(Z&e d.d)Z'e d ee(e"fd*Z)y)/CallbackContexta This is a context object passed to the callback called by :class:`telegram.ext.BaseHandler` or by the :class:`telegram.ext.Application` in an error handler added by :attr:`telegram.ext.Application.add_error_handler` or to the callback of a :class:`telegram.ext.Job`. Note: :class:`telegram.ext.Application` will create a single context for an entire update. This means that if you got 2 handlers in different groups and they both get called, they will receive the same :class:`CallbackContext` object (of course with proper attributes like :attr:`matches` differing). This allows you to add custom attributes in a lower handler group callback, and then subsequently access those attributes in a higher handler group callback. Note that the attributes on :class:`CallbackContext` might change in the future, so make sure to use a fairly unique name for the attributes. Warning: Do not combine custom attributes with :paramref:`telegram.ext.BaseHandler.block` set to :obj:`False` or :attr:`telegram.ext.Application.concurrent_updates` set to :obj:`True`. Due to how those work, it will almost certainly execute the callbacks for an update out of order, and the attributes that you think you added will not be present. This class is a :class:`~typing.Generic` class and accepts four type variables: 1. The type of :attr:`bot`. Must be :class:`telegram.Bot` or a subclass of that class. 2. The type of :attr:`user_data` (if :attr:`user_data` is not :obj:`None`). 3. The type of :attr:`chat_data` (if :attr:`chat_data` is not :obj:`None`). 4. The type of :attr:`bot_data` (if :attr:`bot_data` is not :obj:`None`). Examples: * :any:`Context Types Bot ` * :any:`Custom Webhook Bot ` .. seealso:: :attr:`telegram.ext.ContextTypes.DEFAULT_TYPE`, :wiki:`Job Queue ` Args: application (:class:`telegram.ext.Application`): The application associated with this context. chat_id (:obj:`int`, optional): The ID of the chat associated with this object. Used to provide :attr:`chat_data`. .. versionadded:: 20.0 user_id (:obj:`int`, optional): The ID of the user associated with this object. Used to provide :attr:`user_data`. .. versionadded:: 20.0 Attributes: coroutine (:term:`awaitable`): Optional. Only present in error handlers if the error was caused by an awaitable run with :meth:`Application.create_task` or a handler callback with :attr:`block=False `. matches (List[:meth:`re.Match `]): Optional. If the associated update originated from a :class:`filters.Regex`, this will contain a list of match objects for every pattern where ``re.search(pattern, string)`` returned a match. Note that filters short circuit, so combined regex filters will not always be evaluated. args (List[:obj:`str`]): Optional. Arguments passed to a command if the associated update is handled by :class:`telegram.ext.CommandHandler`, :class:`telegram.ext.PrefixHandler` or :class:`telegram.ext.StringCommandHandler`. It contains a list of the words in the text after the command, using any whitespace string as a delimiter. error (:exc:`Exception`): Optional. The error that was raised. Only present when passed to an error handler registered with :attr:`telegram.ext.Application.add_error_handler`. job (:class:`telegram.ext.Job`): Optional. The job which originated this callback. Only present when passed to the callback of :class:`telegram.ext.Job` or in error handlers if the error is caused by a job. .. versionchanged:: 20.0 :attr:`job` is now also present in error handlers if the error is caused by a job. ) __dict__ _application_chat_id_user_idargs coroutineerrorjobmatchesNself application$Application[BT, ST, UD, CD, BD, Any]chat_iduser_idct||_||_||_d|_d|_d|_d|_d|_y)N)r#r$r%r&r*r(r)r')r+r,r.r/s X/var/www/cvtools/html/venv/lib/python3.12/site-packages/telegram/ext/_callbackcontext.py__init__zCallbackContext.__init__sD CN'. '. )- 37 *. '+  returnc|jS)zP:class:`telegram.ext.Application`: The application associated with this context.)r#r+s r1r,zCallbackContext.applications   r3c.|jjS)aA:obj:`ContextTypes.bot_data`: Optional. An object that can be used to keep any data in. For each update it will be the same :attr:`ContextTypes.bot_data`. Defaults to :obj:`dict`. .. seealso:: :wiki:`Storing Bot, User and Chat Related Data ` )r,bot_datar6s r1r8zCallbackContext.bot_datas(((r3_c&tdt)Nz0You can not assign a new value to bot_data, see AttributeError_STORING_DATA_WIKIr+r9s r1r8zCallbackContext.bot_datas>?Q>R S  r3cb|j#|jj|jSy)a:obj:`ContextTypes.chat_data`: Optional. An object that can be used to keep any data in. For each update from the same chat id it will be the same :obj:`ContextTypes.chat_data`. Defaults to :obj:`dict`. Warning: When a group chat migrates to a supergroup, its chat id will change and the ``chat_data`` needs to be transferred. For details see our :wiki:`wiki page `. .. seealso:: :wiki:`Storing Bot, User and Chat Related Data ` .. versionchanged:: 20.0 The chat data is now also present in error handlers if the error is caused by a job. N)r$r# chat_datar6s r1r@zCallbackContext.chat_datas," == $$$..t}}= =r3c&tdt)Nz1You can not assign a new value to chat_data, see r;r>s r1r@zCallbackContext.chat_data?@R?S T  r3cb|j#|jj|jSy)a:obj:`ContextTypes.user_data`: Optional. An object that can be used to keep any data in. For each update from the same user it will be the same :obj:`ContextTypes.user_data`. Defaults to :obj:`dict`. .. seealso:: :wiki:`Storing Bot, User and Chat Related Data ` .. versionchanged:: 20.0 The user data is now also present in error handlers if the error is caused by a job. N)r%r# user_datar6s r1rDzCallbackContext.user_datas, == $$$..t}}= =r3c&tdt)Nz1You can not assign a new value to user_data, see r;r>s r1rDzCallbackContext.user_datarBr3cK|jjrV|jjjjr7|jjj |jd{|jjjj rO|j C|jjj|j |j d{|jjjjrQ|jD|jjj|j|jd{yyyy777 w)aIf :attr:`application` uses persistence, calls :meth:`telegram.ext.BasePersistence.refresh_bot_data` on :attr:`bot_data`, :meth:`telegram.ext.BasePersistence.refresh_chat_data` on :attr:`chat_data` and :meth:`telegram.ext.BasePersistence.refresh_user_data` on :attr:`user_data`, if appropriate. Will be called by :meth:`telegram.ext.Application.process_update` and :meth:`telegram.ext.Job.run`. .. versionadded:: 13.6 N)r.r@)r/rD) r, persistence store_datar8refresh_bot_datar@r$refresh_chat_datarDr%refresh_user_datar6s r1 refresh_datazCallbackContext.refresh_datas.    ' '++66??&&22CCDMMRRR++66@@T]]E^&&22DD MM"nnE++66@@T]]E^&&22DD MM"nnEF_@ (R s8A4E76E17A8E7/E30A8E7(E5) E73E75E7callback_queryct|jtrG|jj t d|jjj |yt d)a Deletes the cached data for the specified callback query. .. versionadded:: 13.6 Note: Will *not* raise exceptions in case the data is not found in the cache. *Will* raise :exc:`KeyError` in case the callback query can not be found in the cache. .. seealso:: :wiki:`Arbitrary callback_data ` Args: callback_query (:class:`telegram.CallbackQuery`): The callback query. Raises: KeyError | RuntimeError: :exc:`KeyError`, if the callback query can not be found in the cache and :exc:`RuntimeError`, if the bot doesn't allow for arbitrary callback data. NzGThis telegram.ext.ExtBot instance does not use arbitrary callback data.z8telegram.Bot does not allow for arbitrary callback data.) isinstancebotrcallback_data_cache RuntimeError drop_data)r+rMs r1drop_callback_dataz"CallbackContext.drop_callback_datas\( dhh 'xx++3"] HH ( ( 2 2> BJ r3clsrupdater(z%Application[BT, CCT, UD, CD, BD, Any]r)zJob[Any]r'zFuture[object]c||j||}n||j||}n||}||_||_|S)a' Constructs an instance of :class:`telegram.ext.CallbackContext` to be passed to the error handlers. .. seealso:: :meth:`telegram.ext.Application.add_error_handler` .. versionchanged:: 20.0 Removed arguments ``async_args`` and ``async_kwargs``. Args: update (:obj:`object` | :class:`telegram.Update`): The update associated with the error. May be :obj:`None`, e.g. for errors in job callbacks. error (:obj:`Exception`): The error. application (:class:`telegram.ext.Application`): The application associated with this context. job (:class:`telegram.ext.Job`, optional): The job associated with the error. .. versionadded:: 20.0 coroutine (:term:`awaitable`, optional): The awaitable associated with this error if the error was caused by a coroutine run with :meth:`Application.create_task` or a handler callback with :attr:`block=False `. .. versionadded:: 20.0 .. versionchanged:: 20.2 Accepts :class:`asyncio.Future` and generator-based coroutine functions. Returns: :class:`telegram.ext.CallbackContext` ) from_updatefrom_jobr(r')rUrVr(r,r)r'r+s r1 from_errorzCallbackContext.from_errorsMT  ??6;7D _<<[1D{#D " r3z)Application[Any, CCT, Any, Any, Any, Any]ct|trC|j}|j}|r |jnd}|r |jnd}||||S||S)a Constructs an instance of :class:`telegram.ext.CallbackContext` to be passed to the handlers. .. seealso:: :meth:`telegram.ext.Application.add_handler` Args: update (:obj:`object` | :class:`telegram.Update`): The update. application (:class:`telegram.ext.Application`): The application associated with this context. Returns: :class:`telegram.ext.CallbackContext` Nr.r/)rOreffective_chateffective_userid)rUrVr,chatuserr.r/s r1rXzCallbackContext.from_updatePsX( ff %((D((D!%dgg4G!%dgg4G{GWE E;r3zJob[CCT]cR|||j|j}||_|S)a Constructs an instance of :class:`telegram.ext.CallbackContext` to be passed to a job callback. .. seealso:: :meth:`telegram.ext.JobQueue` Args: job (:class:`telegram.ext.Job`): The job. application (:class:`telegram.ext.Application`): The application associated with this context. Returns: :class:`telegram.ext.CallbackContext` r\)r.r/r))rUr)r,r+s r1rYzCallbackContext.from_jobns&(; S[[I r3datacN|jD]\}}t|||y)zUpdates ``self.__slots__`` with the passed data. Args: data (Dict[:obj:`str`, :obj:`object`]): The data. N)itemssetattr)r+rckeyvalues r1rVzCallbackContext.updates) **, &JC D#u % &r3c.|jjS)z<:class:`telegram.Bot`: The bot associated with this context.)r#rPr6s r1rPzCallbackContext.bots  $$$r3z JobQueue[ST]ct|jj tdd|jjS)z :class:`telegram.ext.JobQueue`: The :class:`JobQueue` used by the :class:`telegram.ext.Application`. .. seealso:: :wiki:`Job Queue ` zqNo `JobQueue` set up. To use `JobQueue`, you must install PTB via `pip install "python-telegram-bot[job-queue]"`.) stacklevel)r# _job_queuerr6s r1 job_queuezCallbackContext.job_queues;    ' ' / B    +++r3c.|jjS)z :class:`asyncio.Queue`: The :class:`asyncio.Queue` instance used by the :class:`telegram.ext.Application` and (usually) the :class:`telegram.ext.Updater` associated with this context. )r# update_queuer6s r1rpzCallbackContext.update_queues  ---r3cL |jdS#ttf$rYywxYw)z :meth:`re.Match `: The first match from :attr:`matches`. Useful if you are only filtering using a single regex filter. Returns :obj:`None` if :attr:`matches` is empty. rN)r* IndexError TypeErrorr6s r1matchzCallbackContext.matchs, <<? "I&  s ##)NN)r4r-)r4N)r4z Queue[object])*__name__ __module__ __qualname____doc__ __slots__rr intr2propertyr,rr8setterobjectr rr@rrDrLrrT classmethodr ExceptionrrrrrZrXrYrstrrVrrPrnrpr rtr3r1r!r!9sCJ I"&!% ;## "!!)"))__ & X  8B<( 6 h   8B<   6 h  44> %) 2 %[222= 2 j ! 2  )H%56cABIcNR S 2 22h %[  A     : %[ A  .&4V ,&&%R%% ,8N3 , ,.. xc +  r3r!N)'rxtypingrrrrrrr r r r r rrtelegram._callbackqueryrtelegram._updatertelegram._utils.warningsrtelegram.ext._extbotrtelegram.ext._utils.typesrrrrasynciorr telegram.extrrrrr=rr!rr3r1rsu&6 2#)'44%77-6  T>?gb"b"n-r3