在进入 Python 编码时，我们常常会遇到让代码更具可读性或者给对方留下深刻印象的需求。Pygments 是一个强大的语法高亮库，它可以帮你轻松实现代码高亮，让你的文档、网页或演示中，代码的呈现更加专业和美观。今天，我将带你一起探索 Pygments 的安装与使用，从基础入手，逐步掌握这个库的魅力。如果在学习过程中遇到问题，随时可以在下方留言联系我哦！
Pygments 是一个用 Python 编写的库，我们可以通过 pip 进行安装。打开终端或命令行工具，在命令行中输入以下命令：
pip install Pygments
安装完成后，你可以通过运行以下命令来验证是否安装成功：
python -m pygments -V
如果命令返回版本信息，说明你已成功安装 Pygments；如果没有返回信息，请检查你的安装过程。
Pygments 的基础用法接下来，我们来看看 Pygments 的基本用法。Pygments 主要有几个核心概念，包括 Lexer（解析器）、Formatter（格式化器）和 Style（样式）。我们可以使用这些组件将代码转换为高亮的 HTML 或其他格式。
代码示例首先，我们来创建一个 Python 文件 example.py，写入以下简单的代码：
def hello_world(): print("Hello, World!")
接下来，我们用 Pygments 来高亮这段代码：
from pygments import highlightfrom pygments.lexers import PythonLexerfrom pygments.formatters import HtmlFormatter# 读取 Python 代码code = open("example.py").read()# 创建一个解析器和格式化器lexer = PythonLexer()formatter = HtmlFormatter(full=True, style='colorful')# 进行高亮处理highlighted_code = highlight(code, lexer, formatter)# 将高亮后的代码写入 HTML 文件with open("highlighted_example.html", "w") as f: f.write(highlighted_code)
代码解读导入模块：我们从 pygments 中导入 highlight 方法、PythonLexer （用于解析 Python 代码的解析器）和 HtmlFormatter （将代码格式化为 HTML 格式的格式化器）。
读取代码：使用 Python 的文件操作读取我们前面创建的 example.py 文件。
创建 Lexer 和 Formatter：使用 PythonLexer() 创建解析器实例，使用 HtmlFormatter(full=True, style='colorful') 创建格式化器实例，这里 full=True 表示生成完整的 HTML 页，style 是我们选择的高亮风格。
高亮处理：调用 highlight() 方法，将代码、解析器和格式化器传入，返回高亮处理后的代码。
写入 HTML 文件：将生成的高亮代码写入一个新的 HTML 文件 highlighted_example.html。你可以直接用浏览器打开这个文件，查看漂亮的高亮效果。
常见问题及解决方法Q1: Pygments 安装失败如果在安装过程中遇到问题，首先确保你已安装了最新版本的 pip，尝试使用以下命令更新：
pip install --upgrade pip
如果仍然无法安装，请检查 Python 是否已正确安装，并确保网络连接正常。
Q2: 生成的 HTML 文件不正确如果你发现生成的 HTML 文件没有正确高亮，检查以下几点：
确保你选择的 Lexer 是正确的，支持的语言可在 Pygments 文档中找到。
确保 highlighted_code 变量中确实包含了高亮后的代码。
高级用法自定义样式Pygments 支持多种高亮样式。你可以通过指定不同的样式名来定制你的代码样式。例如：
formatter = HtmlFormatter(full=True, style='monokai')
将高亮代码嵌入网页除了生成独立的 HTML 文件，你也可以将高亮代码嵌入到现有的网页中，只需将高亮的内容插入到相应的位置，例如：
<!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8"> <title>Highlighted Code</title> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/pygments/2.16.1/styles/default.css"></head><body> <h1>My Highlighted Python Code</h1> <div> {{ highlighted_code|safe }} </div></body></html>
你可以将 highlighted_code 变量通过模板引擎引入到网页中显示。
生成 PDF 文件Pygments 也支持将高亮代码输出为 PDF 格式。可以使用 TerminalFormatter 和 PdfFormatter 来实现，示例如下：
from pygments.formatters import LatexFormatter# 生成 PDF 格式代码formatter = LatexFormatter(full=True)with open("highlighted_example.tex", "w") as f: f.write(highlight(code, lexer, formatter))
你可以将生成的 .tex 文件转换为 PDF，使用 LaTeX 请确保已正确安装。
总结通过本篇文章，我们学习了 Pygments 的安装、基础用法以及一些高级技巧，帮助你更好地对 Python 代码进行高亮处理。Pygments 不仅让代码阅读体验更加友好，更为我们的作品增添了视觉美感。希望大家能在庞大的 Pygments 生态中找到合适的高亮风格和用法，提升自己的编程文档质量。如果在使用过程中有任何疑问，欢迎大家随时留言和我交流！
