Потоковая передача содержимого

Основное использование

Это базовая функция представления, генерирующая большое количество данных CSV на лету. Секрет заключается во внутренней функции, использующей генератор для создания данных, а затем вызывающей эту функцию и передающей её в объект ответа:

@app.route('/large.csv')
def generate_large_csv():
    def generate():
        for row in iter_all_rows():
            yield f"{','.join(row)}\n"
    return generate(), {"Content-Type": "text/csv"}

Каждый yield элемент напрямую отправляется браузеру. Однако некоторые WSGI-мидлвары могут нарушить потоковую передачу, поэтому будьте осторожны в отладочных средах с профилировщиками и другими включёнными инструментами.

Потоковая передача из шаблонов

Двигатель шаблонов Jinja2 поддерживает поэтапное рендеринг шаблона, возвращая итератор строк. Flask предоставляет функции stream_template() и stream_template_string() для упрощения использования.

from flask import stream_template

@app.get("/timeline")
def timeline():
    return stream_template("timeline.html")

Части, возвращаемые потоком рендеринга, как правило, соответствуют блокам инструкций в шаблоне.

Потоковая передача с контекстом

Объект request не будет активным во время работы генератора, так как представление уже возвратило результат. Если попытаться получить доступ к request, будет получено значение RuntimeError.

Если функция-генератор зависит от данных в request, используйте обёртку stream_with_context(). Это сохранит контекст запроса активным во время работы генератора.

from flask import stream_with_context, request
from markupsafe import escape

@app.route('/stream')
def streamed_response():
    def generate():
        yield '<p>Hello '
        yield escape(request.args['name'])
        yield '!</p>'
    return stream_with_context(generate())

Её также можно использовать как декоратор.

@stream_with_context
def generate():
    ...

return generate()

Функции stream_template() и stream_template_string() автоматически используют stream_with_context(), если активен запрос.