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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
|
from __future__ import annotations
from deprecated.sphinx import versionadded, versionchanged
from packaging.version import Version
from limits.aio.storage import MovingWindowSupport, SlidingWindowCounterSupport, Storage
from limits.aio.storage.redis.bridge import RedisBridge
from limits.aio.storage.redis.coredis import CoredisBridge
from limits.aio.storage.redis.redispy import RedispyBridge
from limits.aio.storage.redis.valkey import ValkeyBridge
from limits.typing import Literal
@versionadded(version="2.1")
@versionchanged(
version="4.2",
reason=(
"Added support for using the asyncio redis client from :pypi:`redis`"
" through :paramref:`implementation`"
),
)
@versionchanged(
version="4.3",
reason=(
"Added support for using the asyncio redis client from :pypi:`valkey`"
" through :paramref:`implementation` or if :paramref:`uri` has the"
" ``async+valkey`` schema"
),
)
class RedisStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
"""
Rate limit storage with redis as backend.
Depends on :pypi:`coredis` or :pypi:`redis`
"""
STORAGE_SCHEME = [
"async+redis",
"async+rediss",
"async+redis+unix",
"async+valkey",
"async+valkeys",
"async+valkey+unix",
]
"""
The storage schemes for redis to be used in an async context
"""
DEPENDENCIES = {
"redis": Version("5.2.0"),
"coredis": Version("3.4.0"),
"valkey": Version("6.0"),
}
MODE: Literal["BASIC", "CLUSTER", "SENTINEL"] = "BASIC"
bridge: RedisBridge
storage_exceptions: tuple[Exception, ...]
target_server: Literal["redis", "valkey"]
def __init__(
self,
uri: str,
wrap_exceptions: bool = False,
implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
**options: float | str | bool,
) -> None:
"""
:param uri: uri of the form:
- ``async+redis://[:password]@host:port``
- ``async+redis://[:password]@host:port/db``
- ``async+rediss://[:password]@host:port``
- ``async+redis+unix:///path/to/sock?db=0`` etc...
This uri is passed directly to :meth:`coredis.Redis.from_url` or
:meth:`redis.asyncio.client.Redis.from_url` with the initial ``async`` removed,
except for the case of ``async+redis+unix`` where it is replaced with ``unix``.
If the uri scheme is ``async+valkey`` the implementation used will be from
:pypi:`valkey`.
:param connection_pool: if provided, the redis client is initialized with
the connection pool and any other params passed as :paramref:`options`
:param wrap_exceptions: Whether to wrap storage exceptions in
:exc:`limits.errors.StorageError` before raising it.
:param implementation: Whether to use the client implementation from
- ``coredis``: :class:`coredis.Redis`
- ``redispy``: :class:`redis.asyncio.client.Redis`
- ``valkey``: :class:`valkey.asyncio.client.Valkey`
:param options: all remaining keyword arguments are passed
directly to the constructor of :class:`coredis.Redis` or :class:`redis.asyncio.client.Redis`
:raise ConfigurationError: when the redis library is not available
"""
uri = uri.removeprefix("async+")
self.target_server = "redis" if uri.startswith("redis") else "valkey"
uri = uri.replace(f"{self.target_server}+unix", "unix")
super().__init__(uri, wrap_exceptions=wrap_exceptions)
self.options = options
if self.target_server == "valkey" or implementation == "valkey":
self.bridge = ValkeyBridge(uri, self.dependencies["valkey"].module)
else:
if implementation == "redispy":
self.bridge = RedispyBridge(uri, self.dependencies["redis"].module)
else:
self.bridge = CoredisBridge(uri, self.dependencies["coredis"].module)
self.configure_bridge()
self.bridge.register_scripts()
def _current_window_key(self, key: str) -> str:
"""
Return the current window's storage key (Sliding window strategy)
Contrary to other strategies that have one key per rate limit item,
this strategy has two keys per rate limit item than must be on the same machine.
To keep the current key and the previous key on the same Redis cluster node,
curly braces are added.
Eg: "{constructed_key}"
"""
return f"{{{key}}}"
def _previous_window_key(self, key: str) -> str:
"""
Return the previous window's storage key (Sliding window strategy).
Curvy braces are added on the common pattern with the current window's key,
so the current and the previous key are stored on the same Redis cluster node.
Eg: "{constructed_key}/-1"
"""
return f"{self._current_window_key(key)}/-1"
def configure_bridge(self) -> None:
self.bridge.use_basic(**self.options)
@property
def base_exceptions(
self,
) -> type[Exception] | tuple[type[Exception], ...]: # pragma: no cover
return self.bridge.base_exceptions
async def incr(
self, key: str, expiry: int, elastic_expiry: bool = False, amount: int = 1
) -> int:
"""
increments the counter for a given rate limit key
:param key: the key to increment
:param expiry: amount in seconds for the key to expire in
:param amount: the number to increment by
"""
return await self.bridge.incr(key, expiry, elastic_expiry, amount)
async def get(self, key: str) -> int:
"""
:param key: the key to get the counter value for
"""
return await self.bridge.get(key)
async def clear(self, key: str) -> None:
"""
:param key: the key to clear rate limits for
"""
return await self.bridge.clear(key)
async def acquire_entry(
self, key: str, limit: int, expiry: int, amount: int = 1
) -> bool:
"""
:param key: rate limit key to acquire an entry in
:param limit: amount of entries allowed
:param expiry: expiry of the entry
:param amount: the number of entries to acquire
"""
return await self.bridge.acquire_entry(key, limit, expiry, amount)
async def get_moving_window(
self, key: str, limit: int, expiry: int
) -> tuple[float, int]:
"""
returns the starting point and the number of entries in the moving
window
:param key: rate limit key
:param expiry: expiry of entry
:return: (previous count, previous TTL, current count, current TTL)
"""
return await self.bridge.get_moving_window(key, limit, expiry)
async def acquire_sliding_window_entry(
self,
key: str,
limit: int,
expiry: int,
amount: int = 1,
) -> bool:
current_key = self._current_window_key(key)
previous_key = self._previous_window_key(key)
return await self.bridge.acquire_sliding_window_entry(
previous_key, current_key, limit, expiry, amount
)
async def get_sliding_window(
self, key: str, expiry: int
) -> tuple[int, float, int, float]:
previous_key = self._previous_window_key(key)
current_key = self._current_window_key(key)
return await self.bridge.get_sliding_window(previous_key, current_key, expiry)
async def get_expiry(self, key: str) -> float:
"""
:param key: the key to get the expiry for
"""
return await self.bridge.get_expiry(key)
async def check(self) -> bool:
"""
Check if storage is healthy by calling ``PING``
"""
return await self.bridge.check()
async def reset(self) -> int | None:
"""
This function calls a Lua Script to delete keys prefixed with
``self.PREFIX`` in blocks of 5000.
.. warning:: This operation was designed to be fast, but was not tested
on a large production based system. Be careful with its usage as it
could be slow on very large data sets.
"""
return await self.bridge.lua_reset()
@versionadded(version="2.1")
@versionchanged(
version="4.2",
reason="Added support for using the asyncio redis client from :pypi:`redis` ",
)
@versionchanged(
version="4.3",
reason=(
"Added support for using the asyncio redis client from :pypi:`valkey`"
" through :paramref:`implementation` or if :paramref:`uri` has the"
" ``async+valkey+cluster`` schema"
),
)
class RedisClusterStorage(RedisStorage):
"""
Rate limit storage with redis cluster as backend
Depends on :pypi:`coredis` or :pypi:`redis`
"""
STORAGE_SCHEME = ["async+redis+cluster", "async+valkey+cluster"]
"""
The storage schemes for redis cluster to be used in an async context
"""
MODE = "CLUSTER"
def __init__(
self,
uri: str,
wrap_exceptions: bool = False,
implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
**options: float | str | bool,
) -> None:
"""
:param uri: url of the form
``async+redis+cluster://[:password]@host:port,host:port``
If the uri scheme is ``async+valkey+cluster`` the implementation used will be from
:pypi:`valkey`.
:param wrap_exceptions: Whether to wrap storage exceptions in
:exc:`limits.errors.StorageError` before raising it.
:param implementation: Whether to use the client implementation from
- ``coredis``: :class:`coredis.RedisCluster`
- ``redispy``: :class:`redis.asyncio.cluster.RedisCluster`
- ``valkey``: :class:`valkey.asyncio.cluster.ValkeyCluster`
:param options: all remaining keyword arguments are passed
directly to the constructor of :class:`coredis.RedisCluster` or
:class:`redis.asyncio.RedisCluster`
:raise ConfigurationError: when the redis library is not
available or if the redis host cannot be pinged.
"""
super().__init__(
uri,
wrap_exceptions=wrap_exceptions,
implementation=implementation,
**options,
)
def configure_bridge(self) -> None:
self.bridge.use_cluster(**self.options)
async def reset(self) -> int | None:
"""
Redis Clusters are sharded and deleting across shards
can't be done atomically. Because of this, this reset loops over all
keys that are prefixed with ``self.PREFIX`` and calls delete on them,
one at a time.
.. warning:: This operation was not tested with extremely large data sets.
On a large production based system, care should be taken with its
usage as it could be slow on very large data sets
"""
return await self.bridge.reset()
@versionadded(version="2.1")
@versionchanged(
version="4.2",
reason="Added support for using the asyncio redis client from :pypi:`redis` ",
)
@versionchanged(
version="4.3",
reason=(
"Added support for using the asyncio redis client from :pypi:`valkey`"
" through :paramref:`implementation` or if :paramref:`uri` has the"
" ``async+valkey+sentinel`` schema"
),
)
class RedisSentinelStorage(RedisStorage):
"""
Rate limit storage with redis sentinel as backend
Depends on :pypi:`coredis` or :pypi:`redis`
"""
STORAGE_SCHEME = [
"async+redis+sentinel",
"async+valkey+sentinel",
]
"""The storage scheme for redis accessed via a redis sentinel installation"""
MODE = "SENTINEL"
DEPENDENCIES = {
"redis": Version("5.2.0"),
"coredis": Version("3.4.0"),
"coredis.sentinel": Version("3.4.0"),
"valkey": Version("6.0"),
}
def __init__(
self,
uri: str,
wrap_exceptions: bool = False,
implementation: Literal["redispy", "coredis", "valkey"] = "coredis",
service_name: str | None = None,
use_replicas: bool = True,
sentinel_kwargs: dict[str, float | str | bool] | None = None,
**options: float | str | bool,
):
"""
:param uri: url of the form
``async+redis+sentinel://host:port,host:port/service_name``
If the uri schema is ``async+valkey+sentinel`` the implementation used will be from
:pypi:`valkey`.
:param wrap_exceptions: Whether to wrap storage exceptions in
:exc:`limits.errors.StorageError` before raising it.
:param implementation: Whether to use the client implementation from
- ``coredis``: :class:`coredis.sentinel.Sentinel`
- ``redispy``: :class:`redis.asyncio.sentinel.Sentinel`
- ``valkey``: :class:`valkey.asyncio.sentinel.Sentinel`
:param service_name: sentinel service name (if not provided in `uri`)
:param use_replicas: Whether to use replicas for read only operations
:param sentinel_kwargs: optional arguments to pass as
`sentinel_kwargs`` to :class:`coredis.sentinel.Sentinel` or
:class:`redis.asyncio.Sentinel`
:param options: all remaining keyword arguments are passed
directly to the constructor of :class:`coredis.sentinel.Sentinel` or
:class:`redis.asyncio.sentinel.Sentinel`
:raise ConfigurationError: when the redis library is not available
or if the redis primary host cannot be pinged.
"""
self.service_name = service_name
self.use_replicas = use_replicas
self.sentinel_kwargs = sentinel_kwargs
super().__init__(
uri,
wrap_exceptions=wrap_exceptions,
implementation=implementation,
**options,
)
def configure_bridge(self) -> None:
self.bridge.use_sentinel(
self.service_name, self.use_replicas, self.sentinel_kwargs, **self.options
)
|