U ]g!@sddlmZddlZddlmZddlmZddlmZm Z m Z m Z m Z m Z ddlmZdd lmZmZertddlZGd d d ZGd d d eeeZdS)) annotationsN) TYPE_CHECKING)Version)Optional RedisClientScriptPTupleTypeUnion)get_package_data)MovingWindowSupportStoragec@seZdZUdZeedZeedZeedZeedZde d<de d <d Z d d d d dZ d ddddddZ d*d ddddddddZ d dddddZd ddddd Zd+d dddddd!d"d#Zd dddd$d%Zddd&d'd(Zd)S),RedisInteractorzresources/redis/lua_scriptsz/moving_window.luaz/acquire_moving_window.luaz/clear_keys.luaz/incr_expire.luazScriptP[Tuple[int, int]]lua_moving_windowz ScriptP[bool]lua_acquire_windowZLIMITSstrkeyreturncCs|jd|S)N:)PREFIXselfrr8/tmp/pip-unpacked-wheel-kizsipjx/limits/storage/redis.py prefixed_key szRedisInteractor.prefixed_keyintzTuple[int, int])rlimitexpiryrcCs<||}t}||gt|||g}|p:t|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) r)rtimerr)rrrr timestampZwindowrrrget_moving_window#s z!RedisInteractor.get_moving_windowFr rbool)rr connectionelastic_expiryamountrcCs2||}|||}|s"||kr.||||S)a  increments the counter for a given rate limit key :param connection: Redis connection :param key: the key to increment :param expiry: amount in seconds for the key to expire in :param amount: the number to increment by )rZincrbyZexpire)rrr r%r&r'valuerrr_incr2s     zRedisInteractor._incr)rr%rcCs||}t||pdS)zn :param connection: Redis connection :param key: the key to get the counter value for r)rrgetrrr%rrr_getJs zRedisInteractor._getNonecCs||}||dS)zj :param key: the key to clear rate limits for :param connection: Redis connection N)rdeleter+rrr_clearSs zRedisInteractor._clear)rrr r%r'rcCs0||}t}||g||||g}t|S)a :param key: rate limit key to acquire an entry in :param limit: amount of entries allowed :param expiry: expiry of the entry :param connection: Redis connection :param amount: the number of entries to acquire )rr!rr$)rrrr r%r'r"Zacquiredrrr_acquire_entry[s zRedisInteractor._acquire_entrycCs&||}tt||dtS)zg :param key: the key to get the expiry for :param connection: Redis connection r)rrmaxZttlr!r+rrr _get_expiryps zRedisInteractor._get_expiry)r%rcCsz |WSYdSXdS)zY :param connection: Redis connection check if storage is healthy FN)Zping)rr%rrr_checkys zRedisInteractor._checkN)Fr )r )__name__ __module__ __qualname__ZRES_DIRr SCRIPT_MOVING_WINDOWSCRIPT_ACQUIRE_MOVING_WINDOWSCRIPT_CLEAR_KEYSSCRIPT_INCR_EXPIRE__annotations__rrr#r)r,r/r0r2r3rrrrrs*   rcseZdZdZdddgZdediZd+dd d d d d fdd ZeddddZ dd dddZ d,ddd dddfdd Z dddfdd Z dd dfdd Z d-ddddd d!fd"d# Zdddfd$d% Zd dfd&d' Zd(dd)d*ZZS). RedisStoragezR Rate limit storage with redis as backend. Depends on :pypi:`redis`. redisZrediss redis+unixz3.0NFrz)Optional[redis.connection.ConnectionPool]r$zUnion[float, str, bool]r-)uriconnection_poolwrap_exceptionsoptionsrc sptj|fd|i||jdj|_|dd}|sJ|jj|f||_n|jjfd|i||_| |dS)aa :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://``. :param connection_pool: if provided, the redis client is initialized with the connection pool and any other params passed as :paramref:`options` :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 rAr=r>unixr@N) super__init__Z dependenciesmodule dependencyreplaceZfrom_urlstorageZRedisinitialize_storage)rr?r@rArB __class__rrrEs  zRedisStorage.__init__z3Union[Type[Exception], Tuple[Type[Exception], ...]])rcCs|jjSN)rGZ RedisErrorrrrrbase_exceptionsszRedisStorage.base_exceptions)_urircCsD|j|j|_|j|j|_|j|j|_|jtj |_ dSrM) rIZregister_scriptr7rr8rr9lua_clear_keysr<r:lua_incr_expire)rrPrrrrJszRedisStorage.initialize_storager r)rr r&r'rcs>|rt|||j||S||}t||g||gSdS)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 N)rDr)rIrrrR)rrr r&r'rKrrincrs  zRedisStorage.incrrcst||jS)zB :param key: the key to get the counter value for )rDr,rIrrKrrr*szRedisStorage.getcst||jS)z> :param key: the key to clear rate limits for )rDr/rIrrKrrclearszRedisStorage.clear)rrr r'rcst||||j|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 to increment by )rDr0rI)rrrr r'rKrr acquire_entryszRedisStorage.acquire_entrycst||jS)z; :param key: the key to get the expiry for )rDr2rIrrKrr get_expiryszRedisStorage.get_expirycst|jS)z- check if storage is healthy )rDr3rIrNrKrrcheckszRedisStorage.checkz Optional[int]cCs|d}t||gS)aX This function calls a Lua Script to delete keys prefixed with ``self.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. *)rrrQ)rprefixrrrresets zRedisStorage.reset)NF)Fr )r )r4r5r6__doc__ZSTORAGE_SCHEMErZ DEPENDENCIESrEpropertyrOrJrSr*rTrUrVrWrZ __classcell__rrrKrr<s$  "  r<) __future__rr!typingrZpackaging.versionrZ limits.typingrrrrr r utilr baserrr=rr<rrrrs     s