U ]g@sddlmZddlZddlmZmZddlmZmZddl m Z ddl m Z ddl mZddlmZmZmZmZmZmZmZmZmZdd lmZd d d d d dZe ddGdd d eedZGdddeZdS)) annotationsN)ABCabstractmethod)Anycast) versionadded)errors)StorageRegistry) AwaitableCallableListOptionalPRTupleTypeUnion)LazyDependencyStoragezCallable[P, Awaitable[R]])storagefnreturncs&tddddfdd }|S)NzP.argszP.kwargsrargskwargsrc sPz||IdHWSjk rJ}zjr8t||W5d}~XYnXdSN)base_exceptionswrap_exceptionsrZ StorageError)rrexcrr;/tmp/pip-unpacked-wheel-kizsipjx/limits/aio/storage/base.pyinners  z_wrap_errors..inner) functoolswraps)rrr"r rr! _wrap_errorssr%z2.1)versioncseZdZUdZded<ddddfdd Zd'd d d d dfdd ZeeddddZ ed(ddd dddddZ edddddZ edddddZ ed dd d!Z ed"dd#d$Zedd dd%d&ZZS))rzJ Base class to extend when implementing an async storage backend. zOptional[List[str]]ZSTORAGE_SCHEMErrc s2t|}dD]}t||t|t||q|S)N>checkgetresetincrclear get_expiry)super__new__setattrr%getattrclsrrinstmethod __class__r r!r.2s zStorage.__new__NFz Optional[str]boolzUnion[float, str, bool]None)uriroptionsrc st||_dS)z :param wrap_exceptions: Whether to wrap storage exceptions in :exc:`limits.errors.StorageError` before raising it. N)r-__init__r)selfr9rr:r5r r!r;As zStorage.__init__z3Union[Type[Exception], Tuple[Type[Exception], ...]])rcCstdSrNotImplementedErrorr<r r r!rNszStorage.base_exceptionsstrint)keyexpiryelastic_expiryamountrcstdS)aD 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 elastic_expiry: whether to keep extending the rate limit window every hit. :param amount: the number to increment by Nr=)r<rCrDrErFr r r!r*Ss z Storage.incr)rCrcstdS)zB :param key: the key to get the counter value for Nr=r<rCr r r!r(bsz Storage.getcstdS)z; :param key: the key to get the expiry for Nr=rGr r r!r,iszStorage.get_expirycstdS)z- check if storage is healthy Nr=r?r r r!r'psz Storage.checkz Optional[int]cstdS)z/ reset storage to clear limits Nr=r?r r r!r)wsz Storage.resetcstdS)za resets the rate limit key :param key: the key to clear rate limits for Nr=rGr r r!r+~sz Storage.clear)NF)Fr@)__name__ __module__ __qualname____doc____annotations__r.r;propertyrrr*r(r,r'r)r+ __classcell__r r r5r!r)s.  ) metaclasscs^eZdZdZddddfdd Zedddddd d d d Zedddd dddZZS)MovingWindowSupportzZ Abstract base for storages that intend to support the moving window strategy rrc s8t|}dD]"}t||ttt|t||q|S)N> acquire_entryget_moving_window)r-r.r/r%rrr0r1r5r r!r.s zMovingWindowSupport.__new__r@rArBr7)rClimitrDrFrcstdS)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 Nr=)r<rCrSrDrFr r r!rQs z!MovingWindowSupport.acquire_entryzTuple[int, int])rCrSrDrcstdS)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=)r<rCrSrDr r r!rRs z%MovingWindowSupport.get_moving_window)r@) rHrIrJrKr.rrQrRrNr r r5r!rPs rP) __future__rr#abcrrtypingrrZdeprecated.sphinxrZlimitsrZlimits.storage.registryr Z limits.typingr r r r rrrrrZ limits.utilrr%rrPr r r r!s    , ^