将 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 模板是一个很糟糕的替代品。

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

Answer 2

这当然是一个有趣的想法，并且按照 doctest 的示例，将功能上有用的内容而不只是文本放入文档字符串中并非完全闻所未闻。明显的缺点是文档字符串中没有文档。现在，如果这些方法不是程序员可能需要通过 help() （或使用文档字符串自动生成的文档）提供文档的内容，那么这可能是也可能不是一个大问题。

但是，为什么不呢：

1. 只使用本地字符串变量 - 缺点是您无法从函数范围之外通过__doc__获取它
2. >如果只使用一次，只需将其放入 render_template_string 调用 - 与 #1 相同的缺点，但如果使用多次则不适用
3. 创建另一个将此字符串作为参数的装饰器 - 特别是如果它只是遵循上面的模式，您只使用它一次并且您总是在最后执行相同的调用，这将允许您拉动它从那个方法中

Answer 3

在某些模板引擎中，如果对象具有 __html__ 方法，则其输出将被视为安全（转义）字符串。

def fn(x):
    bla = x
fn.__html__ = lambda : '''
    <h1>Headline</h1>
    <p>lorem ipsum</p>
    '''