o .jG< @sbdZddlmZddlZddlZddlZddlZddlmZddl m Z ddlm Z m Z m Z mZmZejr=ddlmZmZgd Zd-d d Zd.ddZd/ddZGdddejeejejee ffeje ZGdddee ZGdd d ee ZGd!d"d"ZGd#d$d$Z Gd%d&d&eeZ!Gd'd(d(eeZ"Gd)d*d*e eZ#Gd+d,d,e eZ$dS)0a requests.hooks ~~~~~~~~~~~~~~ This module provides the capabilities for the Requests hooks system. Available hooks: ``pre_request``: The prepared request just got built. You may alter it prior to be sent through HTTP. ``pre_send``: The prepared request got his ConnectionInfo injected. This event is triggered just after picking a live connection from the pool. ``on_upload``: Permit to monitor the upload progress of passed body. This event is triggered each time a block of data is transmitted to the remote peer. Use this hook carefully as it may impact the overall performance. ``response``: The response generated from a Request. ) annotationsN)MutableMapping)iscoroutinefunction)_HVAsyncHookCallableType AsyncHookTypeHookCallableTypeHookType)PreparedRequestResponse pre_requestpre_send on_uploadearly_responseresponsereturn HookType[_HV]cCsddtDS)NcSsi|]}|gqSr).0eventrrC/home/thesage/.local/lib/python3.10/site-packages/niquests/hooks.py 4sz!default_hooks..)HOOKSrrrr default_hooks3srkeystrhooksHookType[_HV] | None hook_datarkwargs typing.Anyc Ksr|dur|S||}|r7t|r|g}|D] }z ||fi|}Wn ty/||}Ynw|dur6|}q|S)z6Dispatches a hook dictionary on a given piece of data.N)getcallable TypeErrorrrr r! callableshook _hook_datarrr dispatch_hook7s    r*AsyncHookType[_HV] | Nonec s|dur|S||}|rZt|r|g}|D]B}t|r;z ||fi|IdH}Wn(ty:||IdH}Ynwz ||fi|}Wn tyR||}Ynw|durY|}q|S)zEDispatches a hook dictionary on a given piece of data asynchronously.N)r#r$rr%r&rrrasync_dispatch_hookLs.    r,c@s^eZdZdddZdd d Zdd d ZdddZdddZddZddZ ddZ ddZ dS)_BaseLifeCycleHookrNonecCsgggggd|_dSNr _storeselfrrr__init__ks  z_BaseLifeCycleHook.__init__r str | bytesvalue8list[HookCallableType[_HV] | AsyncHookCallableType[_HV]]cCtdNzLifeCycleHook is Read OnlyNotImplementedError)r3rr6rrr __setitem__tz_BaseLifeCycleHook.__setitem__rcCs |j|SNr0r3rrrr __getitem__w z_BaseLifeCycleHook.__getitem__cCs||Sr>rr?rrrr#zr=z_BaseLifeCycleHook.getcCsTt|tsti}t}|jD]\}}|||<|||j|7<q||_|Sr>) isinstancer-r%r1items)r3other tmp_storecombined_hookshfnsrrr__add__}s z_BaseLifeCycleHook.__add__ccs|jEdHdSr>r0r2rrr__iter__sz_BaseLifeCycleHook.__iter__ccs|D] }|||fVqdSr>rr?rrrrCsz_BaseLifeCycleHook.itemscCr8r9r:r?rrr __delitem__r=z_BaseLifeCycleHook.__delitem__cCs t|jSr>)lenr1r2rrr__len__rAz_BaseLifeCycleHook.__len__Nrr.)rr5r6r7rr.)rrrr7)rr-) __name__ __module__ __qualname__r4r<r@r#rIrJrCrKrMrrrrr-hs     r-cTeZdZdZdfdd Zdd d Zdd dZdddZdddZdddZ Z S) LifeCycleHookzP A sync-only middleware to be used in your request/response lifecycles. rr.c:t|j|jg|jg|jg|jg|jgddSr/ superr4r1updaterrrrrr2 __class__rrr4 zLifeCycleHook.__init__prepared_requestr r!r"PreparedRequest | NonecKdSzTThe prepared request just got built. You may alter it prior to be sent through HTTP.Nrr3r[r!rrrrzLifeCycleHook.pre_requestcKr]zThe prepared request got his ConnectionInfo injected. This event is triggered just after picking a live connection from the pool. You may not alter the prepared request.Nrr_rrrrzLifeCycleHook.pre_sendcKr]aPermit to monitor the upload progress of passed body. This event is triggered each time a block of data is transmitted to the remote peer. Use this hook carefully as it may impact the overall performance. You may not alter the prepared request.Nrr_rrrrszLifeCycleHook.on_uploadrr cKr]zAn early response caught before receiving the final Response for a given Request. Like but not limited to 103 Early Hints.Nrr3rr!rrrrrbzLifeCycleHook.early_responseResponse | NonecKr]zJThe response generated from a Request. You may alter the response at will.Nrrerrrrr`zLifeCycleHook.responserNr[r r!r"rr\r[r r!r"rr.rr r!r"rr.rr r!r"rrf rOrPrQ__doc__r4rrrrr __classcell__rrrXrrS   rScrR)AsyncLifeCycleHookzR An async-only middleware to be used in your request/response lifecycles. rr.crTr/rUr2rXrrr4rZzAsyncLifeCycleHook.__init__r[r r!r"r\cdSr^rr_rrrrzAsyncLifeCycleHook.pre_requestcrqrarr_rrrrzAsyncLifeCycleHook.pre_sendcrqrcrr_rrrrszAsyncLifeCycleHook.on_uploadrr crqrdrrerrrrrsz!AsyncLifeCycleHook.early_responserfcrqrgrrerrrrrrzAsyncLifeCycleHook.responserNrhrirjrkrlrrrXrrprorpc@sHeZdZUdZded<ded<ded<dd d Zdd d Zdd dZdS)_LeakyBucketMixinz$Shared leaky bucket algorithm logic.floatrateinterval float | None last_requestrr.cCs||_d||_d|_dS)N?)rvrwryr3rvrrr_init_leaky_buckets  z$_LeakyBucketMixin._init_leaky_bucketcCs2t}|jdur||j}|j|}|Sd}|S)zDCompute wait time and update state. Returns wait time (may be <= 0).Ng)time monotonicryrwr3nowelapsed wait_timerrr _compute_waits   z_LeakyBucketMixin._compute_waitcCst|_dS)zRecord that a request was made.N)r}r~ryr2rrr_record_requestsz!_LeakyBucketMixin._record_requestNrvrurr.)rrurN)rOrPrQrm__annotations__r|rrrrrrrts    rtc@sPeZdZUdZded<ded<ded<ded<dd d Zdd d ZdddZdS)_TokenBucketMixinz$Shared token bucket algorithm logic.rurvcapacitytokens last_updaterxrr.cCs.||_|dur |n||_|j|_t|_dSr>)rvrrr}r~rr3rvrrrr_init_token_bucketsz$_TokenBucketMixin._init_token_bucketcCsbt}||j}t|j|j||j|_||_|jdkr'|jd8_dSd|j|j}|S)zUReplenish tokens and try to acquire one. Returns wait time if needed, None otherwise.rzNr}r~rminrrrvrrrr_acquire_tokens  z _TokenBucketMixin._acquire_tokencCsDt}||j}t|j|j||j|_||_|jd8_dS)z*Called after waiting to consume the token.rzNr)r3rrrrr _post_wait&s  z_TokenBucketMixin._post_waitNrvrurrxrr.)rrxrN)rOrPrQrmrrrrrrrrr s   rc.eZdZdZddfdd ZdddZZS)LeakyBucketLimiterapRate limiter using the leaky bucket algorithm. Requests "leak" out at a constant rate. When a request arrives, it waits until enough time has passed since the last request to maintain the rate. Usage:: limiter = LeakyBucketLimiter(rate=10.0) # 10 requests per second with niquests.Session(hooks=limiter) as session: ... $@rvrurr.c"t||t|_dSzjInitialize the leaky bucket limiter. Args: rate: Maximum requests per second N)rVr4r| threadingLock_lockr{rXrrr4>  zLeakyBucketLimiter.__init__r[r r!r"r\cKsN|j|}|dkrt||WddS1s wYdS)*Wait if needed to maintain the rate limit.rN)rrr}sleeprr3r[r!rrrrrHs   zLeakyBucketLimiter.pre_requestrrrhrOrPrQrmr4rrnrrrXrr1  rcr)AsyncLeakyBucketLimiteraRate limiter using the leaky bucket algorithm. Requests "leak" out at a constant rate. When a request arrives, it waits until enough time has passed since the last request to maintain the rate. Usage:: limiter = AsyncLeakyBucketLimiter(rate=10.0) # 10 requests per second async with niquests.AsyncSession(hooks=limiter) as session: ... rrvrurr.crr)rVr4r|asynciorrr{rXrrr4_rz AsyncLeakyBucketLimiter.__init__r[r r!r"r\c sj|j4IdH |}|dkrt|IdH|WdIdHdS1IdHs.wYdS)rNr)rrrrrrrrrris z#AsyncLeakyBucketLimiter.pre_requestrrrhrrrrXrrRrrc.eZdZdZddfd d ZdddZZS)TokenBucketLimitera{Rate limiter using the token bucket algorithm. Tokens are added to a bucket at a constant rate up to a maximum capacity. Each request consumes one token. Allows bursts up to the bucket capacity. Usage:: limiter = TokenBucketLimiter(rate=10.0, capacity=50.0) # 10/s, burst of 50 with niquests.Session(hooks=limiter) as session: ... rNrvrurrxrr.c$t|||t|_dSzInitialize the token bucket limiter. Args: rate: Token replenishment rate (tokens per second) capacity: Maximum bucket capacity (defaults to rate, allowing 1 second burst) N)rVr4rrrrrrXrrr4  zTokenBucketLimiter.__init__r[r r!r"r\cKs^|j"|}|durt||WddSWddS1s(wYdSz1Wait until a token is available, then consume it.N)rrr}rrrrrrrs    zTokenBucketLimiter.pre_requestrNrrhrrrrXrrs  rcr)AsyncTokenBucketLimiteraRate limiter using the token bucket algorithm. Tokens are added to a bucket at a constant rate up to a maximum capacity. Each request consumes one token. Allows bursts up to the bucket capacity. Usage:: limiter = AsyncTokenBucketLimiter(rate=10.0, capacity=50.0) # 10/s, burst of 50 async with niquests.AsyncSession(hooks=limiter) as session: ... rNrvrurrxrr.crr)rVr4rrrrrrXrrr4rz AsyncTokenBucketLimiter.__init__r[r r!r"r\c s|j4IdH+|}|dur(t|IdH|WdIdHdSWdIdHdS1IdHs9wYdSr)rrrrrrrrrrs z#AsyncTokenBucketLimiter.pre_requestrrrhrrrrXrrrr)rr) rrrrr rr!r"rr) rrrr+r rr!r"rr)%rm __future__rrrr}typingcollections.abcr_compatrrrrr r TYPE_CHECKINGmodelsr r rrr*r,rListUnionGenericr-rSrprtrrrrrrrrrs4      $2**(!!"