feat: add skip_limiter decorator and update Makefile commands for consistency (#60)

Author: long2ice

Makefile

@@ -20,14 +20,14 @@ deps:
 	@uv sync --all-groups
 
 style: deps
-	ruff format $(checkfiles)
+	@uv run ruff format $(checkfiles)
 
 check: deps
-	ruff check $(checkfiles)
-	ty check $(checkfiles)
+	@uv run ruff check $(checkfiles)
+	@uv run ty check $(checkfiles)
 
 test: deps
-	$(py_warn) pytest
+	@$(py_warn) uv run pytest
 
 build: deps
 	@uv build

examples/main.py

@@ -5,7 +5,7 @@
 from fastapi import Depends, FastAPI, HTTPException, WebSocket
 from starlette.websockets import WebSocketDisconnect
 
-from fastapi_limiter import FastAPILimiter
+from fastapi_limiter import FastAPILimiter, skip_limiter
 from fastapi_limiter.depends import RateLimiter, WebSocketRateLimiter
 
 
@@ -41,6 +41,12 @@ async def multiple():
     return {"msg": "Hello World"}
 
 
+@app.get("/skip", dependencies=[Depends(RateLimiter(times=1, seconds=5))])
+@skip_limiter
+async def skip_route():
+    return {"msg": "This route skips rate limiting"}
+
+
 @app.websocket("/ws")
 async def websocket_endpoint(websocket: WebSocket):
     await websocket.accept()

fastapi_limiter/__init__.py

@@ -7,6 +7,10 @@
 from starlette.status import HTTP_429_TOO_MANY_REQUESTS
 from starlette.websockets import WebSocket
 
+from fastapi_limiter.decorators import skip_limiter
+
+__all__ = ["FastAPILimiter", "skip_limiter"]
+
 
 async def default_identifier(request: Union[Request, WebSocket]):
     forwarded = request.headers.get("X-Forwarded-For")

fastapi_limiter/decorators.py

@@ -0,0 +1,21 @@
+from functools import wraps
+from typing import Callable
+
+
+def skip_limiter(func: Callable) -> Callable:
+    """
+    Decorator to skip rate limiting for a specific route.
+
+    Usage:
+        @app.get("/health")
+        @skip_limiter
+        async def health():
+            return {"status": "ok"}
+    """
+
+    @wraps(func)
+    async def wrapper(*args, **kwargs):
+        return await func(*args, **kwargs)
+
+    wrapper._skip_limiter = True
+    return wrapper

fastapi_limiter/depends.py

@@ -47,6 +47,9 @@ async def __call__(self, request: Request, response: Response):
         for i, route in enumerate(request.app.routes):
             if route.path == request.scope["path"] and hasattr(route, "methods") and request.method in route.methods:
                 route_index = i
+                # Check if the route endpoint has _skip_limiter attribute
+                if hasattr(route, "endpoint") and getattr(route.endpoint, "_skip_limiter", False):
+                    return
                 for j, dependency in enumerate(route.dependencies):
                     if self is dependency.dependency:
                         dep_index = j

tests/test_skip.py

@@ -0,0 +1,11 @@
+from starlette.testclient import TestClient
+
+from examples.main import app
+
+
+def test_skip_limiter():
+    with TestClient(app) as client:
+        # Even with RateLimiter(times=1), skip_limiter allows unlimited requests
+        for _ in range(5):
+            response = client.get("/skip")
+            assert response.status_code == 200