U g++@sdZddlZddlZddlZddlmZmZmZmZm Z m Z m Z m Z zddl mZdZWnek rpdZYnXddlmZddlmZdd lmZdd lmZejd krejZnejedd d dZeeddZGdddeeZ dS)zeThis module contains an implementation of the BaseRateLimiter class based on the aiolimiter library. N)Any AsyncIteratorCallable CoroutineDictListOptionalUnion) AsyncLimiterTF) get_logger)JSONDict) RetryAfter)BaseRateLimiter) returncCs dVdSNrrr@/tmp/pip-unpacked-wheel-swnnwir2/telegram/ext/_aioratelimiter.py null_context.srAIORateLimiter) class_namec @seZdZdZdZdeeeeedd d d Zdd d dZdd ddZ e e ee fddddZ e e e ee fedeeee e eeefffeee efe e eeefdddZedeeee e eeefffeee efe ee efeee e eeefdddZdS)ra 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. 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 ``30``. 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 20. 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``. ) _base_limiter_group_limiters_group_max_rate_group_time_period _max_retries_retry_after_event<rN)overall_max_rateoverall_time_periodgroup_max_rategroup_time_period max_retriesrcCspts td|r$|r$t||d|_nd|_|r@|r@||_||_n d|_d|_i|_||_t |_ |j dS)NzeTo use `AIORateLimiter`, PTB must be installed via `pip install "python-telegram-bot[rate-limiter]"`.max_rateZ time_periodr) AIO_LIMITER_AVAILABLE RuntimeErrorr rrrrrasyncioEventrset)selfr#r$r%r&r'rrr__init__s&  zAIORateLimiter.__init__rcsdSz Does nothing.Nrr/rrr initializeszAIORateLimiter.initializecsdSr1rr2rrrshutdownszAIORateLimiter.shutdownr )group_idrcCsnt|jdkrD|jD]&\}}||kr.q||jr|j|=q||jkrdt|j|jd|j|<|j|S)Nir() lenrcopyitemsZ has_capacityr)r rr)r/r5keyZlimiterrrr_get_group_limiters    z!AIORateLimiter._get_group_limiter.)chatgroupcallbackargskwargsrc s|r|jr|jnt}|r*|jr*||nt}|4IdHd|4IdHF|jIdH|||IdHW5QIdHRW5QIdHRSQIdHRXW5QIdHRXdSr)rrrr:rwait)r/r;r<r=r>r?Z base_contextZ group_contextrrr _run_requests zAIORateLimiter._run_request)r=r>r?endpointdatarate_limit_argsrc s$|p|j}d}d} |d} | dk r(d} tttt| } W5QRXt| trZ| dksdt| trh| }t |dD]} zz$|j | ||||dIdHWWxSt k r } zN| |krtjd|| d | jd } td | |j t| IdHW5d} ~ XYnXW5|j XqtdS) 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_idNTrr )r;r<r=r>r?z*Rate limit hit after maximum of %d retries)exc_infog?z)Rate limit hit. Retrying after %f seconds)rget contextlibsuppress ValueError TypeErrorint isinstancestrrangerr.rAr _LOGGER exception retry_afterinfoclearr,sleep)r/r=r>r?rBrCrDr'r<r;rEiexcrUrrrprocess_requestsB     &zAIORateLimiter.process_request)rr r!r"r)__name__ __module__ __qualname____doc__ __slots__floatrLr0r3r4r rNboolr:rrrr rrrArrXrrrrr6sB@   "  "  )!r\r,rHsystypingrrrrrrrr Z aiolimiterr r* ImportErrorZtelegram._utils.loggingr Ztelegram._utils.typesr Ztelegram.errorr Ztelegram.ext._baseratelimiterr version_info nullcontextrasynccontextmanagerrYrPrLrrrrrs&(