Jinja2 中的 Markdown 特殊字符如何自动转义？

python

2024-03-07 13:14:11

在 Jinja2 中自动转义 Markdown 特殊字符

在使用 Jinja2 模板渲染 Markdown 内容时，可能会遇到字符转义的问题。为了防止字符被解释为 Markdown 特殊字符，我们需要确保在渲染之前对它们进行转义。

问题：

当 Jinja2 变量中的字符与 Markdown 特殊字符（如星号和下划线）匹配时，它们会被解释为 Markdown 语法，而不是文本内容。这可能会导致格式错误或安全漏洞。

解决方案：

我们可以通过扩展 Jinja2 来实现自动转义功能，该扩展会在渲染所有打印语句之前自动对变量进行转义。

实现：

class EscapePrintExtension(Extension):

    def filter_stream(self, stream):
        for token in stream:
            if token.type == "variable_end":
                yield Token(lineno=token.lineno, type="pipe", value="|")
                yield Token(lineno=token.lineno, type="name", value="escape_markdown")

            yield token

# ...

env.filters["escape_markdown"] = escape_markdown

其中，escape_markdown 函数负责将字符串中的 Markdown 特殊字符转义。

优化：

为了提高效率，我们可以将转义后的字符串缓存起来。这样，在多次渲染相同内容时，就不需要重复执行转义操作。

escaped_cache = {}

def escape_markdown(text):
    if text in escaped_cache:
        return escaped_cache[text]

    result = text
    for char in MARKDOWN_SPECIAL_CHARACTERS:
        result = result.replace(char, f"\\{char}")

    escaped_cache[text] = result
    return result