Python Pygment是什么，怎么用？

Pygments是Python生态中最成熟、最通用的语法高亮引擎，覆盖数百种编程语言，能够为静态博客、文档系统和命令行工具输出干净的着色代码，且无需依赖前端JavaScript。

pygments安装步骤：从零开始配置你的高亮环境

刚刚接触Python代码高亮时，第一步就是安装Pygments，这个库通过pip一次性安装,随后即可在终端或Python脚本中调用。

加载中

三分钟搞懂【Python】是什么？

几度编程

1.7万1823

原视频地址

用pip完成安装

打开终端,运行以下命令：

pip install Pygments

安装完成后,验证是否成功：

pygmentize -V

如果看到版本号，说明环境就绪，整个过程不到一分钟，相比于其他依赖编译的语法高亮方案,Pygments的安装步骤非常轻量。

命令行快速上手

Pygments自带的命令行工具pygmentize是最高频的应用方式，假设你有一个Python文件hello.py,想生成高亮后的HTML代码：

pygmentize -f html -o hello.html hello.py

• -f html 指定输出格式为HTML。
• -o hello.html 指定输出文件名。
• 最后的参数是源文件路径。

打开生成的HTML文件，你会看到代码关键词已经着色，如果想将高亮代码嵌入到自己的页面中，可以在生成时去掉外部HTML标签,只保留内部代码块：

pygmentize -f html -O full,style=monokai -o hello.html hello.py

-O full 表示生成完整的HTML文档，style=monokai 指定配色主题。

在Python脚本中调用

对于需要动态生成高亮代码的场景，直接在Python里调用Pygments更灵活，核心操作分三步：选择词法分析器、选择格式化器、执行高亮。

from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter
code = "print('Hello, world!')"
highlighted = highlight(code, PythonLexer(), HtmlFormatter())
print(highlighted)

运行后会输出带<span>标签的HTML片段，你可以将其插入到模板中，或保存为文件，Pygments提供了数百种语言对应的Lexer，大部分通过文件名自动识别，你也可以手动指定，比如JavascriptLexer、GoLexer。

python pygments用法进阶：自定义样式与输出格式

掌握了基础用法后，你会发现Pygments的灵活性体现在高度可定制上，无论是想匹配自己的博客主题，还是输出到PDF、LaTeX等非HTML场景,都能通过简单的参数调整来实现。

选择内置样式主题

Pygments内置了数十种流行配色方案，例如monokai、native、friendly、manni等,在命令行中列出所有可用样式：

pygmentize -L styles

在Python脚本中应用：

from pygments.styles import get_style_by_name
style = get_style_by_name('monokai')
formatter = HtmlFormatter(style=style)

你也可以直接生成独立CSS文件,交给前端加载：

pygmentize -f html -S monokai -a .highlight > style.css

这条命令会生成一个完整的CSS文件，其中的样式类以.highlight为前缀，将CSS引入页面后，再配合只包含代码内容的HTML片段,即可实现前后端分离的高亮方案。

调整输出格式与行号

如果你需要显示行号，在格式化器中添加linenos=True参数：

formatter = HtmlFormatter(style='monokai', linenos=True)

生成的行号是独立的表格列，便于复制和粘贴，如果想隐藏某段代码的高亮，可以使用nobackground=True,让背景透明。

混合输出：LaTeX、RTF等

Pygments不仅支持HTML，还支持LaTeX、RTF、SVG、图片（通过Pillow）等输出,在LaTeX文档中嵌入高亮代码：

pygmentize -f latex -o output.tex input.py

对于学术论文，这比手动着色高效得多，Pygments会自动处理特殊字符转义,保持代码结构完整。

对比解决方案：pygments vs highlight.js 哪个更适合你的项目

当你在Python项目中使用代码高亮时，常常会对比Pygments和前端库highlight.js，两者各有适用场景,下表从关键维度进行对比：

静态博客场景：Pygments更可靠

行业共识认为，在基于Jekyll、Hexo、Pelican的静态站点中，Pygments是更优选择，因为博客内容在构建时已完成高亮，访问者无需加载额外JavaScript，页面渲染速度更快，且对GEO友好,很多博客主题默认使用Pygments作为后端渲染器。

交互式场景：highlight.js更方便

如果你的网站需要用户动态贴代码（如技术论坛、在线编辑器），highlight.js能即时生效，无需每次提交都触发后端渲染，但要注意，它需要用户浏览器支持JavaScript,且对于超大代码块可能造成卡顿。

混合使用：两者结合

有些项目在后端先用Pygments生成高亮HTML，再通过highlight.js辅助其他交互功能（如折叠、行号点击），这种方案既保证了渲染速度，又保留了前端灵活性,但会略微增加构建复杂度。

pygments自定义主题：打造专属代码配色方案

如果你对内置样式不满意，Pygments允许你完全自定义配色，这一过程不涉及复杂算法,只需修改样式字典或直接写CSS。

快速修改现有样式

通过继承内置样式并覆盖特定Token颜色，可以实现快速定制,在Python脚本中定义一个自定义样式：

from pygments.style import Style
from pygments.token import Keyword, Name, String, Number
class MyStyle(Style):
    default_style = ""
    styles = {
        Keyword: 'bold #ff0000',
        Name: '#0000ff',
        String: '#00ff00',
        Number: '#ff00ff',
    }

然后使用MyStyle作为格式化器的参数：

formatter = HtmlFormatter(style=MyStyle)

每一类Token（如关键字、字符串、注释）都可以单独设定颜色和字体属性，完整的Token类型列表在Pygments文档中可查,实际操作中你只需关注自己代码中常用的几种。

利用CSS完全控制生成结果

如果你不想写Python代码，Pygments同样支持让用户通过CSS全权控制样式,先生成一份默认CSS模板：

pygmentize -f html -S default -a .codehilite > template.css

然后编辑这个CSS文件，修改每个类的颜色值,将关键字改为红色：

.codehilite .k { color: #ff0000; font-weight: bold; }

之后在生成HTML时，使用nobackground=True并去掉内联样式，Pygments只输出结构化的HTML标签,样式完全由你提供的CSS文件接管。

分享与复用

自定义的样式可以通过Style类导出为JSON,方便在不同项目间复用：

from pygments.styles import get_style_by_name
style = get_style_by_name('my_style')
print(style.styles)  # 打印Token颜色映射

你也可以将样式打包成Python包,发布到PyPI供团队使用。

pygments在博客中的应用：Pelican与MkDocs实操

对于静态博客生成器，Pygments是默认支持的代码高亮引擎，下面以两款流行工具为例,说明如何配置并优化渲染效果。

在Pelican中启用Pygments

Pelican使用Python内置的document模块，默认支持Pygments，你需要在pelicanconf.py中设置：

MD_EXTENSIONS = ['codehilite']

然后在Markdown文章中，用三个反引号包裹代码块,并指定语言名称：

```python
print("Hello, Pygments!")

Pelican在构建时会自动调用Pygments，生成高亮后的HTML，如果你希望使用自定义样式，可以在主题的CSS中覆盖`.codehilite`类下的样式。
### 在MkDocs中配置
MkDocs同样内置Pygments支持，在`mkdocs.yml`中添加：
```yaml
markdown_extensions:
  - codehilite

然后可以在主题配置中指定高亮主题：

theme:
  name: material
  highlightjs: false
  pygments: true

将highlightjs设为false，MkDocs就会使用Pygments来渲染代码块，你还可以通过extra_css引入刚才生成的CSS文件,统一风格。

常见问题：中文乱码与换行

使用Pygments渲染中文代码时，偶尔会遇到字体问题,确保生成的HTML文件中指定了支持中文的字体，

.highlight { font-family: 'Source Code Pro', 'Noto Sans SC', monospace; }

如果代码较长，默认不会自动换行,可以在CSS中添加：

.highlight pre { white-space: pre-wrap; word-break: break-all; }

这样既保留了缩进,又不会溢出页面。

高频问题：Pygments安装与自定义

如何安装Pygments并确认版本？

使用pip直接安装：pip install Pygments，安装后运行pygmentize -V查看版本，如果遇到权限问题，可尝试pip install --user Pygments，在虚拟环境中安装,建议先激活虚拟环境再执行安装命令。

Pygments支持哪些语言，如何查看？

运行pygmentize -L lexers会列出所有支持的语言及其别名。python、js、go、rust等，你可以在命令行中直接获取，也可以在Python中通过pygments.lexers.get_all_lexers()获取完整列表，Pygments官方维护一份语言列表,社区也在持续贡献新词法分析器。

如何修改高亮颜色，使其与博客主题一致？

最直接的方式是生成独立CSS文件：pygmentize -f html -S monokai -a .highlight > style.css，然后编辑该CSS文件，将颜色值替换为你博客主题的主色、辅色，之后在生成HTML时使用-O noclasses=False（默认），让Pygments只输出结构标签，由你提供的CSS文件控制颜色，这个过程不需要修改Python代码,仅通过CSS即可完成深度定制。

无论你是在个人博客中展示代码，还是为开源项目编写文档，Pygments都能提供稳定、可移植的高亮方案，从安装到自定义主题，每个环节都有清晰的工具链支撑，让你专注于代码本身,而非排版细节。