9i'*ddlmZddlZddlmZmZddlmZddlm Z ddl m Z m Z ddl mZd d lmZmZmZerddlZed d GddeeeZy)) annotationsN) TYPE_CHECKINGcast)versionchanged)Version)Literal RedisClient)get_package_data)MovingWindowSupportSlidingWindowCounterSupportStoragez4.3zlAdded support for using the redis client from :pypi:`valkey` if :paramref:`uri` has the ``valkey://`` schema)versionreasonceZdZUdZgdZ ededdZdZeedZ eedZ eed Z eed Z eed Z eed Zd ed<d ed<d ed<d ed<dZded<dedf d)fd Ze d*dZd+dZd,d-dZd.dZd.dZd.dZd/dZ d0dZd1d Z d2 d3d!Zd4d"Zd5d#Z d2 d6d$Z d2 d6d%Z d7d&Z!d8d'Z"d9d(Z#xZ$S): RedisStoragez Rate limit storage with redis as backend. Depends on :pypi:`redis` (or :pypi:`valkey` if :paramref:`uri` starts with ``valkey://``) )redisredissz redis+unixvalkeyvalkeysz valkey+unixz3.0z6.0)rrzresources/redis/lua_scriptsz/moving_window.luaz/acquire_moving_window.luaz/clear_keys.luaz/incr_expire.luaz/sliding_window.luaz/acquire_sliding_window.luazredis.commands.core.Scriptlua_moving_windowlua_acquire_moving_windowlua_sliding_windowlua_acquire_sliding_windowLIMITSzLiteral['redis', 'valkey'] target_serverNFc t||fd|i|||_|jdrdnd|_|j |jj |_|j|jdd}|s#|jj|fi||_ nV|jdk(r$|jjdd|i||_ n#|jjdd|i||_ |j|y) a  :param uri: uri of the form ``redis://[:password]@host:port``, ``redis://[:password]@host:port/db``, ``rediss://[:password]@host:port``, ``redis+unix:///path/to/sock`` etc. This uri is passed directly to :func:`redis.from_url` except for the case of ``redis+unix://`` where it is replaced with ``unix://``. If the uri scheme is ``valkey`` the implementation used will be from :pypi:`valkey`. :param connection_pool: if provided, the redis client is initialized with the connection pool and any other params passed as :paramref:`options` :param key_prefix: the prefix for each key created in redis :param wrap_exceptions: Whether to wrap storage exceptions in :exc:`limits.errors.StorageError` before raising it. :param options: all remaining keyword arguments are passed directly to the constructor of :class:`redis.Redis` :raise ConfigurationError: when the :pypi:`redis` library is not available wrap_exceptionsrrz+unixunixconnection_poolN)super__init__ key_prefix startswithr dependenciesmodule dependencyreplacefrom_urlstorageRedisValkeyinitialize_storage)selfurir!r%roptions __class__s G/var/www/html/venv/lib/python3.12/site-packages/limits/storage/redis.pyr$zRedisStorage.__init__Cs4 IoII$),)AXw++D,>,>?FFkkT//06?34??33CC7CDL!!W,4t44 $3 7>   6t55 $3 7>   $cx|jdk(r|jjS|jjS)Nr)rr) RedisError ValkeyErrorr0s r4base_exceptionszRedisStorage.base_exceptionsqs: !!W, OO & & ,, r5c,|jj|j|_|jj|j|_|jj|j |_|jj|j|_ |jj|j|_ |jj|j|_ yN)get_connectionregister_scriptSCRIPT_MOVING_WINDOWrSCRIPT_ACQUIRE_MOVING_WINDOWrSCRIPT_CLEAR_KEYSlua_clear_keysSCRIPT_INCR_EXPIRElua_incr_expireSCRIPT_SLIDING_WINDOWrSCRIPT_ACQUIRE_SLIDING_WINDOWr)r0_uris r4r/zRedisStorage.initialize_storage{s!%!4!4!6!F!F  % %" *.)<)<)>)N)N  - -* &#113CC  " "  $224DD  # # #'"5"5"7"G"G  & &# +/*=*=*?*O*O  . .+ 'r5c6tt|jSr<)rr r,)r0readonlys r4r=zRedisStorage.get_connectionsK..r5cd|dS)a Return the current window's storage key (Sliding window strategy) Contrary to other strategies that have one key per rate limit item, this strategy has two keys per rate limit item than must be on the same machine. To keep the current key and the previous key on the same Redis cluster node, curly braces are added. Eg: "{constructed_key}" {}r"r0keys r4_current_window_keyz RedisStorage._current_window_keysC5|r5c*|j|dS)a% Return the previous window's storage key (Sliding window strategy). Curvy braces are added on the common pattern with the current window's key, so the current and the previous key are stored on the same Redis cluster node. Eg: "{constructed_key}/-1" z/-1)rOrMs r4_previous_window_keyz!RedisStorage._previous_window_keys**3/044r5c$|jd|S)N:)r%rMs r4 prefixed_keyzRedisStorage.prefixed_keys//"!C5))r5c|j|}tj}|j|g||z |gx}rt|d|dfS|dfS)z returns the starting point and the number of entries in the moving window :param key: rate limit key :param expiry: expiry of entry :return: (start of window, number of acquired entries) rr )rTtimerfloat)r0rNlimitexpiry timestampwindows r4get_moving_windowzRedisStorage.get_moving_windowse$IIK ++SEI4F3NO O6 O#VAY. .!|r5c r|j|j|}|j|j|}|j||g|gx}r`t |dxsdt dt |dxsddz t |dxsdt dt |dxsddz fSy)Nrr ir )rrr_)rTrQrOrintmaxrW)r0rNrY previous_key current_keyr[s r4get_sliding_windowzRedisStorage.get_sliding_windows(()B)B3)GH ''(@(@(EF ,,lK-H6(S S6 SF1IN#AuVAY^!,-4F1IN#AuVAY^!,-4   r5c|j|}|j|}|j||j|yr<)rQrOclear)r0rNrYrbrcs r4clear_sliding_windowz!RedisStorage.clear_sliding_windows:005 ..s3  <  ;r5c`|j|}t|j|g||gS)z increments the counter for a given rate limit key :param key: the key to increment :param expiry: amount in seconds for the key to expire in :param amount: the number to increment by )rTr`rD)r0rNrYamounts r4incrzRedisStorage.incrs3$4''/?@AAr5c~|j|}t|jdj|xsdS)zC :param key: the key to get the counter value for Tr)rTr`r=getrMs r4rlzRedisStorage.gets: $4&&t,005:;;r5cd|j|}|jj|y)z> :param key: the key to clear rate limits for N)rTr=deleterMs r4rfzRedisStorage.clears+$ $$S)r5c|j|}tj}|j|g||||g}t|S)z :param key: rate limit key to acquire an entry in :param limit: amount of entries allowed :param expiry: expiry of the entry :param amount: the number of entries to acquire )rTrVrbool)r0rNrXrYrirZacquireds r4 acquire_entryzRedisStorage.acquire_entrysK$IIK 11 EIuff5 H~r5c|j|j|}|j|j|}|j||g|||g}t |S)a0 Acquire an entry. Shift the current window to the previous window if it expired. :param key: rate limit key to acquire an entry in :param limit: amount of entries allowed :param expiry: expiry of the entry :param amount: the number of entries to acquire )rTrQrOrrp)r0rNrXrYrirbrcrqs r4acquire_sliding_window_entryz)RedisStorage.acquire_sliding_window_entrysg(()B)B3)GH ''(@(@(EF 22 ; '%)@ H~r5c|j|}t|jdj|dt jzS)z< :param key: the key to get the expiry for Tr)rTrar=ttlrVrMs r4 get_expiryzRedisStorage.get_expirysB $4&&t,005q9DIIKGGr5cN |jjS#YyxYw)z- check if storage is healthy F)r=pingr9s r4checkzRedisStorage.check's) &&(--/ / s $cZ|jd}t|j|gS)al This function calls a Lua Script to delete keys prefixed with :paramref:`RedisStorage.key_prefix` in blocks of 5000. .. warning:: This operation was designed to be fast, but was not tested on a large production based system. Be careful with its usage as it could be slow on very large data sets. *)rTr`rB)r0prefixs r4resetzRedisStorage.reset0s,""3'4&&x011r5) r1strr!z&redis.connection.ConnectionPool | Noner%rrrpr2zfloat | str | boolreturnNone)rz-type[Exception] | tuple[type[Exception], ...])rGrrr)F)rIrprr )rNrrr)rNrrXr`rYr`rztuple[float, int])rNrrYr`rztuple[int, float, int, float])rNrrYr`rr)r )rNrrYr`rir`rr`)rNrrr`)rNrrr) rNrrXr`rYr`rir`rrp)rNrrrW)rrp)rz int | None)%__name__ __module__ __qualname____doc__STORAGE_SCHEMEr DEPENDENCIESRES_DIRr r?r@rArCrErF__annotations__PREFIXr$propertyr:r/r=rOrQrTr\rdrgrjrlrfrrrtrwrzr~ __classcell__)r3s@r4rrs6N'$U^wu~FL+G+wi7I,JK#3 )-.$ )G9O)DE)WI5E*FG,y8K-LM$4 )./%!219922 :: F-- CG % ,% ,%@,% ,%  ,% & ,% ,%\ 6   (/  5*   #  &   B BB B B"<*       6       ,H 2r5r) __future__rrVtypingrrdeprecated.sphinxrpackaging.versionr limits.typingrr utilr baser rrrrr"r5r4rsW" &,%.#KK  ;d27/1Ld2d2r5