Flask Stream Helpers API

stream_with_contextジェネレータ関数内でリクエストコンテキストを保持し、ストリーミングレスポンス中でも request、session などのオブジェクトにアクセスできるようにします。


stream_with_context

パラメータ 型 説明
generator_or_function iterator / callable ジェネレータ関数または呼び出し可能オブジェクト。デコレータまたはラッパー関数として使用します。

二つの使い方

使い方 説明
デコレータパターン @stream_with_context でジェネレータ関数をデコレートします
ラッパーパターン stream_with_context(generator()) で作成済みのジェネレータをラップします

注意事項:レスポンスボディの送信が開始されると、レスポンスヘッダーを変更できなくなります。ジェネレータ内で session にアクセスする必要がある場合は、ビュー関数内で先に session にアクセスして Vary: Cookie ヘッダーの設定をトリガーする必要があります。


コード例

サンプル

from flask import Flask, stream_with_context, request, Response

app = Flask(__name__)

@app.get("/stream")
def streamed_response():
    """ストリーミングレスポンスの例:データを1行ずつ送信します"""
    @stream_with_context
    def generate():
        # レスポンスの送信が開始されていても、request にアクセスできます
        yield f"data: Hello {request.args.get('name', 'サンプル')}\n"
        for i in range(5):
            yield f"data: Line {i}\n"
        yield "data: [DONE]\n"

    return Response(generate(), mimetype="text/event-stream")

@app.get("/stream-wrap")
def stream_wrap():
    """ラッパーパターン"""
    def generate():
        yield "Hello "
        yield request.args.get("name", "World")
        yield "!"

    # stream_with_context で作成済みのジェネレータをラップします
    return Response(stream_with_context(generate()))
その他の拡張機能