limits 5.0.0rc1__py3-none-any.whl → 5.1.0__py3-none-any.whl

limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-09T18:20:47-0700",
+ "date": "2025-04-23T10:35:38-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "4a01f1090a5accfb05b7db6dc6469f7c51d4fa67",
- "version": "5.0.0rc1"
+ "full-revisionid": "2b76ea0a8aa2a37b2069ab5990e9ae180de6491f",
+ "version": "5.1.0"
 }
 '''  # END VERSION_JSON
 

limits/aio/storage/{memcached.py → memcached/__init__.py}

@@ -1,24 +1,23 @@
 from __future__ import annotations
 
 import time
-import urllib.parse
-from collections.abc import Iterable
-from math import ceil, floor
-from typing import TYPE_CHECKING
+from math import floor
 
 from deprecated.sphinx import versionadded, versionchanged
+from packaging.version import Version
 
-from limits.aio.storage.base import SlidingWindowCounterSupport, Storage
+from limits.aio.storage import SlidingWindowCounterSupport, Storage
+from limits.aio.storage.memcached.bridge import MemcachedBridge
+from limits.aio.storage.memcached.emcache import EmcacheBridge
+from limits.aio.storage.memcached.memcachio import MemcachioBridge
 from limits.storage.base import TimestampedSlidingWindow
-
-if TYPE_CHECKING:
-    import memcachio
+from limits.typing import Literal
 
 
 @versionadded(version="2.1")
 @versionchanged(
     version="5.0",
-    reason="Switched to :pypi:`memcachio` for async memcached support",
+    reason="Switched default implementation to :pypi:`memcachio`",
 )
 class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingWindow):
     """
@@ -30,12 +29,19 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
     STORAGE_SCHEME = ["async+memcached"]
     """The storage scheme for memcached to be used in an async context"""
 
-    DEPENDENCIES = ["memcachio"]
+    DEPENDENCIES = {
+        "memcachio": Version("0.3"),
+        "emcache": Version("0.0"),
+    }
+
+    bridge: MemcachedBridge
+    storage_exceptions: tuple[Exception, ...]
 
     def __init__(
         self,
         uri: str,
         wrap_exceptions: bool = False,
+        implementation: Literal["memcachio", "emcache"] = "memcachio",
         **options: float | str | bool,
     ) -> None:
         """
@@ -43,77 +49,41 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
          ``async+memcached://host:port,host:port``
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
+        :param implementation: Whether to use the client implementation from
+
+         - ``memcachio``: :class:`memcachio.Client`
+         - ``emcache``: :class:`emcache.Client`
         :param options: all remaining keyword arguments are passed
          directly to the constructor of :class:`memcachio.Client`
         :raise ConfigurationError: when :pypi:`memcachio` is not available
         """
-        parsed = urllib.parse.urlparse(uri)
-        self.hosts = []
-
-        for host, port in (
-            loc.split(":") for loc in parsed.netloc.strip().split(",") if loc.strip()
-        ):
-            self.hosts.append((host, int(port)))
-
-        self._options = options
-        self._storage = None
+        if implementation == "emcache":
+            self.bridge = EmcacheBridge(
+                uri, self.dependencies["emcache"].module, **options
+            )
+        else:
+            self.bridge = MemcachioBridge(
+                uri, self.dependencies["memcachio"].module, **options
+            )
         super().__init__(uri, wrap_exceptions=wrap_exceptions, **options)
-        self.dependency = self.dependencies["memcachio"].module
 
     @property
     def base_exceptions(
         self,
     ) -> type[Exception] | tuple[type[Exception], ...]:  # pragma: no cover
-        return (
-            self.dependency.errors.NoNodeAvailable,
-            self.dependency.errors.MemcachioConnectionError,
-        )
-
-    async def get_storage(self) -> memcachio.Client[bytes]:
-        if not self._storage:
-            self._storage = self.dependency.Client(
-                [(h, p) for h, p in self.hosts],
-                **self._options,
-            )
-        assert self._storage
-        return self._storage
+        return self.bridge.base_exceptions
 
     async def get(self, key: str) -> int:
         """
         :param key: the key to get the counter value for
         """
-        item = (await self.get_many([key])).get(key.encode("utf-8"), None)
-        return item and int(item.value) or 0
-
-    async def get_many(
-        self, keys: Iterable[str]
-    ) -> dict[bytes, memcachio.MemcachedItem[bytes]]:
-        """
-        Return multiple counters at once
-
-        :param keys: the keys to get the counter values for
-        """
-        return await (await self.get_storage()).get(*[k.encode("utf-8") for k in keys])
+        return await self.bridge.get(key)
 
     async def clear(self, key: str) -> None:
         """
         :param key: the key to clear rate limits for
         """
-        await (await self.get_storage()).delete(key.encode("utf-8"))
-
-    async def decr(self, key: str, amount: int = 1, noreply: bool = False) -> int:
-        """
-        decrements the counter for a given rate limit key
-
-        retursn 0 if the key doesn't exist or if noreply is set to True
-
-        :param key: the key to decrement
-        :param amount: the number to decrement by
-        :param noreply: set to True to ignore the memcached response
-        """
-        storage = await self.get_storage()
-        limit_key = key.encode("utf-8")
-        return await storage.decr(limit_key, amount, noreply=noreply) or 0
+        await self.bridge.clear(key)
 
     async def incr(
         self,
@@ -131,60 +101,22 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
         :param amount: the number to increment by
         :param set_expiration_key: if set to False, the expiration time won't be stored but the key will still expire
         """
-        storage = await self.get_storage()
-        limit_key = key.encode("utf-8")
-        expire_key = self._expiration_key(key).encode()
-        if (value := (await storage.incr(limit_key, amount))) is None:
-            storage = await self.get_storage()
-            if await storage.add(limit_key, f"{amount}".encode(), expiry=ceil(expiry)):
-                if set_expiration_key:
-                    await storage.set(
-                        expire_key,
-                        str(expiry + time.time()).encode("utf-8"),
-                        expiry=ceil(expiry),
-                        noreply=False,
-                    )
-                return amount
-            else:
-                storage = await self.get_storage()
-                return await storage.incr(limit_key, amount) or amount
-        return value
+        return await self.bridge.incr(
+            key, expiry, amount, set_expiration_key=set_expiration_key
+        )
 
     async def get_expiry(self, key: str) -> float:
         """
         :param key: the key to get the expiry for
         """
-        storage = await self.get_storage()
-        expiration_key = self._expiration_key(key).encode("utf-8")
-        item = (await storage.get(expiration_key)).get(expiration_key, None)
-
-        return item and float(item.value) or time.time()
-
-    def _expiration_key(self, key: str) -> str:
-        """
-        Return the expiration key for the given counter key.
-
-        Memcached doesn't natively return the expiration time or TTL for a given key,
-        so we implement the expiration time on a separate key.
-        """
-        return key + "/expires"
-
-    async def check(self) -> bool:
-        """
-        Check if storage is healthy by calling the ``get`` command
-        on the key ``limiter-check``
-        """
-        try:
-            storage = await self.get_storage()
-            await storage.get(b"limiter-check")
-
-            return True
-        except:  # noqa
-            return False
+        return await self.bridge.get_expiry(key)
 
     async def reset(self) -> int | None:
         raise NotImplementedError
 
+    async def check(self) -> bool:
+        return await self.bridge.check()
+
     async def acquire_sliding_window_entry(
         self,
         key: str,
@@ -219,10 +151,10 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
                 previous_count * actualised_previous_ttl / expiry + current_count
             )
             if floor(weighted_count) > limit:
-                # Another hit won the race condition: revert the incrementation and refuse this hit
+                # Another hit won the race condition: revert the increment and refuse this hit
                 # Limitation: during high concurrency at the end of the window,
                 # the counter is shifted and cannot be decremented, so less requests than expected are allowed.
-                await self.decr(current_key, amount, noreply=True)
+                await self.bridge.decr(current_key, amount, noreply=True)
                 return False
             return True
 
@@ -238,13 +170,11 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
     async def _get_sliding_window_info(
         self, previous_key: str, current_key: str, expiry: int, now: float
     ) -> tuple[int, float, int, float]:
-        result = await self.get_many([previous_key, current_key])
+        result = await self.bridge.get_many([previous_key, current_key])
 
-        raw_previous_count = result.get(previous_key.encode("utf-8"))
-        raw_current_count = result.get(current_key.encode("utf-8"))
+        previous_count = result.get(previous_key.encode("utf-8"), 0)
+        current_count = result.get(current_key.encode("utf-8"), 0)
 
-        current_count = raw_current_count and int(raw_current_count.value) or 0
-        previous_count = raw_previous_count and int(raw_previous_count.value) or 0
         if previous_count == 0:
             previous_ttl = float(0)
         else:

limits/aio/storage/memcached/bridge.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+import urllib
+from abc import ABC, abstractmethod
+from types import ModuleType
+
+from limits.typing import Iterable
+
+
+class MemcachedBridge(ABC):
+    def __init__(
+        self,
+        uri: str,
+        dependency: ModuleType,
+        **options: float | str | bool,
+    ) -> None:
+        self.uri = uri
+        self.parsed_uri = urllib.parse.urlparse(self.uri)
+        self.dependency = dependency
+        self.hosts = []
+        self.options = options
+
+        sep = self.parsed_uri.netloc.strip().find("@") + 1
+        for loc in self.parsed_uri.netloc.strip()[sep:].split(","):
+            host, port = loc.split(":")
+            self.hosts.append((host, int(port)))
+
+        if self.parsed_uri.username:
+            self.options["username"] = self.parsed_uri.username
+        if self.parsed_uri.password:
+            self.options["password"] = self.parsed_uri.password
+
+    def _expiration_key(self, key: str) -> str:
+        """
+        Return the expiration key for the given counter key.
+
+        Memcached doesn't natively return the expiration time or TTL for a given key,
+        so we implement the expiration time on a separate key.
+        """
+        return key + "/expires"
+
+    @property
+    @abstractmethod
+    def base_exceptions(
+        self,
+    ) -> type[Exception] | tuple[type[Exception], ...]: ...
+
+    @abstractmethod
+    async def get(self, key: str) -> int: ...
+
+    @abstractmethod
+    async def get_many(self, keys: Iterable[str]) -> dict[bytes, int]: ...
+
+    @abstractmethod
+    async def clear(self, key: str) -> None: ...
+
+    @abstractmethod
+    async def decr(self, key: str, amount: int = 1, noreply: bool = False) -> int: ...
+
+    @abstractmethod
+    async def incr(
+        self,
+        key: str,
+        expiry: float,
+        amount: int = 1,
+        set_expiration_key: bool = True,
+    ) -> int: ...
+
+    @abstractmethod
+    async def get_expiry(self, key: str) -> float: ...
+
+    @abstractmethod
+    async def check(self) -> bool: ...

limits/aio/storage/memcached/emcache.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+import time
+from math import ceil
+from types import ModuleType
+
+from limits.typing import TYPE_CHECKING, Iterable
+
+from .bridge import MemcachedBridge
+
+if TYPE_CHECKING:
+    import emcache
+
+
+class EmcacheBridge(MemcachedBridge):
+    def __init__(
+        self,
+        uri: str,
+        dependency: ModuleType,
+        **options: float | str | bool,
+    ) -> None:
+        super().__init__(uri, dependency, **options)
+        self._storage = None
+
+    async def get_storage(self) -> emcache.Client:
+        if not self._storage:
+            self._storage = await self.dependency.create_client(
+                [self.dependency.MemcachedHostAddress(h, p) for h, p in self.hosts],
+                **self.options,
+            )
+        assert self._storage
+        return self._storage
+
+    async def get(self, key: str) -> int:
+        item = await (await self.get_storage()).get(key.encode("utf-8"))
+        return item and int(item.value) or 0
+
+    async def get_many(self, keys: Iterable[str]) -> dict[bytes, int]:
+        results = await (await self.get_storage()).get_many(
+            [k.encode("utf-8") for k in keys]
+        )
+        return {k: int(item.value) if item else 0 for k, item in results.items()}
+
+    async def clear(self, key: str) -> None:
+        try:
+            await (await self.get_storage()).delete(key.encode("utf-8"))
+        except self.dependency.NotFoundCommandError:
+            pass
+
+    async def decr(self, key: str, amount: int = 1, noreply: bool = False) -> int:
+        storage = await self.get_storage()
+        limit_key = key.encode("utf-8")
+        try:
+            value = await storage.decrement(limit_key, amount, noreply=noreply) or 0
+        except self.dependency.NotFoundCommandError:
+            value = 0
+        return value
+
+    async def incr(
+        self, key: str, expiry: float, amount: int = 1, set_expiration_key: bool = True
+    ) -> int:
+        storage = await self.get_storage()
+        limit_key = key.encode("utf-8")
+        expire_key = self._expiration_key(key).encode()
+        try:
+            return await storage.increment(limit_key, amount) or amount
+        except self.dependency.NotFoundCommandError:
+            storage = await self.get_storage()
+            try:
+                await storage.add(limit_key, f"{amount}".encode(), exptime=ceil(expiry))
+                if set_expiration_key:
+                    await storage.set(
+                        expire_key,
+                        str(expiry + time.time()).encode("utf-8"),
+                        exptime=ceil(expiry),
+                        noreply=False,
+                    )
+                value = amount
+            except self.dependency.NotStoredStorageCommandError:
+                # Coult not add the key, probably because a concurrent call has added it
+                storage = await self.get_storage()
+                value = await storage.increment(limit_key, amount) or amount
+            return value
+
+    async def get_expiry(self, key: str) -> float:
+        storage = await self.get_storage()
+        item = await storage.get(self._expiration_key(key).encode("utf-8"))
+
+        return item and float(item.value) or time.time()
+        pass
+
+    @property
+    def base_exceptions(
+        self,
+    ) -> type[Exception] | tuple[type[Exception], ...]:  # pragma: no cover
+        return (
+            self.dependency.ClusterNoAvailableNodes,
+            self.dependency.CommandError,
+        )
+
+    async def check(self) -> bool:
+        """
+        Check if storage is healthy by calling the ``get`` command
+        on the key ``limiter-check``
+        """
+        try:
+            storage = await self.get_storage()
+            await storage.get(b"limiter-check")
+
+            return True
+        except:  # noqa
+            return False

limits/aio/storage/memcached/memcachio.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+import time
+from math import ceil
+from types import ModuleType
+from typing import TYPE_CHECKING, Iterable
+
+from .bridge import MemcachedBridge
+
+if TYPE_CHECKING:
+    import memcachio
+
+
+class MemcachioBridge(MemcachedBridge):
+    def __init__(
+        self,
+        uri: str,
+        dependency: ModuleType,
+        **options: float | str | bool,
+    ) -> None:
+        super().__init__(uri, dependency, **options)
+        self._storage: memcachio.Client[bytes] | None = None
+
+    @property
+    def base_exceptions(
+        self,
+    ) -> type[Exception] | tuple[type[Exception], ...]:
+        return (
+            self.dependency.errors.NoAvailableNodes,
+            self.dependency.errors.MemcachioConnectionError,
+        )
+
+    async def get_storage(self) -> memcachio.Client[bytes]:
+        if not self._storage:
+            self._storage = self.dependency.Client(
+                [(h, p) for h, p in self.hosts],
+                **self.options,
+            )
+        assert self._storage
+        return self._storage
+
+    async def get(self, key: str) -> int:
+        return (await self.get_many([key])).get(key.encode("utf-8"), 0)
+
+    async def get_many(self, keys: Iterable[str]) -> dict[bytes, int]:
+        """
+        Return multiple counters at once
+
+        :param keys: the keys to get the counter values for
+        """
+        results = await (await self.get_storage()).get(
+            *[k.encode("utf-8") for k in keys]
+        )
+        return {k: int(v.value) for k, v in results.items()}
+
+    async def clear(self, key: str) -> None:
+        await (await self.get_storage()).delete(key.encode("utf-8"))
+
+    async def decr(self, key: str, amount: int = 1, noreply: bool = False) -> int:
+        storage = await self.get_storage()
+        limit_key = key.encode("utf-8")
+        return await storage.decr(limit_key, amount, noreply=noreply) or 0
+
+    async def incr(
+        self, key: str, expiry: float, amount: int = 1, set_expiration_key: bool = True
+    ) -> int:
+        storage = await self.get_storage()
+        limit_key = key.encode("utf-8")
+        expire_key = self._expiration_key(key).encode()
+        if (value := (await storage.incr(limit_key, amount))) is None:
+            storage = await self.get_storage()
+            if await storage.add(limit_key, f"{amount}".encode(), expiry=ceil(expiry)):
+                if set_expiration_key:
+                    await storage.set(
+                        expire_key,
+                        str(expiry + time.time()).encode("utf-8"),
+                        expiry=ceil(expiry),
+                        noreply=False,
+                    )
+                return amount
+            else:
+                storage = await self.get_storage()
+                return await storage.incr(limit_key, amount) or amount
+        return value
+
+    async def get_expiry(self, key: str) -> float:
+        storage = await self.get_storage()
+        expiration_key = self._expiration_key(key).encode("utf-8")
+        item = (await storage.get(expiration_key)).get(expiration_key, None)
+
+        return item and float(item.value) or time.time()
+
+    async def check(self) -> bool:
+        """
+        Check if storage is healthy by calling the ``get`` command
+        on the key ``limiter-check``
+        """
+        try:
+            storage = await self.get_storage()
+            await storage.get(b"limiter-check")
+
+            return True
+        except:  # noqa
+            return False

limits/aio/storage/memory.py

@@ -62,25 +62,29 @@ class MemoryStorage(
         asyncio.ensure_future(self.__schedule_expiry())
 
     async def __expire_events(self) -> None:
-        now = time.time()
-        for key in list(self.events.keys()):
-            cutoff = await asyncio.to_thread(
-                lambda evts: bisect.bisect_left(
-                    evts, -now, key=lambda event: -event.expiry
-                ),
-                self.events[key],
-            )
-            async with self.locks[key]:
-                self.events[key] = self.events[key][:cutoff]
-                if not self.events.get(key, None):
-                    self.events.pop(key, None)
+        try:
+            now = time.time()
+            for key in list(self.events.keys()):
+                cutoff = await asyncio.to_thread(
+                    lambda evts: bisect.bisect_left(
+                        evts, -now, key=lambda event: -event.expiry
+                    ),
+                    self.events[key],
+                )
+                async with self.locks[key]:
+                    if self.events.get(key, []):
+                        self.events[key] = self.events[key][:cutoff]
+                    if not self.events.get(key, None):
+                        self.events.pop(key, None)
+                        self.locks.pop(key, None)
+
+            for key in list(self.expirations.keys()):
+                if self.expirations[key] <= time.time():
+                    self.storage.pop(key, None)
+                    self.expirations.pop(key, None)
                     self.locks.pop(key, None)
-
-        for key in list(self.expirations.keys()):
-            if self.expirations[key] <= time.time():
-                self.storage.pop(key, None)
-                self.expirations.pop(key, None)
-                self.locks.pop(key, None)
+        except asyncio.CancelledError:
+            return
 
     async def __schedule_expiry(self) -> None:
         if not self.timer or self.timer.done():
@@ -268,3 +272,10 @@ class MemoryStorage(
         self.locks.clear()
 
         return num_items
+
+    def __del__(self) -> None:
+        try:
+            if self.timer and not self.timer.done():
+                self.timer.cancel()
+        except RuntimeError:  # noqa
+            pass

limits/aio/storage/redis/__init__.py

@@ -51,6 +51,8 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         "valkey": Version("6.0"),
     }
     MODE: Literal["BASIC", "CLUSTER", "SENTINEL"] = "BASIC"
+    PREFIX = "LIMITS"
+
     bridge: RedisBridge
     storage_exceptions: tuple[Exception, ...]
     target_server: Literal["redis", "valkey"]
@@ -60,6 +62,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = PREFIX,
         **options: float | str | bool,
     ) -> None:
         """
@@ -86,6 +89,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
          - ``redispy``: :class:`redis.asyncio.client.Redis`
          - ``valkey``: :class:`valkey.asyncio.client.Valkey`
 
+        :param key_prefix: the prefix for each key created in redis
         :param options: all remaining keyword arguments are passed
          directly to the constructor of :class:`coredis.Redis` or :class:`redis.asyncio.client.Redis`
         :raise ConfigurationError: when the redis library is not available
@@ -97,12 +101,18 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         super().__init__(uri, wrap_exceptions=wrap_exceptions)
         self.options = options
         if self.target_server == "valkey" or implementation == "valkey":
-            self.bridge = ValkeyBridge(uri, self.dependencies["valkey"].module)
+            self.bridge = ValkeyBridge(
+                uri, self.dependencies["valkey"].module, key_prefix
+            )
         else:
             if implementation == "redispy":
-                self.bridge = RedispyBridge(uri, self.dependencies["redis"].module)
+                self.bridge = RedispyBridge(
+                    uri, self.dependencies["redis"].module, key_prefix
+                )
             else:
-                self.bridge = CoredisBridge(uri, self.dependencies["coredis"].module)
+                self.bridge = CoredisBridge(
+                    uri, self.dependencies["coredis"].module, key_prefix
+                )
         self.configure_bridge()
         self.bridge.register_scripts()
 
@@ -226,7 +236,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
     async def reset(self) -> int | None:
         """
         This function calls a Lua Script to delete keys prefixed with
-        ``self.PREFIX`` in blocks of 5000.
+        :paramref:`RedisStorage.key_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
@@ -268,6 +278,7 @@ class RedisClusterStorage(RedisStorage):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = RedisStorage.PREFIX,
         **options: float | str | bool,
     ) -> None:
         """
@@ -283,6 +294,7 @@ class RedisClusterStorage(RedisStorage):
          - ``coredis``: :class:`coredis.RedisCluster`
          - ``redispy``: :class:`redis.asyncio.cluster.RedisCluster`
          - ``valkey``: :class:`valkey.asyncio.cluster.ValkeyCluster`
+        :param key_prefix: the prefix for each key created in redis
         :param options: all remaining keyword arguments are passed
          directly to the constructor of :class:`coredis.RedisCluster` or
          :class:`redis.asyncio.RedisCluster`
@@ -293,6 +305,7 @@ class RedisClusterStorage(RedisStorage):
             uri,
             wrap_exceptions=wrap_exceptions,
             implementation=implementation,
+            key_prefix=key_prefix,
             **options,
         )
 
@@ -303,8 +316,8 @@ class RedisClusterStorage(RedisStorage):
         """
         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.
+        keys that are prefixed with :paramref:`RedisClusterStorage.key_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
@@ -354,6 +367,7 @@ class RedisSentinelStorage(RedisStorage):
         uri: str,
         wrap_exceptions: bool = False,
         implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
+        key_prefix: str = RedisStorage.PREFIX,
         service_name: str | None = None,
         use_replicas: bool = True,
         sentinel_kwargs: dict[str, float | str | bool] | None = None,
@@ -372,6 +386,7 @@ class RedisSentinelStorage(RedisStorage):
          - ``coredis``: :class:`coredis.sentinel.Sentinel`
          - ``redispy``: :class:`redis.asyncio.sentinel.Sentinel`
          - ``valkey``: :class:`valkey.asyncio.sentinel.Sentinel`
+        :param key_prefix: the prefix for each key created in redis
         :param service_name: sentinel service name (if not provided in `uri`)
         :param use_replicas: Whether to use replicas for read only operations
         :param sentinel_kwargs: optional arguments to pass as
@@ -391,6 +406,7 @@ class RedisSentinelStorage(RedisStorage):
             uri,
             wrap_exceptions=wrap_exceptions,
             implementation=implementation,
+            key_prefix=key_prefix,
             **options,
         )
 

limits/aio/storage/redis/bridge.py

@@ -8,7 +8,6 @@ from limits.util import get_package_data
 
 
 class RedisBridge(ABC):
-    PREFIX = "LIMITS"
     RES_DIR = "resources/redis/lua_scripts"
 
     SCRIPT_MOVING_WINDOW = get_package_data(f"{RES_DIR}/moving_window.lua")
@@ -26,18 +25,20 @@ class RedisBridge(ABC):
         self,
         uri: str,
         dependency: ModuleType,
+        key_prefix: str,
     ) -> None:
         self.uri = uri
         self.parsed_uri = urllib.parse.urlparse(self.uri)
         self.dependency = dependency
         self.parsed_auth = {}
+        self.key_prefix = key_prefix
         if self.parsed_uri.username:
             self.parsed_auth["username"] = self.parsed_uri.username
         if self.parsed_uri.password:
             self.parsed_auth["password"] = self.parsed_uri.password
 
     def prefixed_key(self, key: str) -> str:
-        return f"{self.PREFIX}:{key}"
+        return f"{self.key_prefix}:{key}"
 
     @abstractmethod
     def register_scripts(self) -> None: ...

limits/storage/memcached.py

@@ -153,6 +153,8 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
         Return multiple counters at once
 
         :param keys: the keys to get the counter values for
+
+        :meta private:
         """
         return self.storage.get_many(keys)
 

limits/storage/memory.py

@@ -57,11 +57,11 @@ class MemoryStorage(
     def __expire_events(self) -> None:
         for key in list(self.events.keys()):
             with self.locks[key]:
-                events = self.events.get(key, [])
-                oldest = bisect.bisect_left(
-                    events, -time.time(), key=lambda event: -event.expiry
-                )
-                self.events[key] = self.events[key][:oldest]
+                if events := self.events.get(key, []):
+                    oldest = bisect.bisect_left(
+                        events, -time.time(), key=lambda event: -event.expiry
+                    )
+                    self.events[key] = self.events[key][:oldest]
                 if not self.events.get(key, None):
                     self.locks.pop(key, None)
         for key in list(self.expirations.keys()):

limits/storage/redis.py

@@ -68,6 +68,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         self,
         uri: str,
         connection_pool: redis.connection.ConnectionPool | None = None,
+        key_prefix: str = PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -82,6 +83,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
          :pypi:`valkey`.
         :param connection_pool: if provided, the redis client is initialized with
          the connection pool and any other params passed as :paramref:`options`
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -89,6 +91,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         :raise ConfigurationError: when the :pypi:`redis` library is not available
         """
         super().__init__(uri, wrap_exceptions=wrap_exceptions, **options)
+        self.key_prefix = key_prefix
         self.target_server = "valkey" if uri.startswith("valkey") else "redis"
         self.dependency = self.dependencies[self.target_server].module
 
@@ -165,7 +168,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         return f"{self._current_window_key(key)}/-1"
 
     def prefixed_key(self, key: str) -> str:
-        return f"{self.PREFIX}:{key}"
+        return f"{self.key_prefix}:{key}"
 
     def get_moving_window(self, key: str, limit: int, expiry: int) -> tuple[float, int]:
         """
@@ -295,7 +298,7 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
     def reset(self) -> int | None:
         """
         This function calls a Lua Script to delete keys prefixed with
-        ``self.PREFIX`` in blocks of 5000.
+        :paramref:`RedisStorage.key_prefix` in blocks of 5000.
 
         .. warning::
            This operation was designed to be fast, but was not tested

limits/storage/redis_cluster.py

@@ -56,6 +56,7 @@ class RedisClusterStorage(RedisStorage):
     def __init__(
         self,
         uri: str,
+        key_prefix: str = RedisStorage.PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -65,6 +66,7 @@ class RedisClusterStorage(RedisStorage):
 
          If the uri scheme is ``valkey+cluster`` the implementation used will be from
          :pypi:`valkey`.
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -86,6 +88,7 @@ class RedisClusterStorage(RedisStorage):
             host, port = loc.split(":")
             cluster_hosts.append((host, int(port)))
 
+        self.key_prefix = key_prefix
         self.storage = None
         self.target_server = "valkey" if uri.startswith("valkey") else "redis"
         merged_options = {**self.DEFAULT_OPTIONS, **parsed_auth, **options}
@@ -108,8 +111,8 @@ class RedisClusterStorage(RedisStorage):
         """
         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.
+        keys that are prefixed with :paramref:`RedisClusterStorage.prefix` and
+        calls delete on them one at a time.
 
         .. warning::
          This operation was not tested with extremely large data sets.

limits/storage/redis_sentinel.py

@@ -45,6 +45,7 @@ class RedisSentinelStorage(RedisStorage):
         service_name: str | None = None,
         use_replicas: bool = True,
         sentinel_kwargs: dict[str, float | str | bool] | None = None,
+        key_prefix: str = RedisStorage.PREFIX,
         wrap_exceptions: bool = False,
         **options: float | str | bool,
     ) -> None:
@@ -59,6 +60,7 @@ class RedisSentinelStorage(RedisStorage):
         :param use_replicas: Whether to use replicas for read only operations
         :param sentinel_kwargs: kwargs to pass as
          :attr:`sentinel_kwargs` to :class:`redis.sentinel.Sentinel`
+        :param key_prefix: the prefix for each key created in redis
         :param wrap_exceptions: Whether to wrap storage exceptions in
          :exc:`limits.errors.StorageError` before raising it.
         :param options: all remaining keyword arguments are passed
@@ -87,6 +89,7 @@ class RedisSentinelStorage(RedisStorage):
         for loc in parsed.netloc[sep:].split(","):
             host, port = loc.split(":")
             sentinel_configuration.append((host, int(port)))
+        self.key_prefix = key_prefix
         self.service_name = (
             parsed.path.replace("/", "") if parsed.path else service_name
         )

limits/typing.py

@@ -107,6 +107,7 @@ __all__ = [
     "Callable",
     "ClassVar",
     "Counter",
+    "Iterable",
     "Literal",
     "MemcachedClientP",
     "MongoClient",

{limits-5.0.0rc1.dist-info → limits-5.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 5.0.0rc1
+Version: 5.1.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 License-File: LICENSE.txt
 Requires-Dist: deprecated>=1.2
-Requires-Dist: packaging<25,>=21
+Requires-Dist: packaging<26,>=21
 Requires-Dist: typing_extensions
 Provides-Extra: redis
 Requires-Dist: redis!=4.5.2,!=4.5.3,<6.0.0,>3; extra == "redis"
@@ -274,5 +274,6 @@ Links
 =====
 
 * `Documentation <http://limits.readthedocs.org/en/latest>`_
+* `Benchmarks <http://limits.readthedocs.org/en/latest/performance.html>`_
 * `Changelog <http://limits.readthedocs.org/en/stable/changelog.html>`_
 

{limits-5.0.0rc1.dist-info → limits-5.1.0.dist-info}/RECORD

@@ -1,21 +1,24 @@
 limits/__init__.py,sha256=gPUFrt02kHF_syLjiVRSs-S4UVGpRMcM2VMFNhF6G24,748
-limits/_version.py,sha256=kltwWj42pO4gRxnH3YVXMAqHthKTyYt67Uzylwnaayo,500
+limits/_version.py,sha256=lLFEUIKCe-XUvEBxgpwkb-a4zLkFZoXtkgamjxeqlCA,497
 limits/errors.py,sha256=s1el9Vg0ly-z92guvnvYNgKi3_aVqpiw_sufemiLLTI,662
 limits/limits.py,sha256=YzzZP8_ay_zlMMnnY2xhAcFTTFvFe5HEk8NQlvUTru4,4907
 limits/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 limits/strategies.py,sha256=LeZ6lnE73EIQqQ8TfKaTzlxNvBMrZOOSXFB0l8D17fI,9946
-limits/typing.py,sha256=vmutp9AD8XXQ5U48fM7rVaBSoK9fWalkhnK_TGg8xxY,3267
+limits/typing.py,sha256=pVt5D23MhQSUGqi0MBG5FCSqDwta2ygu18BpKvJFxow,3283
 limits/util.py,sha256=nk5QYvezFuXPq1OTEj04RrZFSWIH-khT0e_Dim6zGCw,6002
 limits/version.py,sha256=YwkF3dtq1KGzvmL3iVGctA8NNtGlK_0arrzZkZGVjUs,47
 limits/aio/__init__.py,sha256=yxvWb_ZmV245Hg2LqD365WC5IDllcGDMw6udJ1jNp1g,118
 limits/aio/strategies.py,sha256=RzZExH2r6jnHra4SpDHqtZCC0Bo3085zUJYo2boAj6Y,9897
 limits/aio/storage/__init__.py,sha256=vKeArUnN1ld_0mQOBBZPCjaQgM5xI1GBPM7_F2Ydz5c,646
 limits/aio/storage/base.py,sha256=VfHpL9Z3RL76eKhoaSQKLKQsqcF5B2bnF6gfa-8ltWA,6296
-limits/aio/storage/memcached.py,sha256=q1t9wowCg04-pHavg0i5xEly4KMgVkW5ptyGNA4RiqU,9195
-limits/aio/storage/memory.py,sha256=HdkQPcjjHv1MhGoeYWOkBwwMj5e0tQbaO0OlECzh64A,9178
+limits/aio/storage/memory.py,sha256=sWrDzOe-6Opy9uFmfP1S38IbN2_wNCBaIHTS4UTRy6g,9562
 limits/aio/storage/mongodb.py,sha256=tIMfQrseONRMR2nuRmPO7ocp8dTCABfqBICS_kgp550,19141
-limits/aio/storage/redis/__init__.py,sha256=lwoKk91YLEBlZ3W6hCnQ1e7Gc6LxpvSzZZW16saCyR4,14143
-limits/aio/storage/redis/bridge.py,sha256=eoRi9h2bSy194cVwoKgRYQV1HQ7SvwarL-4LeazrxeA,3145
+limits/aio/storage/memcached/__init__.py,sha256=VMWsH4XpaPswtPV7cQmsfckhVRbOOrKvoUPYnGt5MRY,6611
+limits/aio/storage/memcached/bridge.py,sha256=3CEruS6LvZWDQPGPLlwY4hemy6oN0WWduUE7t8vyXBI,2017
+limits/aio/storage/memcached/emcache.py,sha256=J01jP-Udd2fLgamCh2CX9NEIvhN8eZVTzUok096Bbe4,3833
+limits/aio/storage/memcached/memcachio.py,sha256=OoGVqOVG0pVX2McFeTGQ_AbiqQUu_FYwWItpQMtNV7g,3491
+limits/aio/storage/redis/__init__.py,sha256=dU0FsaDv53kKGpZg-CA_F1VjLEdrxGakSHpfuh1cyYM,14756
+limits/aio/storage/redis/bridge.py,sha256=tz6WGViOqIm81hjGPUOBlz-Qw0tSB71NIttn7Xb5lok,3189
 limits/aio/storage/redis/coredis.py,sha256=IzfEyXBvQbr4QUWML9xAd87a2aHCvglOBEjAg-Vq4z0,7420
 limits/aio/storage/redis/redispy.py,sha256=HS1H6E9g0dP3G-8tSUILIFoc8JWpeRQOiBxcpL3I0gM,8310
 limits/aio/storage/redis/valkey.py,sha256=f_-HPZhzNspywGybMNIL0F5uDZk76v8_K9wuC5ZeKhc,248
@@ -27,15 +30,15 @@ limits/resources/redis/lua_scripts/moving_window.lua,sha256=zlieQwfET0BC7sxpfiOu
 limits/resources/redis/lua_scripts/sliding_window.lua,sha256=qG3Yg30Dq54QpRUcR9AOrKQ5bdJiaYpCacTm6Kxblvc,713
 limits/storage/__init__.py,sha256=9iNxIlwzLQw2d54EcMa2LBJ47wiWCPOnHgn6ddqKkDI,2652
 limits/storage/base.py,sha256=IdOL_iqR9KhaJO73M_h9c6OYe8Ox632pxx5uXaL9Dbo,6860
-limits/storage/memcached.py,sha256=7ZdT80OgQa0f16Tr2L2zGu8PZGzLryOvlb4D1Qk7z9I,10193
-limits/storage/memory.py,sha256=Qc13tGIOFPJ5maehxZdT0074qMvkW-RrzoyZIbFuRyE,8698
+limits/storage/memcached.py,sha256=5GUKGWS_BYTwUss2WmOlCwBtOieGT7AFUcpX65WYXdQ,10217
+limits/storage/memory.py,sha256=rVlsirSp9LDhuqNFp6KMLR85fJc9xwrU58IHIVz6eq4,8719
 limits/storage/mongodb.py,sha256=V4Ib_AwPFX6JpNI7oUUGJx_3MxD8EmYAi4Q6QcWnQ5U,18071
-limits/storage/redis.py,sha256=i_6qh4S6JQd-lG6eRJdTPxNnZIAkm4G0cA0mfow9OOk,10389
-limits/storage/redis_cluster.py,sha256=z6aONMl4p1AY78G3J0BbtK--uztz88krwnpiOsU61BM,4447
-limits/storage/redis_sentinel.py,sha256=AN0WtwHN88TvXk0C2uUE8l5Jhsd1ZxU8XSqrEyQSR20,4327
+limits/storage/redis.py,sha256=GwD1fODE8pZxm403UwEuhbRHG1bprqoxyuFkIp_K5QQ,10552
+limits/storage/redis_cluster.py,sha256=GkL8GCQFfxDriMzsPMkaj6pMEX5FvQXYpUtXLY5q8fQ,4621
+limits/storage/redis_sentinel.py,sha256=OSb61DxgUxMgXSIjaM_pF5-entD8XntD56xt0rFu89k,4479
 limits/storage/registry.py,sha256=CxSaDBGR5aBJPFAIsfX9axCnbcThN3Bu-EH4wHrXtu8,650
-limits-5.0.0rc1.dist-info/licenses/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
-limits-5.0.0rc1.dist-info/METADATA,sha256=iXK14MS_wl5xFrRblJE9Niv54qsuaGhW-_49-vIrSrY,10828
-limits-5.0.0rc1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-limits-5.0.0rc1.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
-limits-5.0.0rc1.dist-info/RECORD,,
+limits-5.1.0.dist-info/licenses/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
+limits-5.1.0.dist-info/METADATA,sha256=Me_Gk0sTOOVK8weSyIufZ1ie9SpIKiEA2bQIMQrwBbo,10900
+limits-5.1.0.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+limits-5.1.0.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
+limits-5.1.0.dist-info/RECORD,,

{limits-5.0.0rc1.dist-info → limits-5.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (79.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any