使用Pygments.formatters.html在Python中实现代码转换为HTML示例

发布时间：2023-12-11 06:05:38

Pygments是一个强大的代码高亮库，它支持多种语言和输出格式。在Python中，可以使用Pygments.formatters.html模块将代码转换为HTML格式。

首先，需要安装Pygments库。可以使用pip命令进行安装：

pip install Pygments

下面是一个将Python代码转换为HTML格式的示例：

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

code = '''
def hello():
    print("Hello, world!")

hello()
'''

lexer = PythonLexer()
formatter = HtmlFormatter()

highlighted_code = highlight(code, lexer, formatter)

html = f'''
<!DOCTYPE html>
<html>
<head>
    <style>
        {formatter.get_style_defs('.highlight')}
    </style>
</head>
<body>
    {highlighted_code}
</body>
</html>
'''

print(html)

在上面的示例中，我们首先导入了highlight、PythonLexer和HtmlFormatter模块。然后，我们定义了一段Python代码，并创建了相应的lexer和formatter对象。

然后，我们使用highlight函数将代码转换为HTML格式。highlight函数接受三个参数：代码字符串、词法分析器（lexer）和格式化器（formatter）。返回的highlighted_code是一个包含HTML代码的字符串。

接下来，我们将highlighted_code嵌入到HTML页面中。我们使用字符串插值（f-string）来创建完整的HTML页面，然后使用print函数将其输出到控制台。

需要注意的是，我们在HTML页面的<head>标签中使用了style标签，其中包含formatter.get_style_defs('.highlight')的调用。这个调用会返回一段包含CSS样式的字符串，用于设置代码的外观样式。可以根据需要调整CSS样式以适应自己的需求。

最后，运行上述代码会在控制台上输出生成的HTML页面。可以将输出结果保存为一个HTML文件，并用浏览器打开查看。

这只是一个简单的示例，你可以根据自己的需求进行更复杂的使用。Pygments支持多种语言和输出格式，并且提供了丰富的配置选项，可以满足各种高亮需求。可以参考Pygments的文档以了解更多详细信息。