A rate limiting extension for Starlette and Fastapi
A rate limiting library for Starlette and FastAPI adapted from flask-limiter.
Note: this is alpha quality code still, the API may change, and things may fall apart while you try it.
slowapi is available from pypi so you can install it as usual:
$ pip install slowapi
from starlette.applications import Starlette from slowapi import Limiter, _rate_limit_exceeded_handler limiter = Limiter(key_func=get_remote_address) app = Starlette() app.state.limiter = limiter app.add_exception_handler(RateLimitExceeded, _rate_limit_exceeded_handler) @limiter.limit("5/minute") async def homepage(request: Request): return PlainTextResponse("test") app.add_route("/home", homepage)
The above app will have a route
t1 that will accept up to 5 requests per minute. Requests beyond this limit will be answered with an HTTP 429 error, and the body of the view will not run.
from fastapi import FastAPI from slowapi import Limiter, _rate_limit_exceeded_handler limiter = Limiter(key_func=get_remote_address) app = FastAPI() app.state.limiter = limiter app.add_exception_handler(RateLimitExceeded, _rate_limit_exceeded_handler) @app.get("/home") @limiter.limit("5/minute") async def homepage(request: Request): return PlainTextResponse("test")
This will provide the same result, but with a FastAPI app.
Most feature are coming from (will come from) FlaskLimiter and the underlying limits.
- Single and multiple
limitdecorator on endpoint functions to apply limits
- redis, memcached and memory backends to track your limits (memory as a fallback)
- support for sync and async HTTP endpoints
- Support for shared limits across a set of routes
Limitations and known issues
There is no support for default limits yet (in other words, the only default limit supported is "unlimited")
requestargument must be explicitly passed to your endpoint, or
slowapiwon't be able to hook into it. In other words, write:
@limiter.limit("5/minute") async def myendpoint(request: Request) pass
@limiter.limit("5/minute") async def myendpoint() pass
websocketendpoints are not supported yet.
Developing and contributing
PRs are more than welcome! Please include tests for your changes :)
The package uses poetry to manage dependencies. To setup your dev env:
$ poetry install
To run the tests:
Credits go to flask-limiter of which SlowApi is a (still partial) adaptation to Starlette and FastAPI.
It's also important to mention that the actual rate limiting work is done by limits,
slowapi is just a wrapper around it.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size slowapi-0.1.1-py3-none-any.whl (11.6 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size slowapi-0.1.1.tar.gz (11.8 kB)||File type Source||Python version None||Upload date||Hashes View|