python - 将 html 模板存储在文档字符串中？

Question

我正在使用 Flask 为工作中的内部应用程序编写 Web 服务。许多 Web 服务 URI 返回 HTML 部分，我正在尝试找出一种干净的方法来存储 html 模板字符串。我不想将模板字符串放在单独的文件中，因为它们通常只有几行长，而且我不想有 20 个模板文件，每个文件有 3 行。我正在考虑在函数的文档字符串中定义函数的 html 模板字符串，因为我觉得这有多种用途。它将作为文档，基本上说“这就是我输出的内容”，并且使我不必将 3 行模板字符串存储在单独的文件中。这就是我要说的内容:

@app.route('/path/to/my/resource/<int:_id>')
def some_resource(_id):
    """
    <select id="resource-{{ resource.id }}" class="resource">
        {% for choice in choices %}
        <option id="choice-{{ choice.id }}" value="{{ choice.id }}">
            {{ choice.text }}
        </option>
        {% endfor %}
    </select>
    """

    # retrieving resource, etc...

    return render_template_string(some_resource.__doc__, **kwargs)

我不知道维护这是否会是一场噩梦......有什么想法吗？

Answer 1

我认为这是一个糟糕的计划。

文档字符串用于文档，模板不是文档。文档应该描述该函数的用途。 HTML 模板是一个很糟糕的替代品。

您可以使用多行字符串来保存模板，这可能是个好主意。通过将它们设为文档字符串，您不会获得任何好处。