U ]g#=@sddlZddlZddlmZmZddlmZddlmZddl m Z m Z ddl m Z ddlmZmZmZmZmZmZddlmZerddlZddlZGd d d Zed d Gd ddee e Zed d GdddeZed d GdddeZdS)N) TYPE_CHECKINGcast) versionadded)Version)MovingWindowSupportStorage)ConfigurationError)AsyncRedisClientDictOptionalTupleTypeUnion)get_package_datac@seZdZUdZeedZeedZeedZeedZde d<de d<de d <de d <d Z e e d d dZ d%e e eee e dddZe ee dddZe eddddZe e e ee e fdddZd&e e e ee edddZe ee dd d!Zeed"d#d$ZdS)'RedisInteractorzresources/redis/lua_scriptsz/moving_window.luaz/acquire_moving_window.luaz/clear_keys.luaz/incr_expire.luazcoredis.commands.Script[bytes]lua_moving_windowlua_acquire_windowlua_clear_keyslua_incr_expireZLIMITSkeyreturncCs|jd|S)N:)PREFIXselfrr||}|||IdH}|s(||kr:|||IdH|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 N)rZincrbyZexpire)rrr r!r"r#valuerrr_incr&s   zRedisInteractor._incr)rr!rcs"||}t||IdHpdS)zn :param connection: Redis connection :param key: the key to get the counter value for Nr)rintgetrrr!rrr_get>s zRedisInteractor._getNcs ||}||gIdHdS)zj :param key: the key to clear rate limits for :param connection: Redis connection N)rdeleter(rrr_clearGs zRedisInteractor._clear)rlimitr rcsL||}tt}|j|gt|||gIdH}|rDt|S|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) Nr)rr&timerexecutetuple)rrr,r timestampZwindowrrrget_moving_windowOs   z!RedisInteractor.get_moving_window)rr,r r!r#rcs8||}t}|j|g||||gIdH}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 connection: Redis connection N)rr-rr.bool)rrr,r r!r#r0Zacquiredrrr_acquire_entrycs  zRedisInteractor._acquire_entrycs,||}tt||IdHdtS)zg :param key: the key to get the expiry for :param connection: Redis connection Nr)rr&maxZttlr-r(rrr _get_expiryys zRedisInteractor._get_expiry)r!rcs(z|IdHWdSYdSXdS)zZ check if storage is healthy :param connection: Redis connection NTF)Zping)rr!rrr_checks zRedisInteractor._check)Fr)r)__name__ __module__ __qualname__ZRES_DIRrSCRIPT_MOVING_WINDOWSCRIPT_ACQUIRE_MOVING_WINDOWSCRIPT_CLEAR_KEYSSCRIPT_INCR_EXPIRE__annotations__rstrrr&r r2r%r)r+r r1r3r5r6rrrrrsR       rz2.1)versioncs&eZdZdZdddgZdediZd&eed e e e ee fdd fd d Z e e eeeeed ffdddZeddddZd'eee eedfdd Zeedfdd Zeddfdd Zd(eeeee dfdd Zeedfd d! Ze dfd"d# Zeedd$d%ZZS)) RedisStoragezS Rate limit storage with redis as backend. Depends on :pypi:`coredis` async+redisz async+redisszasync+redis+unixcoredis3.4.0NFzcoredis.ConnectionPool)uriconnection_poolwrap_exceptionsoptionsrc s|ddd}|dd}tj|fd|i||jdj|_|r^|jjfd|i||_n|jjj|f||_| |d S) a :param uri: uri of the form: - ``async+redis://[:password]@host:port`` - ``async+redis://[:password]@host:port/db`` - ``async+rediss://[:password]@host:port`` - ``async+redis+unix:///path/to/sock?db=0`` etc... This uri is passed directly to :meth:`coredis.Redis.from_url` with the initial ``async`` removed, except for the case of ``async+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:`coredis.Redis` :raise ConfigurationError: when the redis library is not available rBZredisrz redis+unixunixrGrCrFN) replacesuper__init__ dependenciesmodule dependencyZRedisstorageZfrom_urlinitialize_storage)rrErFrGrH __class__rrrLs   zRedisStorage.__init__.rcCs |jjjSN)rO exceptionsZ RedisErrorrrrrbase_exceptionsszRedisStorage.base_exceptions)_urircCsD|j|j|_|j|j|_|j|j|_|jtj |_ dSrU) rPZregister_scriptr:rr;rr<rrAr=r)rrYrrrrQszRedisStorage.initialize_storager)rr r"r#rcsN|r t|||j||IdHS||}tt|j|g||gIdHSdS)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)rKr%rPrrr&rr.)rrr r"r#rRrrincrs   zRedisStorage.incrrcst||jIdHSzB :param key: the key to get the counter value for N)rKr)rPrrRrrr'szRedisStorage.getcst||jIdHS)z> :param key: the key to clear rate limits for N)rKr+rPrrRrrclearszRedisStorage.clear)rr,r r#rcst||||j|IdHS)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 N)rKr3rP)rrr,r r#rRrr acquire_entrys zRedisStorage.acquire_entrycst||jIdHSz; :param key: the key to get the expiry for N)rKr5rPrrRrr get_expiryszRedisStorage.get_expirycst|jIdHS)zS Check if storage is healthy by calling :meth:`coredis.Redis.ping` N)rKr6rPrWrRrrcheckszRedisStorage.checkcs$|d}tt|j|gIdHS)aL 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. *N)rrr&rr.)rprefixrrrresets zRedisStorage.reset)NF)Fr)r)r7r8r9__doc__STORAGE_SCHEMEr DEPENDENCIESr?r r2rfloatrLpropertyr Exceptionr rXrQr&rZr'r\r]r_r`rc __classcell__rrrRrrAsL   *  rAcsteZdZUdZdgZddiZeeee ee ffe d<dee ee ee fddfd d Z e ed d d ZZS)RedisClusterStoragezZ Rate limit storage with redis cluster as backend Depends on :pypi:`coredis` zasync+redis+clusterZmax_connectionsiDEFAULT_OPTIONSFN)rErGrHrc  stj|}i}|jr |j|d<|jr0|j|d<|jdd}g}|j|ddD]&}|d\} } || t | dqXt t |j |fd |i||j d j|_|jjfd |i|j|||_||dS) av :param uri: url of the form ``async+redis+cluster://[:password]@host:port,host:port`` :param options: all remaining keyword arguments are passed directly to the constructor of :class:`coredis.RedisCluster` :raise ConfigurationError: when the coredis library is not available or if the redis host cannot be pinged. usernamepassword@rN,r)hostportrGrCZ startup_nodes)urllibparseurlparsermrnnetlocfindsplitappendr&rKrArLrMrNrOZ RedisClusterrlrPrQ) rrErGrHparsed parsed_authsepZ cluster_hostslocrqrrrRrrrL6s2      zRedisClusterStorage.__init__rTcsF|d}|j|IdH}d}|D]}||j|gIdH7}q$|S)a Redis Clusters are sharded and deleting across shards can't be done atomically. Because of this, this reset loops over all keys that are prefixed with ``self.PREFIX`` and calls delete on them, one at a time. .. warning:: This operation was not tested with extremely large data sets. On a large production based system, care should be taken with its usage as it could be slow on very large data sets raNr)rrPkeysr*)rrbr~countrrrrrc_s zRedisClusterStorage.reset)F)r7r8r9rdrerlr r?rrgr2r>rLr r&rcrjrrrRrrk$s  )rkc seZdZdZdgZdediZdeeee ee ee e ee ffe e ee fdfdd Z eed fd d Zeed fd d Ze dfdd ZZS)RedisSentinelStoragez[ Rate limit storage with redis sentinel as backend Depends on :pypi:`coredis` zasync+redis+sentinelcoredis.sentinelrDNT)rE service_name use_replicassentinel_kwargsrHc s4tj|}g}|}|r$|ni} i} |jr<|j| d<|jrL|j| d<|jdd} |j| ddD]$} | d\} }| | t |fqp|j r|j dd n||_ |j dkrtd tt||jd j|_|jj|fd | | i| ||_|j|j |_|j|j |_||_||dS) a :param uri: url of the form ``async+redis+sentinel://host:port,host:port/service_name`` :param service_name, optional: sentinel service name (if not provided in `uri`) :param use_replicas: Whether to use replicas for read only operations :param sentinel_kwargs, optional: kwargs to pass as ``sentinel_kwargs`` to :class:`coredis.sentinel.Sentinel` :param options: all remaining keyword arguments are passed directly to the constructor of :class:`coredis.sentinel.Sentinel` :raise ConfigurationError: when the coredis library is not available or if the redis primary host cannot be pinged. rmrnrorNrpr/z'service_name' not providedrr)rsrtrucopyrmrnrvrwrxryr&pathrJrrrKrArLrMrNrOZSentinelsentinelZ primary_forrPZ replica_forstorage_replicarrQ)rrErrrrHrzZsentinel_configurationZconnection_optionsZsentinel_optionsr{r|r}rqrrrRrrrLs<    zRedisSentinelStorage.__init__rcs"t||jr|jn|jIdHSr[)rKr)rrrPrrRrrr'szRedisSentinelStorage.getcs"t||jr|jn|jIdHSr^)rKr5rrrPrrRrrr_szRedisSentinelStorage.get_expiryrTcs t|jr|jn|jIdHS)zk Check if storage is healthy by calling :meth:`coredis.Redis.ping` on the replica. N)rKr6rrrPrWrRrrr`szRedisSentinelStorage.check)NTN)r7r8r9rdrerrfr?r r2r rrgrLr&r'r_r`rjrrrRrrss   <  r)r-rstypingrrZdeprecated.sphinxrZpackaging.versionrZlimits.aio.storage.baserrZ limits.errorsrZ limits.typingr r r r r rZ limits.utilrrCZcoredis.commandsrrArkrrrrrs&     ~N