Python实现将.py代码转换为带语法高亮的Word和PDF_Python

在创建技术文档、报告或培训材料时，开发者经常需要在文档中插入带有语法高亮的 python 代码。尽管 microsoft word 和 pdf 格式本身并不支持语法高亮，但借助 python 库，我们可以轻松生成格式良好的文档，保留代码的结构、颜色和样式。本指南介绍了几种将 python 代码转换为 word 和 pdf 文档的方法，确保您的代码易于阅读，并且以专业的方式呈现。

为什么 python 代码需要语法高亮

语法高亮对于提高源代码的可读性至关重要。通过使用不同的颜色区分关键字、变量、字符串和注释等元素，语法高亮帮助读者快速识别和理解代码的结构和逻辑。无论您是在编写文档、教程，还是报告，保留语法高亮可以确保您的 python 代码清晰易懂，易于访问。

前提条件

在使用本指南中的任何方法之前，请确保您已安装所需的 python 包。这些库将帮助生成带语法高亮的代码并处理文档：

pygments - 语法高亮库。
spire.doc - 用于处理 word 文档的 python 库。
pillow（仅限方法 3） - 处理图像的库。

您可以使用 pip 安装所需的库：

pip install pygments
pip install spire.doc
pip install pillow # 仅方法 3 需要

安装完前提条件后，您就可以开始使用以下方法将 python 代码转换为带语法高亮的格式化 word 或 pdf 文档了。

将 python 代码转换为带语法高亮的 word 和 pdf 的方法

在本节中，我们将介绍几种将 python 代码以语法高亮的方式嵌入到 word 或 pdf 文档中的方法：

方法 1： 将 python 代码转换为 rtf 格式并保存为 word。
方法 2： 将 python 代码转换为 html 格式并保存为 word。
方法 3： 将 python 代码导出为图像并插入到 word 中。
方法 4（可选）： 将 python 代码保存为 pdf。

每种方法都有其优点和适用场景，您可以根据需求选择最合适的方法。

方法 1：将 python 代码转换为 rtf 并保存为 word

此方法使用 pygments 将 python 代码转换为 rtf 格式，接着将其加载到 spire.doc 中并保存为 word 文档。它提供了一种简单可靠的方式来创建带语法高亮的 word 文档。

使用场景：

需要在 word 中插入可编辑的 python 代码。
希望采用简单的方式，设置最少。

优点：

代码在 word 中完全可编辑。
清晰的语法高亮。
可靠的报告和文档格式。

示例代码：

from pygments import highlight
from pygments.lexers import pythonlexer
from pygments.formatters import rtfformatter
from spire.doc import *

# 定义 python 代码
code = """
def greet(name):
    print("hello, " + name)
"""

# 将代码转换为带语法高亮的 rtf 字符串
rtf_text = highlight(code, pythonlexer(), rtfformatter())

# 创建 spire.doc 文档对象
doc = document()

# 添加段落
para = doc.addsection().addparagraph()

# 将 rtf 字符串添加到段落
para.appendrtf(rtf_text)

# 将文档保存为 word docx 格式
doc.savetofile("highlightedcode.docx", fileformat.docx2016)
doc.close()

方法 2：将 python 代码转换为 html 并保存为 word

此方法通过将 python 代码转换为带语法高亮的 html 格式，并将其保存为 word 文档，为格式提供更多控制。适合需要更精细布局、字体和间距控制的情况。

使用场景：

需要在格式上使用 css 控制。
想要包含多个代码块。

优点：

完全控制代码的布局和样式。
支持文档中的多个代码块。
适合文章和手册。

示例代码：

from pygments import highlight
from pygments.lexers import pythonlexer
from pygments.formatters import htmlformatter
from spire.doc import *

# 定义 python 代码
code = """
def greet(name):
    print("hello, " + name)
"""

# 将代码转换为带语法高亮的 html 字符串
html_text = highlight(code, pythonlexer(), htmlformatter(full=true))

# 创建 spire.doc 文档对象
doc = document()

# 添加段落
para = doc.addsection().addparagraph()

# 将 html 字符串添加到段落
para.appendhtml(html_text)

# 保存为 word docx 格式
doc.savetofile("highlightedcode.docx", fileformat.docx2016)
doc.close()

方法 3：将 python 代码导出为图像并插入到 word

此方法将 python 代码转换为带语法高亮的高质量图像，并将图像插入到 word 文档中。该方法提供最佳的视觉效果，适合用于教程和书籍。

使用场景：

需要最佳的视觉质量。
不需要在 word 中编辑代码。

优点：

视觉效果最一致，呈现最佳。
看起来像从 ide 截取的屏幕截图。

示例代码：

from pygments import highlight
from pygments.lexers import pythonlexer
from pygments.formatters import imageformatter
from spire.doc import *

# 定义 python 代码
code = """
def greet(name):
    print("hello, " + name)
"""

# 将 python 代码转换为带语法高亮的图像
img_bytes = highlight(code, pythonlexer(), imageformatter(font_name="consolas"))

# 保存图像
with open("highlight.png", "wb") as f:
    f.write(img_bytes)

# 创建文档对象
doc = document()

# 添加段落
para = doc.addsection().addparagraph()

# 将图像添加到段落
para.appendpicture("highlight.png")

# 保存为 word docx 格式
doc.savetofile("highlightedcode.docx", fileformat.docx2016)
doc.close()

方法 4：将 python 代码保存为 pdf

如果您希望以 pdf 格式共享 python 代码，spire.doc 可以通过一行代码轻松将高亮代码转换为 pdf。

使用场景：

需要将带语法高亮的 python 代码分享或发布为 pdf 格式。

优点：

保留格式、高亮和布局。
非常适合发布、分享或打印。

示例代码：

# 保存为 pdf 
doc.savetofile("highlightedcode.pdf", fileformat.pdf)

选择最适合您的方法

为了帮助您决定哪种方法最适合您的需求，以下是每种选项的比较，基于输出类型、可编辑性和视觉质量等关键因素：

方法	输出类型	可编辑性	视觉质量	最适合用途
python → rtf → docx	文本	✔ 可编辑	良好	报告、文档
python → html → docx	文本	✔ 可编辑	非常好	文章、手册
python → image → docx	png	✘ 不可编辑	卓越	教程、书籍、博客
python → pdf	pdf	✘ 不可编辑	非常好	分享、打印