starlette flaskダウンロード - starlette flaskソースコードのダウンロード

starlette flask

AI ソースコード

1.0.0

ダウンロード

スターレットフラスコ

Flask セッションのデコーディングとエンコーディングに基づく Starlette/FastAPI アプリケーション用のセッションミドルウェア。

インストール

pip install starlette-flask

使用法

それで、何が問題なのでしょうか？ Flask アプリケーションがあり、それが長期間稼働していたとしましょう。 FastAPI に移行したいが、ユーザーがセッションデータを失うことは望ましくありません。正直に言うと、移行は簡単なプロセスではありません。ゆっくりと実行して、アプリケーションを別のアプリケーションにマウントするなどの FastAPI 機能のメリットを享受することをお勧めします。

Flask アプリケーションを FastAPI アプリケーションにマウントしてみましょう。

 from fastapi import FastAPI , Request , Response
from flask import Flask , jsonify , session , request
from starlette . middleware . sessions import SessionMiddleware
from a2wsgi import WSGIMiddleware

secret_key = "super-secret"


flask_app = Flask ( __name__ )
flask_app . config [ "SECRET_KEY" ] = secret_key


@ flask_app . get ( "/" )
def flask_index ():
    return jsonify ({ "message" : "Hello World from Flask Application" })


@ flask_app . get ( "/set-session" )
def flask_set_session ():
    session [ "application" ] = "flask"
    session . modified = True
    return jsonify ({ "message" : "Session set" })


@ flask_app . get ( "/get-session" )
def flask_get_session ():
    return jsonify ({ "message" : session . get ( "application" , None )})


@ flask_app . get ( "/delete-session" )
def flask_delete_session ():
    session . pop ( "application" )
    session . modified = True
    return jsonify ({ "message" : "Session deleted" })


@ flask_app . before_request
def before_request ():
    print ( session . items ())

@ flask_app . after_request
def after_request ( response ):
    print ( session . items ())
    return response


fastapi_application = FastAPI ()
fastapi_application . add_middleware (
    SessionMiddleware ,
    secret_key = secret_key ,
)


@ fastapi_application . middleware ( "http" )
async def starlette_add_process_time_header ( request : Request , call_next ):
    response = await call_next ( request )
    response . headers [ "X-Process-Time" ] = "100"
    print ( response . headers )
    return response


@ fastapi_application . get ( "/" )
async def starlette_index ( req : Request ):
    return { "message" : "Hello World from FastAPI Application" }


@ fastapi_application . get ( "/set-session" )
async def starlette_set_session ( req : Request ):
    req . session . update ({ "application" : "fastapi" })
    return { "message" : "Session set" }


@ fastapi_application . get ( "/get-session" )
async def starlette_get_session ( req : Request ):
    return { "message" : req . session . get ( "application" , None )}


@ fastapi_application . get ( "/delete-session" )
async def starlette_delete_session ( req : Request ):
    req . session . pop ( "application" )
    return { "message" : "Session deleted" }


app = FastAPI ()
app . mount ( "/flask-application" , WSGIMiddleware ( flask_app ))
app . mount ( "/fastapi-application" , fastapi_application )

ここでの問題は次のとおりです。Flask アプリケーションでセッションを設定すると、FastAPI アプリケーションからセッションを取得できず、その逆も同様です。同時に、これら 2 つのアプリケーションは、セッションデータにアクセスするだけでなく、互いのセッションデータを上書きします。これは、セッションデータに署名するために異なる方法を使用しているためです。

これらは異なる方法を使用してセッションデータに署名するため、互いのセッションデータをデコードすることはできません。何ができるでしょうか？この問題を解決するには、 starlette-flask使用できます。

必要なのはこれだけです:

 - from starlette.middleware.sessions import SessionMiddleware
+ from starlette_flask.middleware.sessions import SessionMiddleware

モチベーション

Flask から FastAPI に移行していたところ、既存の Flask アプリケーションを FastAPI (a2wsgi のおかげ) アプリケーションで使用できることがわかりました。

これは言わなければなりません: 私の Flask アプリケーションの多くは、Flask Admin、Flask Login、Flask-JWT-Extended などのサードパーティの Flask 拡張機能に依存しています。

そこで、Flask と FastAPI を結合する方法を探したところ、方法を見つけました。しかし問題がありました...Flask と FastAPI アプリケーション間のセッションデータにアクセスできませんでした。つまり、Flask 側と FastAPI 側でセッションデータを CRUD することはできましたが、Flask によって CRUD された FastAPI 内のセッションデータを CRUD することができなかったので、この議論を FastAPI リポジトリで開始しました。当時はこれを解決できなかったので、Flask Login と Flask Admin はもう使わないことにしました...

しかし、3月から9月までの議論では何の答えも得られなかったことがわかります。面倒だったので自分で解決することにしました。 FlaskとStarlette（FastAPIのバックエンドコア）のソースコードを見てみました。彼らはセッションデータに署名するために異なる方法を使用していることがわかり、Starlette はセッションデータが作成、更新、削除、さらには読み取られていない場合でも、セッションデータに再署名し続けました。それが問題でした。カスタムのSessionMiddlewareが必要でした。 Flask と同じメソッドを使用してセッションデータに署名し、それを実装しました。

関連するディスカッション/問題/プルリクエストは次のとおりです。

マウントされたアプリケーション間でセッションデータを共有する · tiangolo/fastapi · ディスカッション #9318
セッション Cookie で Base64Url エンコードとデコードを使用する by allezxandre · Pull Request #1922 · encode/starlette
SessionMiddleware はリクエストごとに新しい set-cookie を送信し、意図しない結果が発生します · Issue #2019 · encode/starlette
より柔軟なセッションミドルウェアの作成 · エンコード/スターレット · ディスカッション #2256
SessionMiddleware が不正な形式の Cookie を作成する可能性がある · 問題 #1259 · エンコード/スターレット
hasansezertasan により、 allow_path_regex SessionMiddlewareに追加しました · プルリクエスト #2316 · encode/starlette

別の関連プロジェクトは次のとおりです: volfpeter/fastapi-flask-auth: アクセス制御に Flask セッション Cookie を使用する軽量の FastAPI 依存関係と認証システム。実際、このプロジェクトは私にstarlette-flaskの構築のインスピレーションを与えました。

Starlette のミドルウェアの詳細については、「ミドルウェア - Starlette」ページをご覧ください。