U ]g@sddlmZddlZddlZddlmZmZddlmZm Z ddl m Z ddl m Z ddlmZmZmZmZmZmZmZmZddlmZd d d d d d ZGdd d ee dZGdddeZdS)) annotationsN)ABCabstractmethod)Anycast)errors)StorageRegistry)CallableListOptionalPRTupleTypeUnion)LazyDependencyStoragezCallable[P, R])storagefnreturncs&tddddfdd }|S)NzP.argszP.kwargsr argskwargsrc sJz ||WSjk rD}zjr2t||W5d}~XYnXdSN)base_exceptionswrap_exceptionsrZ StorageError)rrexcrr7/tmp/pip-unpacked-wheel-kizsipjx/limits/storage/base.pyinners   z_wrap_errors..inner) functoolswraps)rrr rrr _wrap_errorssr#cseZdZUdZded<ddddfdd Zd'd d d d fdd ZeeddddZ ed(ddd dddddZ edddddZ edddddZ ed ddd Z ed!dd"d#Zedd$dd%d&ZZS))rzC Base class to extend when implementing a storage backend. zOptional[List[str]]ZSTORAGE_SCHEMErrc s2t|}dD]}t||t|t||q|S)N>checkgetresetincrclear get_expiry)super__new__setattrr#getattrclsrrinstmethod __class__rrr+,s zStorage.__new__NFz Optional[str]boolzUnion[float, str, bool])uriroptionsc st|_t||_dS)z :param wrap_exceptions: Whether to wrap storage exceptions in :exc:`limits.errors.StorageError` before raising it. N) threadingRLocklockr*__init__r)selfr5rr6r2rrr:;s  zStorage.__init__z3Union[Type[Exception], Tuple[Type[Exception], ...]])rcCstdSrNotImplementedErrorr;rrrrJszStorage.base_exceptionsstrint)keyexpiryelastic_expiryamountrcCstdS)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;rBrCrDrErrrr'Os z Storage.incr)rBrcCstdS)zB :param key: the key to get the counter value for Nr<r;rBrrrr%^sz Storage.getcCstdS)z; :param key: the key to get the expiry for Nr<rFrrrr)eszStorage.get_expirycCstdS)z- check if storage is healthy Nr<r>rrrr$lsz Storage.checkz Optional[int]cCstdS)z/ reset storage to clear limits Nr<r>rrrr&ssz Storage.resetNonecCstdS)za resets the rate limit key :param key: the key to clear rate limits for Nr<rFrrrr(zsz Storage.clear)NF)Fr?)__name__ __module__ __qualname____doc____annotations__r+r:propertyrrr'r%r)r$r&r( __classcell__rrr2rr$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#rrr-r.r2rrr+s zMovingWindowSupport.__new__r?r@rAr4)rBlimitrCrErcCstdS)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;rBrSrCrErrrrQsz!MovingWindowSupport.acquire_entryzTuple[int, int])rBrSrCrcCstdS)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;rBrSrCrrrrRs z%MovingWindowSupport.get_moving_window)r?) rHrIrJrKr+rrQrRrNrrr2rrPs  rP) __future__rr!r7abcrrtypingrrZlimitsrZlimits.storage.registryrZ limits.typingr r r r r rrrZ limits.utilrr#rrPrrrrs   (  `