A simple ratelimiter for aiohttp.web
Project description
aiohttp-ratelimiter
aiohttp-ratelimiter is a high performance rate limiter for the aiohttp.web framework. It allows you to ratellimit per endpoint and globally.
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 ratelimiting.
# 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 kwargs. 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 ratelimiting 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)
If you want to limit the total ammount of requests you can receive per second use the total_limit kwarg.
limiter = Limiter(keyfunc=default_keyfunc, total_limit=1024)
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.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65c43e36d081f837850270e4e34ad11dc9ece30a351b3a0218efa0ba4bdd39bf |
|
MD5 | a4dba84d8af45780b7ab54b522b2d166 |
|
BLAKE2b-256 | f4f6d9eefcb63c619f0d2af60c119943cfffba07854d4441fb9a7bfab2a067b2 |