o "h(2@sdZddlZddlZddlZddlmZmZddlmZm Z m Z m Z z ddl m Z dZWn ey7dZYnwddlmZdd lmZdd lmZdd lmZdd lmZejd kr_ejZn ejdedfddZeeddZGdddee Z!dS)zeThis module contains an implementation of the BaseRateLimiter class based on the aiolimiter library. N) AsyncIterator Coroutine)AnyCallableOptionalUnion) AsyncLimiterTF) constants) get_logger)JSONDict) RetryAfter)BaseRateLimiter) returncCs dVdSNrrrO/var/www/html/venv/lib/python3.10/site-packages/telegram/ext/_aioratelimiter.py null_context0s rAIORateLimiter) class_namec@sHeZdZdZdZejjdejjddfde de de d e d e d d f d dZ d%ddZ d%ddZ deee efd dfddZdedeee efdededeeeeeeeefffdedeeefd eeeeeffddZdedeeeeeeeefffdedeeefd ed!eeefd"ee d eeeeeffd#d$Zd S)&rak Implementation of :class:`~telegram.ext.BaseRateLimiter` using the library `aiolimiter `_. Important: If you want to use this class, you must install PTB with the optional requirement ``rate-limiter``, i.e. .. code-block:: bash pip install "python-telegram-bot[rate-limiter]" The rate limiting is applied by combining two levels of throttling and :meth:`process_request` roughly boils down to:: async with group_limiter(group_id): async with overall_limiter: await callback(*args, **kwargs) Here, ``group_id`` is determined by checking if there is a ``chat_id`` parameter in the :paramref:`~telegram.ext.BaseRateLimiter.process_request.data`. The ``overall_limiter`` is applied only if a ``chat_id`` argument is present at all. Attention: * Some bot methods accept a ``chat_id`` parameter in form of a ``@username`` for supergroups and channels. As we can't know which ``@username`` corresponds to which integer ``chat_id``, these will be treated as different groups, which may lead to exceeding the rate limit. * As channels can't be differentiated from supergroups by the ``@username`` or integer ``chat_id``, this also applies the group related rate limits to channels. * A :exc:`~telegram.error.RetryAfter` exception will halt *all* requests for :attr:`~telegram.error.RetryAfter.retry_after` + 0.1 seconds. This may be stricter than necessary in some cases, e.g. the bot may hit a rate limit in one group but might still be allowed to send messages in another group or with :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` set to :obj:`True`. Tip: With `Bot API 7.1 `_ (PTB v27.1), Telegram introduced the parameter :paramref:`~telegram.Bot.send_message.allow_paid_broadcast`. This allows bots to send up to :tg-const:`telegram.constants.FloodLimit.PAID_MESSAGES_PER_SECOND` messages per second by paying a fee in Telegram Stars. .. versionchanged:: 21.11 This class automatically takes the :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` parameter into account and throttles the requests accordingly. Note: This class is to be understood as minimal effort reference implementation. If you would like to handle rate limiting in a more sophisticated, fine-tuned way, we welcome you to implement your own subclass of :class:`~telegram.ext.BaseRateLimiter`. Feel free to check out the source code of this class for inspiration. .. seealso:: :wiki:`Avoiding Flood Limits ` .. versionadded:: 20.0 Args: overall_max_rate (:obj:`float`): The maximum number of requests allowed for the entire bot per :paramref:`overall_time_period`. When set to 0, no rate limiting will be applied. Defaults to :tg-const:`telegram.constants.FloodLimit.MESSAGES_PER_SECOND`. overall_time_period (:obj:`float`): The time period (in seconds) during which the :paramref:`overall_max_rate` is enforced. When set to 0, no rate limiting will be applied. Defaults to ``1``. group_max_rate (:obj:`float`): The maximum number of requests allowed for requests related to groups and channels per :paramref:`group_time_period`. When set to 0, no rate limiting will be applied. Defaults to :tg-const:`telegram.constants.FloodLimit.MESSAGES_PER_MINUTE_PER_GROUP`. group_time_period (:obj:`float`): The time period (in seconds) during which the :paramref:`group_max_rate` is enforced. When set to 0, no rate limiting will be applied. Defaults to ``60``. max_retries (:obj:`int`): The maximum number of retries to be made in case of a :exc:`~telegram.error.RetryAfter` exception. If set to 0, no retries will be made. Defaults to ``0``. ) _apb_limiter _base_limiter_group_limiters_group_max_rate_group_time_period _max_retries_retry_after_event<roverall_max_rateoverall_time_periodgroup_max_rategroup_time_period max_retriesrNcCststd|r|rt||d|_nd|_|r |r ||_||_nd|_d|_i|_ttjj dd|_ ||_ t |_|jdS)NzeTo use `AIORateLimiter`, PTB must be installed via `pip install "python-telegram-bot[rate-limiter]"`.max_rate time_periodrr)AIO_LIMITER_AVAILABLE RuntimeErrorrrrrrr FloodLimitPAID_MESSAGES_PER_SECONDrrasyncioEventrset)selfr r!r"r#r$rrr__init__s*  zAIORateLimiter.__init__cdSz Does nothing.Nrr/rrr initializezAIORateLimiter.initializecr1r2rr3rrrshutdownr5zAIORateLimiter.shutdowngroup_idrcCsnt|jdkr"|jD]\}}||krq||jr!|j|=q||jvr2t|j|jd|j|<|j|S)Nir%) lenrcopyitems has_capacityr&rrr)r/r7keylimiterrrr_get_group_limiters   z!AIORateLimiter._get_group_limiterchatgroupallow_paid_broadcastcallback.argskwargsc s<dtttttfffdd }|r;j4IdH|IdHWdIdHS1IdHs4wYdS|rCjrCjnt}|rPjrP|nt} | 4IdH8|4IdH|IdHWdIdHWdIdHS1IdHswYWdIdHdS1IdHswYdS)Nrcs&jIdHiIdHSr)rwaitrrCrBrDr/rrinnersz*AIORateLimiter._run_request..inner) rboolr listrrrrr>) r/r?r@rArBrCrDrG base_context group_contextrrFr _run_requests &  0  pzAIORateLimiter._run_requestendpointdatarate_limit_argsc s\|p|j}d}d} |d} |dd} | durd} ttt t| } Wdn1s0wYt| tr>| dksCt| trE| }t |dD]`} zXz|j | || |||dIdHWW|j St y} z-| |krztjd || d | jd }td ||j t|IdHWYd} ~ nd} ~ wwW|j qK|j wdS) a Processes a request by applying rate limiting. See :meth:`telegram.ext.BaseRateLimiter.process_request` for detailed information on the arguments. Args: rate_limit_args (:obj:`None` | :obj:`int`): If set, specifies the maximum number of retries to be made in case of a :exc:`~telegram.error.RetryAfter` exception. Defaults to :paramref:`AIORateLimiter.max_retries`. Fchat_idrANTrr)r?r@rArBrCrDz*Rate limit hit after maximum of %d retries)exc_infog?z)Rate limit hit. Retrying after %f seconds)rget contextlibsuppress ValueError TypeErrorint isinstancestrrangerLrr.r _LOGGER exception _retry_after total_secondsinfoclearr,sleep)r/rBrCrDrMrNrOr$r@r?rPrAiexcrarrrprocess_requestsN       zAIORateLimiter.process_request)rN)__name__ __module__ __qualname____doc__ __slots__r r*MESSAGES_PER_SECONDMESSAGES_PER_MINUTE_PER_GROUPfloatrWr0r4r6rrYrHr>rrrr rIdictrLrrdrrrrr8slO  #  "  "  )"rhr,rSsyscollections.abcrrtypingrrrr aiolimiterrr( ImportErrortelegramr telegram._utils.loggingr telegram._utils.typesr telegram.errorr telegram.ext._baseratelimiterr version_info nullcontextrasynccontextmanagerrer[rWrrrrrs.