limits 5.1.0__tar.gz → 5.2.0__tar.gz

{limits-5.1.0 → limits-5.2.0}/HISTORY.rst

@@ -3,6 +3,17 @@
 Changelog
 =========
 
+v5.2.0
+------
+Release Date: 2025-05-16
+
+* Bug Fix
+
+  * Fix incorrect behavior of the ``clear`` method for sliding window
+    counter which effectively did not clear the sliding window for
+    redis, memcached & in memory storage implementations.
+    `Issue 276 <https://github.com/alisaifee/limits/issues/276>`_
+
 v5.1.0
 ------
 Release Date: 2025-04-23
@@ -836,3 +847,4 @@ Release Date: 2015-01-08
 
 
 
+

{limits-5.1.0 → limits-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 5.1.0
+Version: 5.2.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee

{limits-5.1.0 → limits-5.2.0}/doc/source/theme_config.py

@@ -29,7 +29,6 @@ colors = {
     "redis": "#D82C20",
     "mongodb": "#00ED64",
     "memcached": "",
-
 }
 
 html_theme = "furo"

{limits-5.1.0 → limits-5.2.0}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-04-23T10:35:38-0700",
+ "date": "2025-05-16T12:15:52-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "2b76ea0a8aa2a37b2069ab5990e9ae180de6491f",
- "version": "5.1.0"
+ "full-revisionid": "0c8d73757f54788d5fa213a678dfbdf3fdd7ccfb",
+ "version": "5.2.0"
 }
 '''  # END VERSION_JSON
 

{limits-5.1.0 → limits-5.2.0}/limits/aio/storage/base.py

@@ -175,7 +175,11 @@ class SlidingWindowCounterSupport(ABC):
     """
 
     def __init_subclass__(cls, **kwargs: Any) -> None:  # type: ignore[explicit-any]
-        for method in {"acquire_sliding_window_entry", "get_sliding_window"}:
+        for method in {
+            "acquire_sliding_window_entry",
+            "get_sliding_window",
+            "clear_sliding_window",
+        }:
             setattr(
                 cls,
                 method,
@@ -218,3 +222,13 @@ class SlidingWindowCounterSupport(ABC):
           - current window TTL
         """
         raise NotImplementedError
+
+    @abstractmethod
+    async def clear_sliding_window(self, key: str, expiry: int) -> None:
+        """
+        Resets the rate limit key(s) for the sliding window
+
+        :param key: the key to clear rate limits for
+        :param expiry: the rate limit expiry, needed to compute the key in some implemenations
+        """
+        ...

{limits-5.1.0 → limits-5.2.0}/limits/aio/storage/memcached/__init__.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 import time
 from math import floor
 
@@ -167,6 +168,11 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
             previous_key, current_key, expiry, now
         )
 
+    async def clear_sliding_window(self, key: str, expiry: int) -> None:
+        now = time.time()
+        previous_key, current_key = self.sliding_window_keys(key, expiry, now)
+        await asyncio.gather(self.clear(previous_key), self.clear(current_key))
+
     async def _get_sliding_window_info(
         self, previous_key: str, current_key: str, expiry: int, now: float
     ) -> tuple[int, float, int, float]:

{limits-5.1.0 → limits-5.2.0}/limits/aio/storage/memory.py

@@ -241,6 +241,12 @@ class MemoryStorage(
             previous_key, current_key, expiry, now
         )
 
+    async def clear_sliding_window(self, key: str, expiry: int) -> None:
+        now = time.time()
+        previous_key, current_key = self.sliding_window_keys(key, expiry, now)
+        await self.clear(current_key)
+        await self.clear(previous_key)
+
     async def _get_sliding_window_info(
         self,
         previous_key: str,

{limits-5.1.0 → limits-5.2.0}/limits/aio/storage/mongodb.py

@@ -513,5 +513,8 @@ class MongoDBStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
             )
         return 0, 0.0, 0, 0.0
 
+    async def clear_sliding_window(self, key: str, expiry: int) -> None:
+        return await self.clear(key)
+
     def __del__(self) -> None:
         self.storage and self.storage.close()

{limits-5.1.0 → limits-5.2.0}/limits/aio/storage/redis/__init__.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import asyncio
+
 from deprecated.sphinx import versionadded, versionchanged
 from packaging.version import Version
 
@@ -219,6 +221,11 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
         current_key = self._current_window_key(key)
         return await self.bridge.get_sliding_window(previous_key, current_key, expiry)
 
+    async def clear_sliding_window(self, key: str, expiry: int) -> None:
+        previous_key = self._previous_window_key(key)
+        current_key = self._current_window_key(key)
+        await asyncio.gather(self.clear(previous_key), self.clear(current_key))
+
     async def get_expiry(self, key: str) -> float:
         """
         :param key: the key to get the expiry for

{limits-5.1.0 → limits-5.2.0}/limits/aio/strategies.py

@@ -302,6 +302,11 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
 
         return WindowStats(now + min(previous_reset_in, current_reset_in), remaining)
 
+    async def clear(self, item: RateLimitItem, *identifiers: str) -> None:
+        return await cast(
+            SlidingWindowCounterSupport, self.storage
+        ).clear_sliding_window(item.key_for(*identifiers), item.get_expiry())
+
 
 STRATEGIES = {
     "sliding-window-counter": SlidingWindowCounterRateLimiter,

{limits-5.1.0 → limits-5.2.0}/limits/storage/base.py

@@ -167,7 +167,11 @@ class SlidingWindowCounterSupport(ABC):
     """
 
     def __init_subclass__(cls, **kwargs: Any) -> None:  # type: ignore[explicit-any]
-        for method in {"acquire_sliding_window_entry", "get_sliding_window"}:
+        for method in {
+            "acquire_sliding_window_entry",
+            "get_sliding_window",
+            "clear_sliding_window",
+        }:
             setattr(
                 cls,
                 method,
@@ -207,6 +211,16 @@ class SlidingWindowCounterSupport(ABC):
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def clear_sliding_window(self, key: str, expiry: int) -> None:
+        """
+        Resets the rate limit key(s) for the sliding window
+
+        :param key: the key to clear rate limits for
+        :param expiry: the rate limit expiry, needed to compute the key in some implemenations
+        """
+        ...
+
 
 class TimestampedSlidingWindow:
     """Helper class for storage that support the sliding window counter, with timestamp based keys."""

{limits-5.1.0 → limits-5.2.0}/limits/storage/memcached.py

@@ -282,6 +282,12 @@ class MemcachedStorage(Storage, SlidingWindowCounterSupport, TimestampedSlidingW
         previous_key, current_key = self.sliding_window_keys(key, expiry, now)
         return self._get_sliding_window_info(previous_key, current_key, expiry, now)
 
+    def clear_sliding_window(self, key: str, expiry: int) -> None:
+        now = time.time()
+        previous_key, current_key = self.sliding_window_keys(key, expiry, now)
+        self.clear(previous_key)
+        self.clear(current_key)
+
     def _get_sliding_window_info(
         self, previous_key: str, current_key: str, expiry: int, now: float
     ) -> tuple[int, float, int, float]:

{limits-5.1.0 → limits-5.2.0}/limits/storage/memory.py

@@ -237,6 +237,12 @@ class MemoryStorage(
         previous_key, current_key = self.sliding_window_keys(key, expiry, now)
         return self._get_sliding_window_info(previous_key, current_key, expiry, now)
 
+    def clear_sliding_window(self, key: str, expiry: int) -> None:
+        now = time.time()
+        previous_key, current_key = self.sliding_window_keys(key, expiry, now)
+        self.clear(previous_key)
+        self.clear(current_key)
+
     def check(self) -> bool:
         """
         check if storage is healthy

{limits-5.1.0 → limits-5.2.0}/limits/storage/mongodb.py

@@ -470,6 +470,9 @@ class MongoDBStorageBase(
         )
         return cast(bool, result["_acquired"])
 
+    def clear_sliding_window(self, key: str, expiry: int) -> None:
+        return self.clear(key)
+
     def __del__(self) -> None:
         if self.storage:
             self.storage.close()

{limits-5.1.0 → limits-5.2.0}/limits/storage/redis.py

@@ -200,6 +200,12 @@ class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
             )
         return 0, 0.0, 0, 0.0
 
+    def clear_sliding_window(self, key: str, expiry: int) -> None:
+        previous_key = self._previous_window_key(key)
+        current_key = self._current_window_key(key)
+        self.clear(previous_key)
+        self.clear(current_key)
+
     def incr(
         self,
         key: str,

{limits-5.1.0 → limits-5.2.0}/limits/strategies.py

@@ -284,6 +284,11 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
 
         return WindowStats(now + min(previous_reset_in, current_reset_in), remaining)
 
+    def clear(self, item: RateLimitItem, *identifiers: str) -> None:
+        return cast(SlidingWindowCounterSupport, self.storage).clear_sliding_window(
+            item.key_for(*identifiers), item.get_expiry()
+        )
+
 
 KnownStrategy = (
     type[SlidingWindowCounterRateLimiter]

{limits-5.1.0 → limits-5.2.0}/limits.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: limits
-Version: 5.1.0
+Version: 5.2.0
 Summary: Rate limiting utilities
 Home-page: https://limits.readthedocs.org
 Author: Ali-Akber Saifee

{limits-5.1.0 → limits-5.2.0}/tests/test_storage.py

@@ -136,6 +136,9 @@ class TestBaseStorage:
             ) -> tuple[int, float, int, float]:
                 pass
 
+            def clear_sliding_window(self, key: str, expiry: int) -> None:
+                pass
+
         storage = storage_from_string("mystorage+sliding://")
         assert isinstance(storage, MyStorage)
         SlidingWindowCounterRateLimiter(storage)
@@ -370,6 +373,9 @@ class TestStorageErrors:
         ) -> tuple[int, float, int, float]:
             raise self.MyError()
 
+        def clear_sliding_window(self, key: str, expiry: int) -> None:
+            raise self.MyError()
+
     def assert_exception(self, exc, wrap_exceptions):
         if wrap_exceptions:
             assert isinstance(exc, StorageError)
@@ -436,3 +442,9 @@ class TestStorageErrors:
         with pytest.raises(Exception) as exc:
             self.MyStorage(wrap_exceptions=wrap_exceptions).get_sliding_window("", 1)
         self.assert_exception(exc.value, wrap_exceptions)
+
+    def test_clear_sliding_window_exception(self, wrap_exceptions):
+        with pytest.raises(Exception) as exc:
+            self.MyStorage(wrap_exceptions=wrap_exceptions).clear_sliding_window("", 1)
+
+        self.assert_exception(exc.value, wrap_exceptions)

{limits-5.1.0 → limits-5.2.0}/tests/test_strategy.py

@@ -108,6 +108,9 @@ class TestSlidingWindow:
                 start + 2, 1e-2
             )
 
+        limiter.clear(limit)
+        assert 10 == limiter.get_window_stats(limit).remaining
+
     @pytest.mark.flaky
     def test_sliding_window_counter_total_reset(self, uri, args, fixture):
         storage = storage_from_string(uri, **args)