Python：pygments 库高级用法举例和应用详解

python库 › 代码处理
, , ,

Python Pygments Library

在 Python 生态中，Pygments 是一个流行且强大的库，专门用于代码的语法高亮处理。它支持多种编程语言和丰富的样式，能够将代码块转换成美观的 HTML 或 LaTeX 格式，极大提升代码的可读性。Pygments 适用于 Python 2 和 3，但在此，我们将主要关注 Python 3 的使用。

模块介绍

Pygments 是一个开源的语法高亮库，支持 100 多种编程语言以及标记语言的代码高亮。它提供了强大且灵活的 API，允许开发者为代码生成多种样式的输出。支持的 Python 版本为 3.x，目前最新版本为 2.14.0。

应用场景

Pygments 的主要用途包括：

  • 在网页上展示代码片段，使其更加美观和易读。
  • 生成带有语法高亮的文档，比如 Markdown 或 reStructuredText 格式。
  • 在学术论文或电子书中展示代码，使读者能够更容易理解代码逻辑。
  • 开发 IDE 或其他需要代码展示的应用程序。

安装说明

Pygments 并不是 Python 的默认模块，您需要通过 Python 包管理工具来安装它。可以使用以下命令进行安装：

1
pip install Pygments  # 使用 pip 安装 pygments 库

用法举例

1. 基本的代码高亮

1
2
3
4
5
6
7
8
9
from pygments import highlight  # 导入代码高亮函数
from pygments.lexers import PythonLexer  # 导入 Python 语法分析器
from pygments.formatters import HtmlFormatter  # 导入 HTML 格式化器

code = '''print("Hello, World!")  # 打印 Hello World'''
lexer = PythonLexer()  # 创建 Python 语法分析器实例
formatter = HtmlFormatter()  # 创建 HTML 格式化器实例
result = highlight(code, lexer, formatter)  # 高亮处理代码
print(result)  # 打印高亮后的 HTML 代码

2. 自定义样式的代码高亮

1
2
3
4
5
6
7
8
9
from pygments import highlight  # 导入代码高亮函数
from pygments.lexers import JavaScriptLexer  # 导入 JavaScript 语法分析器
from pygments.formatters import HtmlFormatter  # 导入 HTML 格式化器

code = '''console.log("Hello, World!");  // 输出 Hello World'''
lexer = JavaScriptLexer()  # 创建 JavaScript 语法分析器实例
formatter = HtmlFormatter(style='monokai')  # 创建带有 Monokai 样式的 HTML 格式化器实例
result = highlight(code, lexer, formatter)  # 高亮处理代码
print(result)  # 打印高亮后的 HTML 代码

3. 从文件中读取代码并高亮显示

1
2
3
4
5
6
7
8
9
10
11
12
from pygments import highlight  # 导入代码高亮函数
from pygments.lexers import PythonLexer  # 导入 Python 语法分析器
from pygments.formatters import HtmlFormatter  # 导入 HTML 格式化器

# 从文件中读取代码
with open('example.py', 'r') as f:  # 打开代码文件
    code = f.read()  # 读取文件内容

lexer = PythonLexer()  # 创建 Python 语法分析器实例
formatter = HtmlFormatter()  # 创建 HTML 格式化器实例
result = highlight(code, lexer, formatter)  # 高亮处理代码
print(result)  # 打印高亮后的 HTML 代码

以上是 Pygments 的几种使用实例，包括基本的代码高亮、自定义样式和从文件中读取代码进行高亮。通过这些示例，您可以轻松地将代码进行高亮处理，从而使代码在网页或文档中更具吸引力。同时，Pygments 提供了丰富的 API 支持，能够满足各种需求的自定义设置。

强烈建议大家关注我的博客（全糖冲击博客），我会在里面提供所有 Python 标准库的使用教程，方便大家进行查询和学习。我的博客内容涵盖丰富的 Python 主题，能够帮助你掌握不同模块的特性和用法，提高程序开发能力。关注我的博客，不仅能够获得实时的更新和深度解析，还能与我交流学习心得，共同进步。期待您的加入，让我们一起探索 Python 的世界，开启编程的无限可能！

软件版本可能变动

如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang