Flask HTTP Middleware with starlette's (FastAPI) BaseHTTPMiddleware style
Project description
FastAPI Simple CRUD Generator
Repository
Installation
pip install flask-http-middleware
Description
Flask HTTP Middleware with starlette's (FastAPI) BaseHTTPMiddleware style. Manage your middleware directly from request
to response
easily
Changelogs
- v0.0
- First Upload
How to use ?
Example: adding a response header
import time
from flask import Flask
from flask_http_middleware import MiddlewareManager, BaseHTTPMiddleware
app = Flask(__name__)
class MetricsMiddleware(BaseHTTPMiddleware):
def __init__(self):
super().__init__(self)
def dispatch(self, request, call_next):
t0 = time.time()
response = call_next(request)
response_time = time.time()-t0
response.headers.add("response_time", response_time)
return response
app.wsgi_app = MiddlewareManager(app)
app.wsgi_app.add_middleware(MetricsMiddleware)
@app.get("/health")
async def health():
return {"message":"I'm healthy"}
if __name__ == "__main__":
app.run()
- Note: you can put your
MetricsMiddleware
class in different file
Above example is equals with app.before_request
and app.after_request
decorated function.
@app.before_request
def start_metrics():
g.t0 = time.time()
@app.after_request
def stop_metrics(response):
response_time = time.time()-g.t0
response.headers.add("response_time", response_time)
return response
Example: Authentication
import time
from flask import Flask, jsonify
from flask_http_middleware import MiddlewareManager, BaseHTTPMiddleware
app = Flask(__name__)
class AccessMiddleware(BaseHTTPMiddleware):
def __init__(self):
super().__init__(self)
def dispatch(self, request, call_next):
if request.headers.get("token") == "secret":
return call_next(request)
else:
return jsonify({"message":"invalid token"})
app.wsgi_app = MiddlewareManager(app)
app.wsgi_app.add_middleware(AccessMiddleware)
@app.get("/health")
async def health():
return {"message":"I'm healthy"}
if __name__ == "__main__":
app.run()
Example: add some routers security
import time
from flask import Flask, jsonify
from flask_http_middleware import MiddlewareManager, BaseHTTPMiddleware
app = Flask(__name__)
class SecureRoutersMiddleware(BaseHTTPMiddleware):
def __init__(self, secured_routers = []):
super().__init__(self)
self.secured_routers = secured_routers
def dispatch(self, request, call_next):
if request.path in self.secured_routers:
if request.headers.get("token") == "secret":
return call_next(request)
else:
return jsonify({"message":"invalid token"})
else:
return call_next(request)
secured_routers = ["/check_secured"]
app.wsgi_app = MiddlewareManager(app)
app.wsgi_app.add_middleware(SecureRoutersMiddleware, secured_routers=secured_routers)
@app.get("/health")
async def health():
return {"message":"I'm healthy"}
@app.get("/check_secured")
async def health():
return {"message":"Security bypassed"}
if __name__ == "__main__":
app.run()
Example: add error handling
import time
from flask import Flask, jsonify
from flask_http_middleware import MiddlewareManager, BaseHTTPMiddleware
app = Flask(__name__)
class AccessMiddleware(BaseHTTPMiddleware):
def __init__(self):
super().__init__(self)
def dispatch(self, request, call_next):
if request.headers.get("token") == "secret":
return call_next(request)
else:
raise Exception("Authentication Failed)
def error_handler(self, error):
return jsonify({"error": str(error)})
app.wsgi_app = MiddlewareManager(app)
app.wsgi_app.add_middleware(AccessMiddleware)
@app.get("/health")
async def health():
return {"message":"I'm healthy"}
if __name__ == "__main__":
app.run()
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
Built Distribution
Close
Hashes for flask-http-middleware-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b75469c3f10327149e447f08da0c21b52ecd731ac000e05ba3baec74c82f7a4a |
|
MD5 | f9df69e786fdc31271803cc531581070 |
|
BLAKE2b-256 | b0acadd4a3e07d7b9197978538af40794e78378a7e74b016576d213f4d0c97b6 |
Close
Hashes for flask_http_middleware-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5e0952a562455ef078c4afc42815460986e4d7c1acd5d9afc9447b1e4682a1b |
|
MD5 | 2f1abe45bed79093a7ed878851653635 |
|
BLAKE2b-256 | c6db0d41e086f0a69b2b0d16c5fd55dc6855cffe1d16fda3a0a67a929cc18b61 |