limits 5.3.0__py3-none-any.whl → 5.4.0__py3-none-any.whl

limits/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-06-13T16:23:24-0700",
+ "date": "2025-06-16T08:51:06-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "311fe101b2d63c03e8c6a8f0ab363dd49f3e733b",
- "version": "5.3.0"
+ "full-revisionid": "8a5a8254708e2799a762b28482d2a4da7b71b04e",
+ "version": "5.4.0"
 }
 '''  # END VERSION_JSON
 

limits/aio/strategies.py

@@ -32,6 +32,8 @@ class RateLimiter(ABC):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
         raise NotImplementedError
 
@@ -44,6 +46,8 @@ class RateLimiter(ABC):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The expected cost to be consumed, default 1
+
+        :return: True if the rate limit is not depleted
         """
         raise NotImplementedError
 
@@ -88,6 +92,8 @@ class MovingWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
 
         return await cast(MovingWindowSupport, self.storage).acquire_entry(
@@ -102,6 +108,8 @@ class MovingWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The expected cost to be consumed, default 1
+
+        :return: True if the rate limit is not depleted
         """
         res = await cast(MovingWindowSupport, self.storage).get_moving_window(
             item.key_for(*identifiers),
@@ -144,6 +152,8 @@ class FixedWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
 
         return (
@@ -163,6 +173,8 @@ class FixedWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify the
          limit
         :param cost: The expected cost to be consumed, default 1
+
+        :return: True if the rate limit is not depleted
         """
 
         return (
@@ -225,6 +237,8 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify this
          instance of the limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
         return await cast(
             SlidingWindowCounterSupport, self.storage
@@ -243,6 +257,8 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
         :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: True if the rate limit is not depleted
         """
 
         previous_count, previous_expires_in, current_count, _ = await cast(

limits/limits.py

@@ -91,7 +91,10 @@ class RateLimitItem(metaclass=RateLimitItemMeta):
 
         """
 
-        return granularity_string.lower() in cls.GRANULARITY.name
+        return granularity_string.lower() in {
+            cls.GRANULARITY.name,
+            f"{cls.GRANULARITY.name}s",  # allow plurals like days, hours etc.
+        }
 
     def get_expiry(self) -> int:
         """

limits/strategies.py

@@ -32,6 +32,8 @@ class RateLimiter(metaclass=ABCMeta):
         :param identifiers: variable list of strings to uniquely identify this
          instance of the limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
         raise NotImplementedError
 
@@ -44,6 +46,8 @@ class RateLimiter(metaclass=ABCMeta):
         :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: True if the rate limit is not depleted
         """
         raise NotImplementedError
 
@@ -86,7 +90,8 @@ class MovingWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify this
          instance of the limit
         :param cost: The cost of this hit, default 1
-        :return: (reset time, remaining)
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
 
         return cast(MovingWindowSupport, self.storage).acquire_entry(
@@ -101,6 +106,8 @@ class MovingWindowRateLimiter(RateLimiter):
         :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: True if the rate limit is not depleted
         """
 
         return (
@@ -142,6 +149,8 @@ class FixedWindowRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify this
          instance of the limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
 
         return (
@@ -161,6 +170,8 @@ class FixedWindowRateLimiter(RateLimiter):
         :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: True if the rate limit is not depleted
         """
 
         return self.storage.get(item.key_for(*identifiers)) < item.amount - cost + 1
@@ -216,6 +227,8 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
         :param identifiers: variable list of strings to uniquely identify this
          instance of the limit
         :param cost: The cost of this hit, default 1
+
+        :return: True if ``cost`` could be deducted from the rate limit without exceeding it
         """
         return cast(
             SlidingWindowCounterSupport, self.storage
@@ -234,6 +247,8 @@ class SlidingWindowCounterRateLimiter(RateLimiter):
         :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: True if the rate limit is not depleted
         """
         previous_count, previous_expires_in, current_count, _ = cast(
             SlidingWindowCounterSupport, self.storage

limits/util.py

@@ -22,8 +22,10 @@ SINGLE_EXPR = re.compile(
     r"""
     \s*([0-9]+)
     \s*(/|\s*per\s*)
-    \s*([0-9]+)
-    *\s*(hour|minute|second|day|month|year)s?\s*""",
+    \s*([0-9]+)?
+    \s*([a-z]+)
+    \s*
+    """,
     re.IGNORECASE | re.VERBOSE,
 )
 EXPR = re.compile(

{limits-5.3.0.dist-info → limits-5.4.0.dist-info}/METADATA

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

{limits-5.3.0.dist-info → limits-5.4.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 limits/__init__.py,sha256=gPUFrt02kHF_syLjiVRSs-S4UVGpRMcM2VMFNhF6G24,748
-limits/_version.py,sha256=zdxTHiQVSU3wNvKwUyOaoK8MMVvzbTzqFicCzdjC7j4,497
+limits/_version.py,sha256=yzZjmmcS6zK5TYwp241WU_2TWLKQak_9QvmKSaY24EY,497
 limits/errors.py,sha256=s1el9Vg0ly-z92guvnvYNgKi3_aVqpiw_sufemiLLTI,662
-limits/limits.py,sha256=YzzZP8_ay_zlMMnnY2xhAcFTTFvFe5HEk8NQlvUTru4,4907
+limits/limits.py,sha256=EztiGCXBVwIqNtps77HiW6vLlMO93wCh7mu5W7BuhwI,5011
 limits/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-limits/strategies.py,sha256=blVIWefjRmDZvD78tneZ9aHUgCGWddyHjJaPuKxP07s,10169
+limits/strategies.py,sha256=Q03NTAyADtwMalhRkOSdk6UE1gVfVt5n258xVyA481o,10732
 limits/typing.py,sha256=pVt5D23MhQSUGqi0MBG5FCSqDwta2ygu18BpKvJFxow,3283
-limits/util.py,sha256=nk5QYvezFuXPq1OTEj04RrZFSWIH-khT0e_Dim6zGCw,6002
+limits/util.py,sha256=283O2aXnN7DmaqjTeTiF-KYn5wVbnpXJ8vb-6LvY5lY,5983
 limits/version.py,sha256=YwkF3dtq1KGzvmL3iVGctA8NNtGlK_0arrzZkZGVjUs,47
 limits/aio/__init__.py,sha256=yxvWb_ZmV245Hg2LqD365WC5IDllcGDMw6udJ1jNp1g,118
-limits/aio/strategies.py,sha256=XSNE0SOSbJDjlodA_8AsL7oBYdfIn3JYh6iuR2z_cyU,10132
+limits/aio/strategies.py,sha256=ip7NJ_6FvEtICr90tesayaXcsqrmpG7VlC3PwxbfiVQ,10736
 limits/aio/storage/__init__.py,sha256=vKeArUnN1ld_0mQOBBZPCjaQgM5xI1GBPM7_F2Ydz5c,646
 limits/aio/storage/base.py,sha256=56UyNz3I3J-4pQecjsaCK4pUC4L3R_9GzDnutdTrfKs,6706
 limits/aio/storage/memory.py,sha256=-U_GWPWmR77Hzi1Oa1_L1WjiAlROTS8PNG8PROAm13c,9842
@@ -37,8 +37,8 @@ limits/storage/redis.py,sha256=zTwxV5qosxGBTrkZmD4UWQdvavDbWpYHXY7H3hXH-Sw,10791
 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.3.0.dist-info/licenses/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
-limits-5.3.0.dist-info/METADATA,sha256=saaz-nkRG9gi-N5HyQ2eFhNjvPe2TrJnScsaZTkowEM,10900
-limits-5.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-limits-5.3.0.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
-limits-5.3.0.dist-info/RECORD,,
+limits-5.4.0.dist-info/licenses/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
+limits-5.4.0.dist-info/METADATA,sha256=TbligMc6UvZHAIo_DOoYF31XmWZx64Hghgh1RULEQb4,10900
+limits-5.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+limits-5.4.0.dist-info/top_level.txt,sha256=C7g5ahldPoU2s6iWTaJayUrbGmPK1d6e9t5Nn0vQ2jM,7
+limits-5.4.0.dist-info/RECORD,,