limits 4.0.1__py3-none-any.whl → 4.2__py3-none-any.whl

limits/aio/storage/redis/redispy.py

@@ -0,0 +1,257 @@
+from __future__ import annotations
+
+import time
+from typing import TYPE_CHECKING, Type, cast
+
+from limits.aio.storage.redis.bridge import RedisBridge
+from limits.errors import ConfigurationError
+from limits.typing import AsyncRedisClient, Callable, Optional, Union
+
+if TYPE_CHECKING:
+    import redis.commands
+
+
+class RedispyBridge(RedisBridge):
+    DEFAULT_CLUSTER_OPTIONS: dict[str, Union[float, str, bool]] = {
+        "max_connections": 1000,
+    }
+    "Default options passed to :class:`redis.asyncio.RedisCluster`"
+
+    @property
+    def base_exceptions(self) -> Union[Type[Exception], tuple[Type[Exception], ...]]:
+        return (self.dependency.RedisError,)
+
+    def use_sentinel(
+        self,
+        service_name: Optional[str],
+        use_replicas: bool,
+        sentinel_kwargs: Optional[dict[str, Union[str, float, bool]]],
+        **options: Union[str, float, bool],
+    ) -> None:
+        sentinel_configuration = []
+
+        connection_options = options.copy()
+
+        sep = self.parsed_uri.netloc.find("@") + 1
+
+        for loc in self.parsed_uri.netloc[sep:].split(","):
+            host, port = loc.split(":")
+            sentinel_configuration.append((host, int(port)))
+        service_name = (
+            self.parsed_uri.path.replace("/", "")
+            if self.parsed_uri.path
+            else service_name
+        )
+
+        if service_name is None:
+            raise ConfigurationError("'service_name' not provided")
+
+        self.sentinel = self.dependency.asyncio.Sentinel(
+            sentinel_configuration,
+            sentinel_kwargs={**self.parsed_auth, **(sentinel_kwargs or {})},
+            **{**self.parsed_auth, **connection_options},
+        )
+        self.storage = self.sentinel.master_for(service_name)
+        self.storage_replica = self.sentinel.slave_for(service_name)
+        self.connection_getter = lambda readonly: (
+            self.storage_replica if readonly and use_replicas else self.storage
+        )
+
+    def use_basic(self, **options: Union[str, float, bool]) -> None:
+        if connection_pool := options.pop("connection_pool", None):
+            self.storage = self.dependency.asyncio.Redis(
+                connection_pool=connection_pool, **options
+            )
+        else:
+            self.storage = self.dependency.asyncio.Redis.from_url(self.uri, **options)
+
+        self.connection_getter = lambda _: self.storage
+
+    def use_cluster(self, **options: Union[str, float, bool]) -> None:
+        sep = self.parsed_uri.netloc.find("@") + 1
+        cluster_hosts = []
+
+        for loc in self.parsed_uri.netloc[sep:].split(","):
+            host, port = loc.split(":")
+            cluster_hosts.append(
+                self.dependency.asyncio.cluster.ClusterNode(host=host, port=int(port))
+            )
+
+        self.storage = self.dependency.asyncio.RedisCluster(
+            startup_nodes=cluster_hosts,
+            **{**self.DEFAULT_CLUSTER_OPTIONS, **self.parsed_auth, **options},
+        )
+        self.connection_getter = lambda _: self.storage
+
+    lua_moving_window: "redis.commands.core.Script"
+    lua_acquire_moving_window: "redis.commands.core.Script"
+    lua_sliding_window: "redis.commands.core.Script"
+    lua_acquire_sliding_window: "redis.commands.core.Script"
+    lua_clear_keys: "redis.commands.core.Script"
+    lua_incr_expire: "redis.commands.core.Script"
+    connection_getter: Callable[[bool], AsyncRedisClient]
+
+    def get_connection(self, readonly: bool = False) -> AsyncRedisClient:
+        return self.connection_getter(readonly)
+
+    def register_scripts(self) -> None:
+        # Redis-py uses a slightly different script registration
+        self.lua_moving_window = self.get_connection().register_script(
+            self.SCRIPT_MOVING_WINDOW
+        )
+        self.lua_acquire_moving_window = self.get_connection().register_script(
+            self.SCRIPT_ACQUIRE_MOVING_WINDOW
+        )
+        self.lua_clear_keys = self.get_connection().register_script(
+            self.SCRIPT_CLEAR_KEYS
+        )
+        self.lua_incr_expire = self.get_connection().register_script(
+            self.SCRIPT_INCR_EXPIRE
+        )
+        self.lua_sliding_window = self.get_connection().register_script(
+            self.SCRIPT_SLIDING_WINDOW
+        )
+        self.lua_acquire_sliding_window = self.get_connection().register_script(
+            self.SCRIPT_ACQUIRE_SLIDING_WINDOW
+        )
+
+    async def incr(
+        self,
+        key: str,
+        expiry: int,
+        elastic_expiry: bool = False,
+        amount: int = 1,
+    ) -> int:
+        """
+        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
+        """
+        key = self.prefixed_key(key)
+
+        if elastic_expiry:
+            value = await self.get_connection().incrby(key, amount)
+            await self.get_connection().expire(key, expiry)
+            return value
+        else:
+            return cast(int, await self.lua_incr_expire([key], [expiry, amount]))
+
+    async def get(self, key: str) -> int:
+        """
+
+        :param key: the key to get the counter value for
+        """
+
+        key = self.prefixed_key(key)
+        return int(await self.get_connection(readonly=True).get(key) or 0)
+
+    async def clear(self, key: str) -> None:
+        """
+        :param key: the key to clear rate limits for
+
+        """
+        key = self.prefixed_key(key)
+        await self.get_connection().delete(key)
+
+    async def lua_reset(self) -> Optional[int]:
+        return cast(int, await self.lua_clear_keys([self.prefixed_key("*")]))
+
+    async def get_moving_window(
+        self, key: str, limit: int, expiry: int
+    ) -> tuple[float, int]:
+        """
+        returns the starting point and the number of entries in the moving
+        window
+
+        :param key: rate limit key
+        :param expiry: expiry of entry
+        :return: (previous count, previous TTL, current count, current TTL)
+        """
+        key = self.prefixed_key(key)
+        timestamp = time.time()
+        window = await self.lua_moving_window([key], [timestamp - expiry, limit])
+        if window:
+            return float(window[0]), window[1]
+        return timestamp, 0
+
+    async def get_sliding_window(
+        self, previous_key: str, current_key: str, expiry: int
+    ) -> tuple[int, float, int, float]:
+        if window := await self.lua_sliding_window(
+            [self.prefixed_key(previous_key), self.prefixed_key(current_key)], [expiry]
+        ):
+            return (
+                int(window[0] or 0),
+                max(0, float(window[1] or 0)) / 1000,
+                int(window[2] or 0),
+                max(0, float(window[3] or 0)) / 1000,
+            )
+        return 0, 0.0, 0, 0.0
+
+    async def acquire_entry(
+        self,
+        key: str,
+        limit: int,
+        expiry: int,
+        amount: int = 1,
+    ) -> bool:
+        """
+        :param key: rate limit key to acquire an entry in
+        :param limit: amount of entries allowed
+        :param expiry: expiry of the entry
+
+        """
+        key = self.prefixed_key(key)
+        timestamp = time.time()
+        acquired = await self.lua_acquire_moving_window(
+            [key], [timestamp, limit, expiry, amount]
+        )
+
+        return bool(acquired)
+
+    async def acquire_sliding_window_entry(
+        self,
+        previous_key: str,
+        current_key: str,
+        limit: int,
+        expiry: int,
+        amount: int = 1,
+    ) -> bool:
+        previous_key = self.prefixed_key(previous_key)
+        current_key = self.prefixed_key(current_key)
+        acquired = await self.lua_acquire_sliding_window(
+            [previous_key, current_key], [limit, expiry, amount]
+        )
+        return bool(acquired)
+
+    async def get_expiry(self, key: str) -> float:
+        """
+        :param key: the key to get the expiry for
+        """
+
+        key = self.prefixed_key(key)
+        return max(await self.get_connection().ttl(key), 0) + time.time()
+
+    async def check(self) -> bool:
+        """
+        check if storage is healthy
+        """
+        try:
+            await self.get_connection().ping()
+
+            return True
+        except:  # noqa
+            return False
+
+    async def reset(self) -> Optional[int]:
+        prefix = self.prefixed_key("*")
+        keys = await self.storage.keys(
+            prefix, target_nodes=self.dependency.asyncio.cluster.RedisCluster.ALL_NODES
+        )
+        count = 0
+        for key in keys:
+            count += await self.storage.delete(key)
+        return count

limits/aio/strategies.py

@@ -2,13 +2,20 @@
 Asynchronous rate limiting strategies
 """
 
+from __future__ import annotations
+
+import time
 from abc import ABC, abstractmethod
-from typing import cast
+from math import floor, inf
+
+from deprecated.sphinx import deprecated, versionadded
 
 from ..limits import RateLimitItem
 from ..storage import StorageTypes
+from ..typing import cast
 from ..util import WindowStats
 from .storage import MovingWindowSupport, Storage
+from .storage.base import SlidingWindowCounterSupport
 
 
 class RateLimiter(ABC):
@@ -183,6 +190,121 @@ class FixedWindowRateLimiter(RateLimiter):
         return WindowStats(reset, remaining)
 
 
+@versionadded(version="4.1")
+class SlidingWindowCounterRateLimiter(RateLimiter):
+    """
+    Reference: :ref:`strategies:sliding window counter`
+    """
+
+    def __init__(self, storage: StorageTypes):
+        if not hasattr(storage, "get_sliding_window") or not hasattr(
+            storage, "acquire_sliding_window_entry"
+        ):
+            raise NotImplementedError(
+                "SlidingWindowCounterRateLimiting is not implemented for storage "
+                "of type %s" % storage.__class__
+            )
+        super().__init__(storage)
+
+    def _weighted_count(
+        self,
+        item: RateLimitItem,
+        previous_count: int,
+        previous_expires_in: float,
+        current_count: int,
+    ) -> float:
+        """
+        Return the approximated by weighting the previous window count and adding the current window count.
+        """
+        return previous_count * previous_expires_in / item.get_expiry() + current_count
+
+    async def hit(self, item: RateLimitItem, *identifiers: str, cost: int = 1) -> bool:
+        """
+        Consume the rate limit
+
+        :param item: The rate limit item
+        :param identifiers: variable list of strings to uniquely identify this
+         instance of the limit
+        :param cost: The cost of this hit, default 1
+        """
+        return await cast(
+            SlidingWindowCounterSupport, self.storage
+        ).acquire_sliding_window_entry(
+            item.key_for(*identifiers),
+            item.amount,
+            item.get_expiry(),
+            cost,
+        )
+
+    async def test(self, item: RateLimitItem, *identifiers: str, cost: int = 1) -> bool:
+        """
+        Check if the rate limit can be consumed
+
+        :param item: The rate limit item
+        :param identifiers: variable list of strings to uniquely identify this
+         instance of the limit
+        :param cost: The expected cost to be consumed, default 1
+        """
+
+        previous_count, previous_expires_in, current_count, _ = await cast(
+            SlidingWindowCounterSupport, self.storage
+        ).get_sliding_window(item.key_for(*identifiers), item.get_expiry())
+
+        return (
+            self._weighted_count(
+                item, previous_count, previous_expires_in, current_count
+            )
+            < item.amount - cost + 1
+        )
+
+    async def get_window_stats(
+        self, item: RateLimitItem, *identifiers: str
+    ) -> WindowStats:
+        """
+        Query the reset time and remaining amount for the limit.
+
+        :param item: The rate limit item
+        :param identifiers: variable list of strings to uniquely identify this
+         instance of the limit
+        :return: (reset time, remaining)
+        """
+
+        (
+            previous_count,
+            previous_expires_in,
+            current_count,
+            current_expires_in,
+        ) = await cast(SlidingWindowCounterSupport, self.storage).get_sliding_window(
+            item.key_for(*identifiers), item.get_expiry()
+        )
+
+        remaining = max(
+            0,
+            item.amount
+            - floor(
+                self._weighted_count(
+                    item, previous_count, previous_expires_in, current_count
+                )
+            ),
+        )
+
+        now = time.time()
+
+        if not (previous_count or current_count):
+            return WindowStats(now, remaining)
+
+        expiry = item.get_expiry()
+
+        previous_reset_in, current_reset_in = inf, inf
+        if previous_count:
+            previous_reset_in = previous_expires_in % (expiry / previous_count)
+        if current_count:
+            current_reset_in = current_expires_in % expiry
+
+        return WindowStats(now + min(previous_reset_in, current_reset_in), remaining)
+
+
+@deprecated(version="4.1")
 class FixedWindowElasticExpiryRateLimiter(FixedWindowRateLimiter):
     """
     Reference: :ref:`strategies:fixed window with elastic expiry`
@@ -208,6 +330,7 @@ class FixedWindowElasticExpiryRateLimiter(FixedWindowRateLimiter):
 
 
 STRATEGIES = {
+    "sliding-window-counter": SlidingWindowCounterRateLimiter,
     "fixed-window": FixedWindowRateLimiter,
     "fixed-window-elastic-expiry": FixedWindowElasticExpiryRateLimiter,
     "moving-window": MovingWindowRateLimiter,

limits/errors.py

@@ -2,6 +2,8 @@
 errors and exceptions
 """
 
+from __future__ import annotations
+
 
 class ConfigurationError(Exception):
     """

limits/limits.py

@@ -3,14 +3,13 @@
 from __future__ import annotations
 
 from functools import total_ordering
-from typing import Dict, NamedTuple, Optional, Tuple, Type, Union, cast
 
-from limits.typing import ClassVar, List
+from limits.typing import ClassVar, NamedTuple, cast
 
 
-def safe_string(value: Union[bytes, str, int]) -> str:
+def safe_string(value: bytes | str | int | float) -> str:
     """
-    converts a byte/str or int to a str
+    normalize a byte/str/int or float to a str
     """
 
     if isinstance(value, bytes):
@@ -33,15 +32,15 @@ TIME_TYPES = dict(
     second=Granularity(1, "second"),
 )
 
-GRANULARITIES: Dict[str, Type[RateLimitItem]] = {}
+GRANULARITIES: dict[str, type[RateLimitItem]] = {}
 
 
 class RateLimitItemMeta(type):
     def __new__(
         cls,
         name: str,
-        parents: Tuple[type, ...],
-        dct: Dict[str, Union[Granularity, List[str]]],
+        parents: tuple[type, ...],
+        dct: dict[str, Granularity | list[str]],
     ) -> RateLimitItemMeta:
         if "__slots__" not in dct:
             dct["__slots__"] = []
@@ -49,7 +48,7 @@ class RateLimitItemMeta(type):
 
         if "GRANULARITY" in dct:
             GRANULARITIES[dct["GRANULARITY"][1]] = cast(
-                Type[RateLimitItem], granularity
+                type[RateLimitItem], granularity
             )
 
         return granularity
@@ -77,7 +76,7 @@ class RateLimitItem(metaclass=RateLimitItemMeta):
     """
 
     def __init__(
-        self, amount: int, multiples: Optional[int] = 1, namespace: str = "LIMITER"
+        self, amount: int, multiples: int | None = 1, namespace: str = "LIMITER"
     ):
         self.namespace = namespace
         self.amount = int(amount)
@@ -101,14 +100,14 @@ class RateLimitItem(metaclass=RateLimitItemMeta):
 
         return self.GRANULARITY.seconds * self.multiples
 
-    def key_for(self, *identifiers: str) -> str:
+    def key_for(self, *identifiers: bytes | str | int | float) -> str:
         """
         Constructs a key for the current limit and any additional
         identifiers provided.
 
         :param identifiers: a list of strings to append to the key
         :return: a string key identifying this resource with
-         each identifier appended with a '/' delimiter.
+         each identifier separated with a '/' delimiter.
         """
         remainder = "/".join(
             [safe_string(k) for k in identifiers]

limits/resources/redis/lua_scripts/acquire_sliding_window.lua

@@ -0,0 +1,45 @@
+-- Time is in milliseconds in this script: TTL, expiry...
+
+local limit = tonumber(ARGV[1])
+local expiry = tonumber(ARGV[2]) * 1000
+local amount = tonumber(ARGV[3])
+
+if amount > limit then
+    return false
+end
+
+local current_ttl = tonumber(redis.call('pttl', KEYS[2]))
+
+if current_ttl > 0 and current_ttl < expiry then
+    -- Current window expired, shift it to the previous window
+    redis.call('rename', KEYS[2], KEYS[1])
+    redis.call('set', KEYS[2], 0, 'PX', current_ttl + expiry)
+end
+
+local previous_count = tonumber(redis.call('get', KEYS[1])) or 0
+local previous_ttl = tonumber(redis.call('pttl', KEYS[1])) or 0
+local current_count = tonumber(redis.call('get', KEYS[2])) or 0
+current_ttl = tonumber(redis.call('pttl', KEYS[2])) or 0
+
+-- If the values don't exist yet, consider the TTL is 0
+if previous_ttl <= 0 then
+    previous_ttl = 0
+end
+if current_ttl <= 0 then
+    current_ttl = 0
+end
+local weighted_count = math.floor(previous_count * previous_ttl / expiry) + current_count
+
+if (weighted_count + amount) > limit then
+    return false
+end
+
+-- If the current counter exists, increase its value
+if redis.call('exists', KEYS[2]) == 1 then
+    redis.call('incrby', KEYS[2], amount)
+else
+    -- Otherwise, set the value with twice the expiry time
+    redis.call('set', KEYS[2], amount, 'PX', expiry * 2)
+end
+
+return true

limits/resources/redis/lua_scripts/sliding_window.lua

@@ -0,0 +1,17 @@
+local expiry = tonumber(ARGV[1]) * 1000
+local previous_count = redis.call('get', KEYS[1])
+local previous_ttl = redis.call('pttl', KEYS[1])
+local current_count = redis.call('get', KEYS[2])
+local current_ttl = redis.call('pttl', KEYS[2])
+
+if current_ttl > 0 and current_ttl < expiry then
+    -- Current window expired, shift it to the previous window
+    redis.call('rename', KEYS[2], KEYS[1])
+    redis.call('set', KEYS[2], 0, 'PX', current_ttl + expiry)
+    previous_count = redis.call('get', KEYS[1])
+    previous_ttl = redis.call('pttl', KEYS[1])
+    current_count = redis.call('get', KEYS[2])
+    current_ttl = redis.call('pttl', KEYS[2])
+end
+
+return {previous_count, previous_ttl, current_count, current_ttl}

limits/storage/__init__.py

@@ -3,13 +3,15 @@ Implementations of storage backends to be used with
 :class:`limits.strategies.RateLimiter` strategies
 """
 
+from __future__ import annotations
+
 import urllib
-from typing import Union, cast
 
-import limits
+import limits  # noqa
 
 from ..errors import ConfigurationError
-from .base import MovingWindowSupport, Storage
+from ..typing import Union, cast
+from .base import MovingWindowSupport, SlidingWindowCounterSupport, Storage
 from .etcd import EtcdStorage
 from .memcached import MemcachedStorage
 from .memory import MemoryStorage
@@ -67,6 +69,7 @@ __all__ = [
     "storage_from_string",
     "Storage",
     "MovingWindowSupport",
+    "SlidingWindowCounterSupport",
     "EtcdStorage",
     "MongoDBStorageBase",
     "MemoryStorage",