A simple ratelimiter for aiohttp.web
Project description
aiohttp-ratelimiter
aiohttp-ratelimiter is a rate limiter for the aiohttp.web framework.
Install from git
python -m pip install git+https://github.com/Nebulizer1213/aiohttp-ratelimiter
Install from pypi
python -m pip install aiohttp-ratelimiter
Example
from aiohttp import web
from aiohttplimiter import default_keyfunc, Limiter
app = web.Application()
routes = web.RouteTableDef()
limiter = Limiter(keyfunc=default_keyfunc)
@routes.get("/")
# This endpoint can only be requested 1 time per second per IP address
@limiter.limit("1/1")
async def home(request):
return web.Response(text="test")
app.add_routes(routes)
web.run_app(app)
You can exempt an IP from ratelimiting using the exempt_ips kwarg.
from aiohttplimiter import Limiter, default_keyfunc
from aiohttp import web
app = web.Application()
routes = web.RouteTableDef()
# 192.168.1.245 is exempt from rate limiting.
# Keep in mind that exempt_ips takes a set not a list.
limiter = Limiter(keyfunc=default_keyfunc, exempt_ips={"192.168.1.245"})
@routes.get("/")
@limiter.limit("1/1")
async def test(request):
return web.Response(text="test")
app.add_routes(routes)
web.run_app(app)
You can limit how much memory aiohttp-ratelimiter can use to store ratelimiting info with the max_memory kwarg. This kwarg limits the max amount of gigabytes aiohttp-ratelimiter can use to store ratelimiting info. The default is None, which means aiohttp-ratelimiter can use as much as it can before throwing a MemoryError.
from aiohttp import web
from aiohttplimiter import default_keyfunc, Limiter
app = web.Application()
routes = web.RouteTableDef()
# aiohttp-ratelimiter can only store 0.5 gigabytes of rate limiting data.
# When the limit is reached the data resets.
# Please note that the number is not exact. It might be a little over 0.5.
limiter = Limiter(keyfunc=default_keyfunc, max_memory=.5)
@routes.get("/")
@limiter.limit("1/1")
def home(request):
return web.Response(text="test")
app.add_routes(routes)
web.run_app(app)
If you have any middlewares, just specify the amount in the middleware_count kwarg.
limiter = Limiter(keyfunc=default_keyfunc, exempt_ips={"192.168.1.235"}, middleware_count=1)
You can create your own error handler by using the error_handler kwarg.
from aiohttplimiter import Allow, RateLimitExceeded, Limiter, default_keyfunc
from aiohttp import web
def handler(request: web.Request, exc: RateLimitExceeded):
# If for some reason you want to allow the request, return aiohttplimiter.Allow().
if some_condition:
return Allow()
return web.Response(text="Too many requests" status=429)
limiter = Limiter(keyfunc=default_keyfunc, error_handler=handler)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for aiohttp-ratelimiter-3.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51f5ea910e2d61e28877d1df76f4439b7d17416e5a9e12bae5a29a495318d8a0 |
|
MD5 | 62b1de11f2822af15e495f0bae773bfe |
|
BLAKE2b-256 | 7fe3deaf12fa64e12b49639853ec1923085e4a60b68dc5a02b4b487238f11787 |