python - 在 Python 中将文本转换为 HTML 注释

Question

我有一个生成一些 HTML 的 Python 脚本。它使用 the Python markdown library 这样做.我想将原始的 Markdown 文本粘贴在 HTML 末尾的注释中，它偶尔会用于调试目的。我试过在 HTML 结束后插入 Markdown 文本，但它对我 (Firefox) 不起作用。所以我想象这个工作的方式是我运行 Markdown，然后简单地在 HTML 之后附加标记为注释的 Markdown 源代码。然而，HTML 显然对它在注释中允许的内容有些挑剔。网站 htmlhelp.com 经过一番讨论后给出了以下建议:

For this reason, use the following simple rule to compose valid and accepted [portable] comments:
An HTML comment begins with "" and does not contain "--" or ">" anywhere in the comment.
(source)

所以看起来我需要做一些转义或其他事情来将我的一堆 Markdown 文本转换为 HTML 将接受作为评论的形式。是否有现成的工具可以帮助我做到这一点？

Answer 1

根据w3 :

Comments consist of the following parts, in exactly the following order:

- the comment start delimiter "<!--"
- text
- the comment end delimiter "-->"

The text part of comments has the following restrictions:

1. must not start with a ">" character
2. must not start with the string "->"
3. must not contain the string "--"
4. must not end with a "-" character

这些都是非常简单的规则。您可以使用正则表达式强制执行它们，但它们非常简单，您甚至不需要它!

4 个条件中的 3 个可以通过串联来满足，另一个可以通过简单的 replace() 来满足。 总而言之，这是一条线:

def html_comment(text):
    return '<!-- ' + text.replace('--', '- - ') + ' -->'

注意空格。