/usr/lib/python3/dist-packages/limits/strategies.py is in python3-limits 1.2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | """
rate limiting strategies
"""
from abc import ABCMeta, abstractmethod
import weakref
import six
import time
@six.add_metaclass(ABCMeta)
class RateLimiter(object):
def __init__(self, storage):
self.storage = weakref.ref(storage)
@abstractmethod
def hit(self, item, *identifiers):
"""
creates a hit on the rate limit and returns True if successful.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
raise NotImplementedError
@abstractmethod
def test(self, item, *identifiers):
"""
checks the rate limit and returns True if it is not
currently exceeded.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
raise NotImplementedError
@abstractmethod
def get_window_stats(self, item, *identifiers):
"""
returns the number of requests remaining and reset of this limit.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: tuple (reset time (int), remaining (int))
"""
raise NotImplementedError
class MovingWindowRateLimiter(RateLimiter):
"""
Reference: :ref:`moving-window`
"""
def __init__(self, storage):
if not (hasattr(storage, "acquire_entry") or hasattr(storage, "get_moving_window")):
raise NotImplementedError("MovingWindowRateLimiting is not implemented for storage of type %s" % storage.__class__)
super(MovingWindowRateLimiter, self).__init__(storage)
def hit(self, item, *identifiers):
"""
creates a hit on the rate limit and returns True if successful.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
return self.storage().acquire_entry(
item.key_for(*identifiers), item.amount,
item.get_expiry()
)
def test(self, item, *identifiers):
"""
checks the rate limit and returns True if it is not
currently exceeded.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
return self.storage().get_moving_window(
item.key_for(*identifiers),
item.amount, item.get_expiry(),
)[1] < item.amount
def get_window_stats(self, item, *identifiers):
"""
returns the number of requests remaining within this limit.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: tuple (reset time (int), remaining (int))
"""
window_start, window_items = self.storage().get_moving_window(
item.key_for(*identifiers), item.amount, item.get_expiry()
)
reset = window_start + item.get_expiry()
return (reset, item.amount - window_items)
class FixedWindowRateLimiter(RateLimiter):
"""
Reference: :ref:`fixed-window`
"""
def hit(self, item, *identifiers):
"""
creates a hit on the rate limit and returns True if successful.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
return (
self.storage().incr(item.key_for(*identifiers), item.get_expiry())
<= item.amount
)
def test(self, item, *identifiers):
"""
checks the rate limit and returns True if it is not
currently exceeded.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
return self.storage().get(item.key_for(*identifiers)) < item.amount
def get_window_stats(self, item, *identifiers):
"""
returns the number of requests remaining and reset of this limit.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: tuple (reset time (int), remaining (int))
"""
remaining = max(0, item.amount - self.storage().get(item.key_for(*identifiers)))
reset = self.storage().get_expiry(item.key_for(*identifiers))
return (reset, remaining)
class FixedWindowElasticExpiryRateLimiter(FixedWindowRateLimiter):
"""
Reference: :ref:`fixed-window-elastic`
"""
def hit(self, item, *identifiers):
"""
creates a hit on the rate limit and returns True if successful.
:param item: a :class:`RateLimitItem` instance
:param identifiers: variable list of strings to uniquely identify the
limit
:return: True/False
"""
return (
self.storage().incr(item.key_for(*identifiers), item.get_expiry(), True)
<= item.amount
)
STRATEGIES = {
"fixed-window": FixedWindowRateLimiter,
"fixed-window-elastic-expiry": FixedWindowElasticExpiryRateLimiter,
"moving-window": MovingWindowRateLimiter
}
|