在更新时显示从烧瓶视图流的数据

Question

我有一种生成数据并实时流式传输的视图。我不知道如何将这些数据发送到可以在HTML模板中使用的变量。我当前的解决方案只是在到达时将数据输出到空白页面，但我想将其包括在更大的页面中，并使用格式化。在将数据流传输到页面时，如何更新，格式化和显示数据？

import flask
import time, math

app = flask.Flask(__name__)

@app.route('/')
def index():
    def inner():
        # simulate a long process to watch
        for i in range(500):
            j = math.sqrt(i)
            time.sleep(1)
            # this value should be inserted into an HTML template
            yield str(i) + '<br/>\n'
    return flask.Response(inner(), mimetype='text/html')

app.run(debug=True)

Answer 1

您可以在响应中流式传输数据，但是您不能以描述方式动态更新模板。该模板在服务器端渲染一次，然后发送到客户端。

一种解决方案是使用JavaScript读取流响应并在客户端输出数据。使用XMLHTTPREQUEST向将流传输数据的端点提出请求。然后定期从流读取直到完成。

这引入了复杂性，但允许直接更新页面，并对输出的外观完全控制。下面的示例表明，通过显示所有值的当前值和日志。

此示例假设一个非常简单的消息格式：单个数据行，然后是新线。只要有一种方法可以识别每个消息，这可能会尽可能复杂。例如，每个循环都可以返回客户端解码的JSON对象。

from math import sqrt
from time import sleep
from flask import Flask, render_template

app = Flask(__name__)

@app.route("/")
def index():
    return render_template("index.html")

@app.route("/stream")
def stream():
    def generate():
        for i in range(500):
            yield "{}\n".format(sqrt(i))
            sleep(1)

    return app.response_class(generate(), mimetype="text/plain")

<p>This is the latest output: <span id="latest"></span></p>
<p>This is all the output:</p>
<ul id="output"></ul>
<script>
    var latest = document.getElementById('latest');
    var output = document.getElementById('output');

    var xhr = new XMLHttpRequest();
    xhr.open('GET', '{{ url_for('stream') }}');
    xhr.send();
    var position = 0;

    function handleNewData() {
        // the response text include the entire response so far
        // split the messages, then take the messages that haven't been handled yet
        // position tracks how many messages have been handled
        // messages end with a newline, so split will always show one extra empty message at the end
        var messages = xhr.responseText.split('\n');
        messages.slice(position, -1).forEach(function(value) {
            latest.textContent = value;  // update the latest value in place
            // build and append a new item to a list to log all output
            var item = document.createElement('li');
            item.textContent = value;
            output.appendChild(item);
        });
        position = messages.length - 1;
    }

    var timer;
    timer = setInterval(function() {
        // check the response for new data
        handleNewData();
        // stop checking once the response has ended
        if (xhr.readyState == XMLHttpRequest.DONE) {
            clearInterval(timer);
            latest.textContent = 'Done';
        }
    }, 1000);
</script>

---

一个＆lt; iframe＆gt;可用于显示流的HTML输出，但它具有一些缺点。框架是一个单独的文档，可增加资源使用情况。由于它仅显示流数据，因此可以像页面的其余部分那样对其进行样式。它只能附加数据，因此长量输出将在可见的滚动区域以下呈现。它无法根据每个事件修改页面的其他部分。

index.html用指向stream endpoint的帧呈现页面。该框架具有相当小的默认尺寸，因此您可能需要进一步设置它。使用Render_template_string知道要逃脱变量，以渲染每个项目的HTML（或使用更复杂的模板文件使用render_template）。可以首先产生一条初始线以将CSS加载到框架中。

from flask import render_template_string, stream_with_context

@app.route("/stream")
def stream():
    @stream_with_context
    def generate():
        yield render_template_string('<link rel=stylesheet href="{{ url_for("static", filename="stream.css") }}">')

        for i in range(500):
            yield render_template_string("<p>{{ i }}: {{ s }}</p>\n", i=i, s=sqrt(i))
            sleep(1)

    return app.response_class(generate())

<p>This is all the output:</p>
<iframe src="{{ url_for("stream") }}"></iframe>

Answer 2

迟到了5年，但实际上可以按照您最初尝试这样做的方式进行，JavaScript完全不必要（编辑：被接受答案的作者在我写这本书后添加了iframe部分。您只需要将输出作为＆lt; iframe＆gt;：

from flask import Flask, render_template, Response
import time, math

app = Flask(__name__)

@app.route('/content')
def content():
    """
    Render the content a url different from index
    """
    def inner():
        # simulate a long process to watch
        for i in range(500):
            j = math.sqrt(i)
            time.sleep(1)
            # this value should be inserted into an HTML template
            yield str(i) + '<br/>\n'
    return Response(inner(), mimetype='text/html')


@app.route('/')
def index():
    """
    Render a template at the index. The content will be embedded in this template
    """
    return render_template('index.html.jinja')

app.run(debug=True)

然后，'index.html.jinja'文件将包含＆lt; iframe＆gt;和内容url作为SRC，它类似：

<!doctype html>
<head>
    <title>Title</title>
</head>
<body>
    <div>
        <iframe frameborder="0" 
                onresize="noresize"
                style='background: transparent; width: 100%; height:100%;' 
                src="{{ url_for('content')}}">
        </iframe>
    </div>
</body>

当渲染用户提供的数据render_template_string（）时，应用于渲染内容以避免注入攻击。但是，我从示例中排除了这一点，因为它增加了额外的复杂性，不在问题的范围之内，与OP无关，因为他没有流式传输用户提供的数据，并且与广泛的数据无关大多数人看到这篇文章，因为流媒体提供用户提供的数据是一个遥远的情况，如果有任何人必须这样做的话，很少有人。

Answer 3

最初，我有一个类似的问题，与发布的问题相似，在这里正在训练模型并在HTML中进行固定并格式化。以下答案是用于将来的参考或试图解决相同问题并需要灵感的人。

一个很好的解决方案是在JavaScript中使用EventSource，如所述在这里。可以使用上下文变量启动此侦听器，例如从表单或其他来源。通过发送停止命令来停止听众。在此示例中，使用睡眠命令可进行可视化。最后，可以使用JavaScript Dom-manipulation实现HTML格式。

烧瓶应用程序

import flask
import time

app = flask.Flask(__name__)

@app.route('/learn')
def learn():
    def update():
        yield 'data: Prepare for learning\n\n'
        # Preapre model
        time.sleep(1.0)

        for i in range(1, 101):
            # Perform update
            time.sleep(0.1)
            yield f'data: {i}%\n\n'

        yield 'data: close\n\n'

    return flask.Response(update(), mimetype='text/event-stream')


@app.route('/', methods=['GET', 'POST'])
def index():
    train_model = False

    if flask.request.method == 'POST':
        if 'train_model' in list(flask.request.form):
            train_model = True

    return flask.render_template('index.html', train_model=train_model)

app.run(threaded=True)

HTML模板

<form action="/" method="post">
    <input name="train_model" type="submit" value="Train Model" />
</form>

<p id="learn_output"></p>

{% if train_model %}
<script>
    var target_output = document.getElementById("learn_output");
    var learn_update = new EventSource("/learn");

    learn_update.onmessage = function (e) {
        if (e.data == "close") {
            learn_update.close();
        } else {
            target_output.innerHTML = "Status: " + e.data;
        }
    };
</script>
{% endif %}