limits 3.11.0__tar.gz → 3.13.0__tar.gz

{limits-3.11.0 → limits-3.13.0}/HISTORY.rst

@@ -3,6 +3,32 @@
 Changelog
 =========
 
+v3.13.0
+-------
+Release Date: 2024-06-22
+
+* Feature
+
+  * Add ``cost`` parameter to ``test`` methods in strategies.
+
+v3.12.0
+-------
+Release Date: 2024-05-12
+
+* Enhancements
+
+  * Lazily initialize pymongo client
+
+* Documentation
+
+  * Add django-ratelimiter in docs
+
+* Chores
+
+  * Update development dependencies
+  * Update github actions to latest
+
+
 v3.11.0
 -------
 Release Date: 2024-04-20
@@ -687,6 +713,8 @@ Release Date: 2015-01-08
 
 
 
+
+
 
 
 

{limits-3.11.0 → limits-3.13.0}/PKG-INFO

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

{limits-3.11.0 → limits-3.13.0}/doc/source/index.rst

@@ -81,6 +81,7 @@ Projects using *limits*
    - `djlimiter <http://djlimiter.readthedocs.org>`_: Rate limiting middleware for Django applications.
    - `sanic-limiter <https://github.com/bohea/sanic-limiter>`_: Rate limiting middleware for Sanic applications.
    - `Falcon-Limiter <https://falcon-limiter.readthedocs.org>`_ : Rate limiting extension for Falcon applications.
+   - `django-ratelimiter <https://andriykohut.github.io/django-ratelimiter/>`_: Rate limiting decorator and middleware for Django applications.
 
 References
 ==========

{limits-3.11.0 → limits-3.13.0}/limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-04-20T13:09:37-0700",
+ "date": "2024-06-22T18:39:54-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "0a1a9c70cbffe4c51a5f34500fe4edfe342de638",
- "version": "3.11.0"
+ "full-revisionid": "7b87c4d37659ae5fe0a8bf7216bfff789facd5f3",
+ "version": "3.13.0"
 }
 '''  # END VERSION_JSON
 

{limits-3.11.0 → limits-3.13.0}/limits/aio/storage/base.py

@@ -27,7 +27,7 @@ def _wrap_errors(
     fn: Callable[P, Awaitable[R]],
 ) -> Callable[P, Awaitable[R]]:
     @functools.wraps(fn)
-    async def inner(*args: P.args, **kwargs: P.kwargs) -> R:
+    async def inner(*args: P.args, **kwargs: P.kwargs) -> R:  # type: ignore[misc]
         try:
             return await fn(*args, **kwargs)
         except storage.base_exceptions as exc:

{limits-3.11.0 → limits-3.13.0}/limits/aio/strategies.py

@@ -29,13 +29,14 @@ class RateLimiter(ABC):
         raise NotImplementedError
 
     @abstractmethod
-    async def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    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 the
          limit
+        :param cost: The expected cost to be consumed, default 1
         """
         raise NotImplementedError
 
@@ -86,13 +87,14 @@ class MovingWindowRateLimiter(RateLimiter):
             item.key_for(*identifiers), item.amount, item.get_expiry(), amount=cost
         )
 
-    async def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    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 the
          limit
+        :param cost: The expected cost to be consumed, default 1
         """
         res = await cast(MovingWindowSupport, self.storage).get_moving_window(
             item.key_for(*identifiers),
@@ -101,7 +103,7 @@ class MovingWindowRateLimiter(RateLimiter):
         )
         amount = res[1]
 
-        return amount < item.amount
+        return amount <= item.amount - cost
 
     async def get_window_stats(
         self, item: RateLimitItem, *identifiers: str
@@ -147,16 +149,19 @@ class FixedWindowRateLimiter(RateLimiter):
             <= item.amount
         )
 
-    async def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    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 the
          limit
+        :param cost: The expected cost to be consumed, default 1
         """
 
-        return await self.storage.get(item.key_for(*identifiers)) < item.amount
+        return (
+            await self.storage.get(item.key_for(*identifiers)) < item.amount - cost + 1
+        )
 
     async def get_window_stats(
         self, item: RateLimitItem, *identifiers: str

{limits-3.11.0 → limits-3.13.0}/limits/storage/__init__.py

@@ -13,7 +13,7 @@ from .base import MovingWindowSupport, Storage
 from .etcd import EtcdStorage
 from .memcached import MemcachedStorage
 from .memory import MemoryStorage
-from .mongodb import MongoDBStorage
+from .mongodb import MongoDBStorage, MongoDBStorageBase
 from .redis import RedisStorage
 from .redis_cluster import RedisClusterStorage
 from .redis_sentinel import RedisSentinelStorage
@@ -68,6 +68,7 @@ __all__ = [
     "Storage",
     "MovingWindowSupport",
     "EtcdStorage",
+    "MongoDBStorageBase",
     "MemoryStorage",
     "MongoDBStorage",
     "RedisStorage",

{limits-3.11.0 → limits-3.13.0}/limits/storage/mongodb.py

@@ -3,29 +3,33 @@ from __future__ import annotations
 import calendar
 import datetime
 import time
-from typing import TYPE_CHECKING, Any
+from abc import ABC, abstractmethod
+from typing import Any, cast
 
 from deprecated.sphinx import versionadded
 
-from limits.typing import Dict, Optional, Tuple, Type, Union
+from limits.typing import (
+    Dict,
+    MongoClient,
+    MongoCollection,
+    MongoDatabase,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 
 from ..util import get_dependency
 from .base import MovingWindowSupport, Storage
 
-if TYPE_CHECKING:
-    import pymongo
 
-
-@versionadded(version="2.1")
-class MongoDBStorage(Storage, MovingWindowSupport):
+class MongoDBStorageBase(Storage, MovingWindowSupport, ABC):
     """
     Rate limit storage with MongoDB as backend.
 
     Depends on :pypi:`pymongo`.
     """
 
-    STORAGE_SCHEME = ["mongodb", "mongodb+srv"]
-
     DEPENDENCIES = ["pymongo"]
 
     def __init__(
@@ -48,16 +52,39 @@ class MongoDBStorage(Storage, MovingWindowSupport):
         """
 
         super().__init__(uri, wrap_exceptions=wrap_exceptions, **options)
-
+        self._database_name = database_name
         self.lib = self.dependencies["pymongo"].module
         self.lib_errors, _ = get_dependency("pymongo.errors")
+        self._storage_uri = uri
+        self._storage_options = options
+        self._storage: Optional[MongoClient] = None
 
-        self.storage: "pymongo.MongoClient" = self.lib.MongoClient(  # type: ignore[type-arg]
-            uri, **options
-        )
-        self.counters = self.storage.get_database(database_name).counters
-        self.windows = self.storage.get_database(database_name).windows
-        self.__initialize_database()
+    @property
+    def storage(self) -> MongoClient:
+        if self._storage is None:
+            self._storage = self._init_mongo_client(
+                self._storage_uri, **self._storage_options
+            )
+            self.__initialize_database()
+        return self._storage
+
+    @property
+    def _database(self) -> MongoDatabase:
+        return self.storage[self._database_name]
+
+    @property
+    def counters(self) -> MongoCollection:
+        return self._database["counters"]
+
+    @property
+    def windows(self) -> MongoCollection:
+        return self._database["windows"]
+
+    @abstractmethod
+    def _init_mongo_client(
+        self, uri: Optional[str], **options: Union[int, str, bool]
+    ) -> MongoClient:
+        raise NotImplementedError()
 
     @property
     def base_exceptions(
@@ -248,3 +275,13 @@ class MongoDBStorage(Storage, MovingWindowSupport):
             return True
         except self.lib.errors.DuplicateKeyError:
             return False
+
+
+@versionadded(version="2.1")
+class MongoDBStorage(MongoDBStorageBase):
+    STORAGE_SCHEME = ["mongodb", "mongodb+srv"]
+
+    def _init_mongo_client(
+        self, uri: Optional[str], **options: Union[int, str, bool]
+    ) -> MongoClient:
+        return cast(MongoClient, self.lib.MongoClient(uri, **options))

{limits-3.11.0 → limits-3.13.0}/limits/strategies.py

@@ -28,13 +28,14 @@ class RateLimiter(metaclass=ABCMeta):
         raise NotImplementedError
 
     @abstractmethod
-    def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    def test(self, item: RateLimitItem, *identifiers: str, cost: int = 1) -> bool:
         """
         Check the rate limit without consuming from it.
 
         :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
         """
         raise NotImplementedError
 
@@ -84,13 +85,14 @@ class MovingWindowRateLimiter(RateLimiter):
             item.key_for(*identifiers), item.amount, item.get_expiry(), amount=cost
         )
 
-    def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    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
         """
 
         return (
@@ -99,7 +101,7 @@ class MovingWindowRateLimiter(RateLimiter):
                 item.amount,
                 item.get_expiry(),
             )[1]
-            < item.amount
+            <= item.amount - cost
         )
 
     def get_window_stats(self, item: RateLimitItem, *identifiers: str) -> WindowStats:
@@ -144,16 +146,17 @@ class FixedWindowRateLimiter(RateLimiter):
             <= item.amount
         )
 
-    def test(self, item: RateLimitItem, *identifiers: str) -> bool:
+    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
         """
 
-        return self.storage.get(item.key_for(*identifiers)) < item.amount
+        return self.storage.get(item.key_for(*identifiers)) < item.amount - cost + 1
 
     def get_window_stats(self, item: RateLimitItem, *identifiers: str) -> WindowStats:
         """

{limits-3.11.0 → limits-3.13.0}/limits/typing.py

@@ -1,5 +1,6 @@
 from typing import (
     TYPE_CHECKING,
+    Any,
     Awaitable,
     Callable,
     Dict,
@@ -12,7 +13,7 @@ from typing import (
     Union,
 )
 
-from typing_extensions import ClassVar, Counter, ParamSpec, Protocol
+from typing_extensions import ClassVar, Counter, ParamSpec, Protocol, TypeAlias
 
 Serializable = Union[int, str, float]
 
@@ -24,6 +25,7 @@ P = ParamSpec("P")
 if TYPE_CHECKING:
     import coredis
     import coredis.commands.script
+    import pymongo
     import redis
 
 
@@ -107,6 +109,10 @@ class ScriptP(Protocol[R_co]):
     def __call__(self, keys: List[Serializable], args: List[Serializable]) -> R_co: ...
 
 
+MongoClient: TypeAlias = "pymongo.MongoClient[Dict[str, Any]]"  # type:ignore[misc]
+MongoDatabase: TypeAlias = "pymongo.database.Database[Dict[str, Any]]"  # type:ignore[misc]
+MongoCollection: TypeAlias = "pymongo.collection.Collection[Dict[str, Any]]"  # type:ignore[misc]
+
 __all__ = [
     "AsyncRedisClient",
     "Awaitable",
@@ -118,6 +124,9 @@ __all__ = [
     "ItemP",
     "List",
     "MemcachedClientP",
+    "MongoClient",
+    "MongoCollection",
+    "MongoDatabase",
     "NamedTuple",
     "Optional",
     "P",

{limits-3.11.0 → limits-3.13.0}/limits.egg-info/PKG-INFO

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

{limits-3.11.0 → limits-3.13.0}/requirements/docs.txt

@@ -1,5 +1,5 @@
 -r main.txt
-furo==2024.1.29
+furo==2024.5.6
 Sphinx>=4,<8
 sphinx-copybutton==0.5.2
 sphinx-autobuild==2021.3.14

{limits-3.11.0 → limits-3.13.0}/requirements/test.txt

@@ -18,7 +18,7 @@ hiro>0.1.6
 flaky
 lovely-pytest-docker
 pytest<8
-pytest-asyncio==0.21.1
+pytest-asyncio==0.21.2
 pytest-benchmark[histogram]
 pytest-cov
 pytest-lazy-fixture

{limits-3.11.0 → limits-3.13.0}/tests/test_strategy.py

@@ -48,6 +48,7 @@ class TestWindow:
         assert not limiter.hit(limit, "k1", cost=11)
         assert limiter.hit(limit, "k2", cost=5)
         assert limiter.get_window_stats(limit, "k2").remaining == 5
+        assert not limiter.test(limit, "k2", cost=6)
         assert not limiter.hit(limit, "k2", cost=6)
 
     @all_storage
@@ -130,9 +131,10 @@ class TestWindow:
             limiter.hit(limit, "k2", cost=5)
         # 5 hits in the last 100ms
         with window(2, delay=1.8):
-            assert all(limiter.hit(limit, "k2") for i in range(5))
-            # 11th fails
-            assert not limiter.hit(limit, "k2")
+            assert all(limiter.hit(limit, "k2") for i in range(4))
+            assert not limiter.test(limit, "k2", cost=2)
+            assert not limiter.hit(limit, "k2", cost=2)
+            assert limiter.hit(limit, "k2")
 
         # 5 more succeed since there were only 5 in the last 2 seconds
         assert all([limiter.hit(limit, "k2") for i in range(5)])