limits 3.3.1__tar.gz → 3.5.0__tar.gz

{limits-3.3.1 → limits-3.5.0}/HISTORY.rst

@@ -3,6 +3,30 @@
 Changelog
 =========
 
+v3.5.0
+------
+Release Date: 2023-05-16
+
+* Bug Fix
+
+  * Handle ``cost`` > 8000 when using redis
+  * Remove arbitrary default timeout for redis+sentinel
+
+v3.4.0
+------
+Release Date: 2023-04-17
+
+* Bug Fix
+
+  * Remove use of weakreferences to storages in strategy
+    classes as this was not documented or required and
+    led to usability issues.
+
+* Chores
+
+  * Update documentation dependencies
+  * Remove unused gcra lua script
+
 v3.3.1
 ------
 Release Date: 2023-03-22
@@ -582,6 +606,8 @@ Release Date: 2015-01-08
 
 
 
+
+
 
 
 

{limits-3.3.1 → limits-3.5.0}/PKG-INFO

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

{limits-3.3.1 → limits-3.5.0}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2023-03-22T15:09:18-0700",
+ "date": "2023-05-16T15:04:57-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "6ddfa53a1f4aff34642e487607fa071b673a40ef",
- "version": "3.3.1"
+ "full-revisionid": "d61ade38645d742e4614dd1c1c0283d6ace40bf0",
+ "version": "3.5.0"
 }
 '''  # END VERSION_JSON
 

{limits-3.3.1 → limits-3.5.0}/limits/aio/storage/redis.py

@@ -349,11 +349,6 @@ class RedisSentinelStorage(RedisStorage):
     STORAGE_SCHEME = ["async+redis+sentinel"]
     """The storage scheme for redis accessed via a redis sentinel installation"""
 
-    DEFAULT_OPTIONS: Dict[str, Union[float, str, bool]] = {
-        "stream_timeout": 0.2,
-    }
-    "Default options passed to :class:`~coredis.sentinel.Sentinel`"
-
     DEPENDENCIES = {"coredis.sentinel": Version("3.4.0")}
 
     def __init__(
@@ -402,8 +397,6 @@ class RedisSentinelStorage(RedisStorage):
         if self.service_name is None:
             raise ConfigurationError("'service_name' not provided")
 
-        connection_options.setdefault("stream_timeout", 0.2)
-
         super(RedisStorage, self).__init__()
 
         self.dependency = self.dependencies["coredis.sentinel"].module

{limits-3.3.1 → limits-3.5.0}/limits/aio/strategies.py

@@ -2,7 +2,6 @@
 Asynchronous rate limiting strategies
 """
 
-import weakref
 from abc import ABC, abstractmethod
 from typing import cast
 
@@ -15,7 +14,7 @@ from .storage import MovingWindowSupport, Storage
 class RateLimiter(ABC):
     def __init__(self, storage: StorageTypes):
         assert isinstance(storage, Storage)
-        self.storage: Storage = weakref.proxy(storage)
+        self.storage: Storage = storage
 
     @abstractmethod
     async def hit(self, item: RateLimitItem, *identifiers: str, cost: int = 1) -> bool:

{limits-3.3.1 → limits-3.5.0}/limits/resources/redis/lua_scripts/acquire_moving_window.lua

@@ -9,15 +9,14 @@ end
 
 local entry = redis.call('lindex', KEYS[1], limit - amount)
 
-
 if entry and tonumber(entry) >= timestamp - expiry then
     return false
 end
-local entries= {}
-for i=1, amount do
-    entries[i] = timestamp
+
+for i = 1, amount do
+    redis.call('lpush', KEYS[1], timestamp)
 end
-redis.call('lpush', KEYS[1], unpack(entries))
+
 redis.call('ltrim', KEYS[1], 0, limit - 1)
 redis.call('expire', KEYS[1], expiry)
 

{limits-3.3.1 → limits-3.5.0}/limits/storage/memory.py

@@ -7,7 +7,7 @@ from limits.storage.base import MovingWindowSupport, Storage
 from limits.typing import Dict, List, Optional, Tuple
 
 
-class LockableEntry(threading._RLock):
+class LockableEntry(threading._RLock):  # type: ignore
     def __init__(self, expiry: float) -> None:
         self.atime = time.time()
         self.expiry = self.atime + expiry

{limits-3.3.1 → limits-3.5.0}/limits/storage/redis_sentinel.py

@@ -21,11 +21,6 @@ class RedisSentinelStorage(RedisStorage):
     STORAGE_SCHEME = ["redis+sentinel"]
     """The storage scheme for redis accessed via a redis sentinel installation"""
 
-    DEFAULT_OPTIONS: Dict[str, Union[float, str, bool]] = {
-        "socket_timeout": 0.2,
-    }
-    "Default options passed to :class:`~redis.sentinel.Sentinel`"
-
     DEPENDENCIES = {"redis.sentinel": Version("3.0")}
 
     def __init__(
@@ -79,7 +74,7 @@ class RedisSentinelStorage(RedisStorage):
         self.sentinel: "redis.sentinel.Sentinel" = sentinel_dep.Sentinel(
             sentinel_configuration,
             sentinel_kwargs={**parsed_auth, **sentinel_options},
-            **{**self.DEFAULT_OPTIONS, **parsed_auth, **options}
+            **{**parsed_auth, **options}
         )
         self.storage = self.sentinel.master_for(self.service_name)
         self.storage_slave = self.sentinel.slave_for(self.service_name)

{limits-3.3.1 → limits-3.5.0}/limits/strategies.py

@@ -2,7 +2,6 @@
 Rate limiting strategies
 """
 
-import weakref
 from abc import ABCMeta, abstractmethod
 from typing import Dict, Type, Union, cast
 
@@ -14,7 +13,7 @@ from .util import WindowStats
 class RateLimiter(metaclass=ABCMeta):
     def __init__(self, storage: StorageTypes):
         assert isinstance(storage, Storage)
-        self.storage: Storage = weakref.proxy(storage)
+        self.storage: Storage = storage
 
     @abstractmethod
     def hit(self, item: RateLimitItem, *identifiers: str, cost: int = 1) -> bool:

{limits-3.3.1 → limits-3.5.0}/limits.egg-info/PKG-INFO

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

{limits-3.3.1 → limits-3.5.0}/limits.egg-info/SOURCES.txt

@@ -47,7 +47,6 @@ limits/aio/storage/mongodb.py
 limits/aio/storage/redis.py
 limits/resources/redis/lua_scripts/acquire_moving_window.lua
 limits/resources/redis/lua_scripts/clear_keys.lua
-limits/resources/redis/lua_scripts/gcra_consume.lua
 limits/resources/redis/lua_scripts/incr_expire.lua
 limits/resources/redis/lua_scripts/moving_window.lua
 limits/storage/__init__.py

{limits-3.3.1 → limits-3.5.0}/requirements/docs.txt

@@ -1,10 +1,10 @@
 -r main.txt
-furo==2022.12.7
+furo==2023.3.27
 Sphinx>=5
-sphinx-copybutton==0.5.1
+sphinx-copybutton==0.5.2
 sphinx-autobuild==2021.3.14
-sphinxext-opengraph==0.8.1
-sphinx-inline-tabs==2022.1.2b11
+sphinxext-opengraph==0.8.2
+sphinx-inline-tabs==2023.4.21
 sphinx-paramlinks==0.5.4
 sphinxcontrib-programoutput==0.17
 

{limits-3.3.1 → limits-3.5.0}/tests/test_strategy.py

@@ -134,6 +134,16 @@ class TestWindow:
         limiter.clear(five_per_min)
         assert limiter.hit(five_per_min)
 
+    @moving_window_storage
+    def test_moving_window_huge_cost_sync(self, uri, args, fixture):
+        storage = storage_from_string(uri, **args)
+        limiter = MovingWindowRateLimiter(storage)
+        many_per_min = RateLimitItemPerMinute(1_000_000)
+        limiter.hit(many_per_min, cost=1_000_000)
+        assert not limiter.hit(many_per_min, cost=2)
+        limiter.clear(many_per_min)
+        assert limiter.hit(many_per_min)
+
     @pytest.mark.memcached
     def test_moving_window_memcached(self, memcached):
         storage = MemcachedStorage("memcached://localhost:22122")

limits-3.3.1/limits/resources/redis/lua_scripts/gcra_consume.lua

@@ -1,50 +0,0 @@
-local rate_limit_key = KEYS[1]
-local burst          = ARGV[1]
-local rate           = ARGV[2]
-local period         = ARGV[3]
-local cost           = ARGV[4]
-
-local emission_interval = period / rate
-local increment         = emission_interval * cost
-local burst_offset      = emission_interval * burst
-
-local tat = redis.call("GET", rate_limit_key)
-
-local time = redis.call("TIME")
-local now = tonumber(time[1]) + tonumber(time[2])/1000000.0
-
-if not tat then
-  tat = now
-else
-  tat = tonumber(tat)
-end
-
-tat = math.max(tat, now)
-
-local new_tat = tat + increment
-local allow_at = new_tat - burst_offset
-local diff = now - allow_at
-
-local consumed = 0
-local retry_in = 0
-local reset_in
-
-local remaining = math.floor(diff / emission_interval) -- poor man's round
-if remaining < 0 then
-  consumed = 0
-  remaining = math.floor((now - (tat - burst_offset)) / emission_interval)
-  reset_in = math.ceil(tat - now)
-  retry_in = math.ceil(diff * -1)
-elseif remaining == 0 and increment <= 0 then
-  consumed = 1
-  remaining = 0
-  reset_in = math.ceil(tat - now)
-else
-  consumed = 1
-  reset_in = math.ceil(new_tat - now)
-  if increment > 0 then
-    redis.call("SET", rate_limit_key, new_tat, "PX", reset_in)
-  end
-end
-
-return {consumed, remaining, retry_in, reset_in}