# Streaming

# Request streaming

Sanicを使用すると、クライアントから送信されたデータをストリーミングして、バイトが到着するとデータの処理を開始できます。

エンドポイントで有効にすると、await request.stream.read()を使用してリクエストボディをストリーミングできます。

そのメソッドは、本文が完了すると「なし」を返します。

from sanic.views import stream
class SimpleView(HTTPMethodView):
    @stream
    async def post(self, request):
        result = ""
        while True:
            body = await request.stream.read()
            if body is None:
                break
            result += body.decode("utf-8")
        return text(result)

また、デコレータのキーワード引数で有効にすることもできます。

@app.post("/stream", stream=True)
async def handler(request):
        ...
        body = await request.stream.read()
        ...

... or the add_route() method.

bp.add_route(
    bp_handler,
    "/bp_stream",
    methods=["POST"],
    stream=True,
)

FYI

Post、put、patchデコレータのみがストリーム引数を持っています。

# Response streaming

Sanicを使用すると、「StreamingHTTPResponse」のインスタンスを使用してクライアントにコンテンツをストリーミングできます。sanic.response.streamコンビニエンスメソッドもあります。

このメソッドは、クライアントへの書き込みを制御できるオブジェクトを渡されるコルーチンコールバックを受け入れます。

from sanic.response import stream
@app.route("/")
async def test(request):
    async def sample_streaming_fn(response):
        await response.write("foo,")
        await response.write("bar")
    return stream(sample_streaming_fn, content_type="text/csv")

これは、データベースなどの外部サービスに由来するクライアントにコンテンツをストリーミングする場合に便利です。たとえば、asyncpgが提供する非同期カーソルを使用して、データベースレコードをクライアントにストリーミングできます。

@app.route("/")
async def index(request):
    async def stream_from_db(response):
        conn = await asyncpg.connect(database='test')
        async with conn.transaction():
            async for record in conn.cursor('SELECT generate_series(0, 10)'):
                await response.write(record[0])
    return stream(stream_from_db)

FYI

クライアントが HTTP/1.1 をサポートしている場合、Sanic はチャンク転送エンコーディング (opens new window) を使用します。ストリーム関数のチャンクオプションを使用して明示的に有効または無効にできます。

streamを使用したコルーチンコールバックパターンは必要ありません。これはストリーミングの古いスタイルであり、新しいインラインストリーミングに置き換える必要があります。これで、ハンドラーで応答を直接ストリーミングできるようになりました。

@app.route("/")
async def test(request):
    response = await request.respond(content_type="text/csv")
    await response.send("foo,")
    await response.send("bar")
    await response.eof()
    return response

上記の例では、await response.eof() は await response.send("", True) を置き換える便利なメソッドとして呼び出されます。ハンドラがクライアントに送り返すものが何も残っていないと判断した場合、** 1回** afterを呼び出す必要があります。

# File streaming

Sanicは、大きなファイルを送信する場合に便利な sanic.response.file_stream 関数を提供します。StreamingHTTPResponseオブジェクトを返し、デフォルトでチャンク転送エンコーディングを使用します。このため、Sanicは応答にContent-Length HTTPヘッダーを追加しません。

典型的なユースケースは、ビデオファイルをストリーミングしている可能性があります。

@app.route("/mp4")
async def handler_file_stream(request):
    return await response.file_stream(
        "/path/to/sample.mp4",
        chunk_size=1024,
        mime_type="application/metalink4+xml",
        headers={
            "Content-Disposition": 'Attachment; filename="nicer_name.meta4"',
            "Content-Type": "application/metalink4+xml",
        },
    )

Content-Lengthヘッダーを使用する場合は、チャンク転送エンコーディングを無効にし、Content-Lengthヘッダーを追加するだけで手動で追加できます。

from aiofiles import os as async_os
from sanic.response import file_stream
@app.route("/")
async def index(request):
    file_path = "/srv/www/whatever.png"
    file_stat = await async_os.stat(file_path)
    headers = {"Content-Length": str(file_stat.st_size)}
    return await file_stream(
        file_path,
        headers=headers,
    )

← プロキシ構成 Websockets →