limits 3.11.0__py3-none-any.whl → 3.13.0__py3-none-any.whl

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/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/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/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/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/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/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.dist-info → limits-3.13.0.dist-info}/METADATA

@@ -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.dist-info → limits-3.13.0.dist-info}/RECORD

@@ -1,16 +1,16 @@
 limits/__init__.py,sha256=j_yVhgN9pdz8o5rQjVwdJTBSq8F-CTzof9kkiYgjRbw,728
-limits/_version.py,sha256=Z21cgsnzdsN25H07XvnYYsi604fLfYVJ8JH9oJPPRzg,498
+limits/_version.py,sha256=WegVz4YKhtYN102E8QvX81l0oVnN2UGchIOm2eVCePg,498
 limits/errors.py,sha256=xCKGOVJiD-g8FlsQQb17AW2pTUvalYSuizPpvEVoYJE,626
 limits/limits.py,sha256=ZsXESq2e1ji7c2ZKjSkIAasCjiLdjVLPUa9oah_I8U4,4943
 limits/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-limits/strategies.py,sha256=7pr2V34KdOEfxnYOf882Cl2qKY-KK6HwKjdYo_IsD4c,6690
-limits/typing.py,sha256=nZjoMCwQBoRKiyJJvpM0pY3ZA8UgL3A5HFN8rwJrmi8,2910
+limits/strategies.py,sha256=Zy6PIhkysPbxnMzFjyXEsxMM6jhRoQ5XT5WskTNruK0,6949
+limits/typing.py,sha256=nwJLek44QIg3869AbOSvPwotfp6JR7vEHz_UgZBiqgg,3287
 limits/util.py,sha256=xMRR5bKksYcnzY0H0xORDGvRFF5btiBognY2sSd38NE,5743
 limits/version.py,sha256=YwkF3dtq1KGzvmL3iVGctA8NNtGlK_0arrzZkZGVjUs,47
 limits/aio/__init__.py,sha256=IOetunwQy1c5GefzitK8lewbTzHGiE-kmE9NlqSdr3U,82
-limits/aio/strategies.py,sha256=REaQ-lqgqkN5wrFZ26AZ3sCHO8oZBL_mWhI6nMRaBz8,6485
+limits/aio/strategies.py,sha256=SHjmJnmy7Nh4tBydkA-0qPaULYcLOAM91T4RPybq0Sg,6768
 limits/aio/storage/__init__.py,sha256=CbtuSlVl1jPyN_vsEI_ApWblDblVaL46xcZ2M_oM0V8,595
-limits/aio/storage/base.py,sha256=dSM39OguwdLdBIHaz98eWljHzxUfgcatweNSeo9d8OQ,4795
+limits/aio/storage/base.py,sha256=xdYpBBonyMjxE9iT-2oZjm6x29aDU6Xd09MeBYbZcMo,4817
 limits/aio/storage/etcd.py,sha256=Rjb_EYKFRr4F2Z6zvAPP9vQOyXJQHaju3VjxxUs75_c,4791
 limits/aio/storage/memcached.py,sha256=6aTlACfCtchdcZqoisnei0MOlCH7yLV9A1yCjOE5f9g,4802
 limits/aio/storage/memory.py,sha256=DlmWluqUwBUWQIQ6XZi-mPrb15vfzBhA4iAKhBELDnE,5856
@@ -20,18 +20,18 @@ limits/resources/redis/lua_scripts/acquire_moving_window.lua,sha256=5CFJX7D6T6RG
 limits/resources/redis/lua_scripts/clear_keys.lua,sha256=zU0cVfLGmapRQF9x9u0GclapM_IB2pJLszNzVQ1QRK4,184
 limits/resources/redis/lua_scripts/incr_expire.lua,sha256=Uq9NcrrcDI-F87TDAJexoSJn2SDgeXIUEYozCp9S3oA,195
 limits/resources/redis/lua_scripts/moving_window.lua,sha256=iAInenlVd_fFDi15APpRWbOuPUz_G3nFnVAqb7wOedA,398
-limits/storage/__init__.py,sha256=8i1-SoTEV_XGAMYDepcLra7do-Tx4rUPbPrUQVVJgTw,2518
+limits/storage/__init__.py,sha256=XAW1jVDMLFkPr_Tl1SXpg_p4Y3nhEatTSYq1MlnYJcA,2564
 limits/storage/base.py,sha256=fDdYLa-RrnjhBTO1hE5aTTM8q8n3M5HD-65KyWWXBtg,4627
 limits/storage/etcd.py,sha256=wkC_mj4Tsf2nwUKByMiHiGzA40N3mDepEwdLmvH8wmw,4484
 limits/storage/memcached.py,sha256=bMzfZgYa_EWcZAjSZLcygpk3hpeOAErBpRE8dVwyXQs,6640
 limits/storage/memory.py,sha256=R16E-Ccnmn1-LlolkFf-kB1-QHh8eiwFFLYVv0PuFD0,5561
-limits/storage/mongodb.py,sha256=2YT0HFuQlAJHfES96nAT9c8nUsJp1WTxglTwgjdZ8DY,8288
+limits/storage/mongodb.py,sha256=QWd_SW--P86SMPDrDrBQS-2xKbWY3cw9x71KsI506zY,9213
 limits/storage/redis.py,sha256=3zJ1gDMDepT_pGN9d2aAN7Pea7tMBI49VK60IHv-Ooc,8452
 limits/storage/redis_cluster.py,sha256=KwhWV0v3_TliRyS3OU15IlpeC8gRQr29U4FkcME01fo,5380
 limits/storage/redis_sentinel.py,sha256=7PVB0hBl0I_enhN_h9QSJTE7zGuYtjkebotTqxm2iZo,3875
 limits/storage/registry.py,sha256=xcBcxuu6srqmoS4WqDpkCXnRLB19ctH98v21P8S9kS8,708
-limits-3.11.0.dist-info/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
-limits-3.11.0.dist-info/METADATA,sha256=du5FUXrCT9NJbjfuQZ7LrCbsgjIBKCvn0AjRf1M6ovI,7170
-limits-3.11.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-limits-3.11.0.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
-limits-3.11.0.dist-info/RECORD,,
+limits-3.13.0.dist-info/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
+limits-3.13.0.dist-info/METADATA,sha256=vQsvBw6YR-jK6cCIusRrIjc-UG-aSL4PoHqFfYKzvjE,7170
+limits-3.13.0.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
+limits-3.13.0.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
+limits-3.13.0.dist-info/RECORD,,

{limits-3.11.0.dist-info → limits-3.13.0.dist-info}/WHEEL

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