Python代码高亮与HTML格式化：pygments.formatters.html.HtmlFormatter()介绍

发布时间：2023-12-14 06:53:17

pygments是一个用于代码语法高亮的Python库。它支持许多编程语言，并且可以将代码以HTML格式进行输出。

要使用pygments的HTML格式化功能，我们可以使用pygments.formatters.html.HtmlFormatter类。该类提供了许多选项，可以定制HTML输出的样式和外观。下面是HtmlFormatter类的一些常用属性和方法：

1. style：指定代码高亮的样式。可以选择内置的样式，如'colorful'、'default'等，也可以自定义样式。例如，可以使用'style="borland"'来指定Borland风格的代码高亮。

2. linenos：指定是否显示行号。可以设置为True或False，默认为False。

3. cssclass：指定生成的HTML代码中的CSS类名。可以用于自定义样式。例如，可以使用'cssclass="mycode"'来指定自定义的CSS类名为mycode。

4. nowrap：指定是否在HTML代码中取消换行。可以设置为True或False，默认为False。

5. full：指定是否生成完整的HTML文档。如果设置为True，则会生成带有头部和尾部的完整HTML文档；如果设置为False，则只会生成代码部分的HTML片段。默认为False。

接下来，让我们看一个使用HtmlFormatter的例子：

from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter

code = '''
def foo():
    print("Hello, World!")
'''

lexer = PythonLexer()
formatter = HtmlFormatter(style="colorful", linenos=True, cssclass="mycode", nowrap=False)
highlighted_code = highlight(code, lexer, formatter)

html = '''
<!DOCTYPE html>
<html>
  <head>
    <style>
      {style}
    </style>
  </head>
  <body>
    <pre class="{cssclass}">{highlighted_code}
    </pre>
  </body>
</html>
'''.format(style=formatter.get_style_defs(), cssclass=formatter.cssclass, highlighted_code=highlighted_code)

print(html)

在这个例子中，我们首先定义了一个Python代码字符串，然后创建了一个PythonLexer实例和HtmlFormatter实例。我们将代码字符串、Lexer实例和Formatter实例传递给highlight()函数，获取到了代码高亮的结果。

然后，我们使用获取的高亮结果，结合自定义的HTML模板，生成了一个完整的HTML文档。我们通过formatter.get_style_defs()获取到了指定样式的CSS代码，并将其嵌入到HTML文档的头部。我们还通过formatter.cssclass获取到了CSS类名，并将其用于HTML文档中的<pre>标签，用以自定义样式。

最后，我们打印出生成的HTML代码。

通过这个例子，我们可以了解到如何使用pygments.formatters.html.HtmlFormatter类来生成带有代码高亮的HTML文档。我们可以根据需要，自定义样式、行号、CSS类名等选项，实现个性化的代码高亮效果。