Thank you for this project

[Glinte]

I hate hate hate the pile of garbage that is slowapi, and with your package I can literally leverage limits to do what slowapi do in 10 lines of code

from fastapi import HTTPException, Request, status
from fastapi_shield import shield
from limits import parse
from limits.aio import storage, strategies


def get_ipaddress(request: Request) -> str:
    """
    Returns the ip address for the current request (or 127.0.0.1 if none found)
     based on the X-Forwarded-For headers.
     Note that a more robust method for determining IP address of the client is
     provided by uvicorn's ProxyHeadersMiddleware.
    """
    if "X_FORWARDED_FOR" in request.headers:
        return request.headers["X_FORWARDED_FOR"]
    else:
        if not request.client or not request.client.host:
            return "127.0.0.1"

        return request.client.host


def rate_limit(limit: str):
    """
    A decorator to apply rate limiting to FastAPI routes.

    Args:
        limit (str): The rate limit string (e.g., "5 per minute").
    """

    limits_storage = storage.MemoryStorage()
    limiter = strategies.FixedWindowRateLimiter(limits_storage)
    limit_item = parse(limit)

    @shield(name="Rate Limit", exception_to_raise_if_fail=HTTPException(status.HTTP_429_TOO_MANY_REQUESTS, detail="Rate limit exceeded"))
    async def _rate_limit_decorator(request: Request) -> bool:
        ip_address = get_ipaddress(request)
        return await limiter.hit(limit_item, ip_address)

    return _rate_limit_decorator

[jymchng]

hi @Glinte

thank you for your very kind remarks and for taking your time to pen this note.

indeed, the reason why i made this library was precisely out of my 'annoyance' with slowapi lol