ミドルウェアの設定

AIOHTTPミドルウェア は、aiohttpのweb.Applicationコンストラクタに引数として渡されるクラスベースのミドルウェア です。次の例は、Contrastミドルウェアクラスを使用するAIOHTTPアプリケーションの例です。

from aiohttp import web
from contrast.aiohttp import ContrastMiddleware


routes = web.RouteTableDef()

@routes.get("/")
def index(request):
    raise web.HTTPFound("/hello")


middlewares = [ContrastMiddleware(app_name="app name")]
app = web.Application(middlewares=middlewares)
app.add_routes(routes)

web.run_app(app)

ContrastのBottleミドルウェアはWSGIミドルウェアで、Bottleアプリケーションのインスタンスをラッピングすることによって動作します。

BottleでPythonエージェントを設定するには：

app = ContrastMiddleware(
    app,
    original_bottle_app,  # instance of bottle.Bottle
)

新設定手順：Contrast Pythonエージェントのバージョン4.6.0以降はこの手順を利用します

ContrastのDjangoミドルウェアはWSGIミドルウェアであり、Djangoスタイルのミドルウェアではありません。

旧設定手順：Contrast Pythonエージェントのバージョン5.0.0以降でこの手順は利用できません

Djangoミドルウェアの設定は、settings.pyファイルで行います。

Falcon(ASGI)ミドルウェアは、Falcon(ASGI)アプリケーションのインスタンスをラッピングすることによって動作するASGIミドルウェアです。

以下の例は、Falcon(ASGI)アプリケーションをContrastミドルウェアのクラスでラップするサンプルです。

import falcon.asgi
from contrast.falcon_asgi import ContrastMiddleware


class Home(object):
    async def on_get(self, req, resp):
        resp.status = falcon.HTTP_200
        resp.body = "Hello World"
        
def create():
    # This is where the example app is declared. Look for something similar in your
    # application since this instance needs to be wrapped by Contrast middleware
    _app = falcon.asgi.App()
    
    # Add routes to your app
    home = Home()
    _app.add_route("/home", home)
    
    # This line wraps the application instance with the Contrast middleware
    # NOTE: Contrast should be the first middleware if others are used
    _app = ContrastMiddleware(_app)
    return _app


app = create()

ContrastのFalconミドルウェアはWSGIミドルウェアであり、Falconスタイルのミドルウェアではありません。

FastAPIミドルウェアは、starlette.middleware.BaseHTTPMiddlewareに依存する、クラスベースのASGIミドルウェアです。ContrastがサポートするFastAPIのバージョンについては、Pythonエージェントのサポート対象テクノロジを確認してください。次の例は、Contrastミドルウェアクラスを使用したFastAPIアプリケーションのサンプルです。

from fastapi import FastAPI
from contrast.fastapi import ContrastMiddleware

app = FastAPI()
app.add_middleware(ContrastMiddleware, original_app=app)

@app.get("/")
def read_root():
    return RedirectResponse("/home")

FastAPIアプリケーションでContrast以外のミドルウェアを使用している場合、特定の機能を動作させるために、Contrastを最初のミドルウェアとして初期化する必要があります。

from fastapi import FastAPI
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
from contrast.fastapi import ContrastMiddleware

app = FastAPI()

# ContrastMiddleware must be the first middleware
app.add_middleware(ContrastMiddleware, original_app=app)
app.add_middleware(HTTPSRedirectMiddleware)

一部の機能で、FastAPIのappをoriginal_appキーワードの引数として渡す必要があるため、現時点ではadd_middleware メソッドでミドルウェアを追加する方法のみがサポートされます。ミドルウェアを直接FastAPIクラスの初期化に渡すことでミドルウェアを初期化する方法は、Contrastでは現在サポートされていません。

# Not currently supported.
app = FastAPI(middleware=[...])

ContrastのFlaskミドルウェアはWSGIミドルウェアで、Flaskアプリケーションのインスタンスをラッピングすることによって動作します。

旧設定手順：Contrast Pythonエージェントのバージョン5.0.0以降でこの手順は利用できません

Pyramidでは、ミドルウェアは「tween」と呼ばれています。

新設定手順：Contrast Pythonエージェントのバージョン4.6.0以降ではこの手順を利用します

ContrastのPyramidミドルウェアはWSGIミドルウェアであり、Pyramidスタイルの「tween」ではありません。

Quartミドルウェアは、Quartアプリケーションオブジェクトをラップしてasgi_app属性に割り当てる必要があります。以下の例は、Contrastミドルウェアクラスを使用するQuartアプリケーションのサンプルです。

from quart import Quart, redirect
from contrast.quart import ContrastMiddleware


app = Quart(__name__)
app.asgi_app = ContrastMiddleware(app)

@app.route("/")
async def index():
    return redirect("/home")

Contrastは、エージェントのコア機能を全て含む汎用のWSGIミドルウェアを提供しています。ルート探索などのフレームワーク固有の機能は、汎用のWSGIミドルウェアには実装されていません。

Contrastを使用してWSGI準拠のアプリケーションを検査するには：

WSGIミドルウェアの詳細については、WSGIの仕様を参照してください。