在開(kāi)發(fā)工作中，我們經(jīng)常需要分享或歸檔 Python 腳本文件。.py 文件雖然在編輯器中可讀性強(qiáng)，但直接發(fā)送給他人時(shí)，缺乏格式統(tǒng)一、排版美觀，且打印體驗(yàn)不佳。尤其是在技術(shù)文檔、培訓(xùn)資料或項(xiàng)目報(bào)告中，將代碼轉(zhuǎn)換為 PDF 不僅便于閱讀，也能保證跨平臺(tái)展示效果一致。

Python 生態(tài)中有多種方式可以實(shí)現(xiàn)代碼轉(zhuǎn) PDF，而 Free Spire.Doc for Python 提供了穩(wěn)定、易用的方案。本文將介紹兩種常見(jiàn)的實(shí)現(xiàn)方法：普通文本方式和帶語(yǔ)法高亮的 HTML 插入方式，并詳細(xì)分析兩者的差異與使用場(chǎng)景。

1. 使用 Spire.Doc 將 Python 代碼按行寫(xiě)入 PDF

最簡(jiǎn)單的方法是將 .py 文件逐行讀取，并將每一行以固定字體插入到 PDF 中。這種方式適合不需要語(yǔ)法高亮，只希望保留原始代碼排版的場(chǎng)景。

from spire.doc import Document, FileFormat, BreakType, Color, LineSpacingRule, LineNumberingRestartMode

# 讀取 Python 文件
with open("Python.py", "r", encoding="utf-8") as f:
    python_code = f.read()

# 創(chuàng)建文檔對(duì)象
doc = Document()
section = doc.AddSection()
paragraph = section.AddParagraph()

# 逐行添加代碼
for line_number, line in enumerate(python_code.split("\n")):
    tr = paragraph.AppendText(line)
    tr.CharacterFormat.FontName = "Courier New"  # 設(shè)置等寬字體
    tr.CharacterFormat.FontSize = 10.5
    if line_number < len(python_code.split("\n")) - 1:
        paragraph.AppendBreak(BreakType.LineBreak)

# 可選格式設(shè)置
paragraph.Format.BackColor = Color.get_WhiteSmoke()  # 背景色
paragraph.Format.LineSpacingRule = LineSpacingRule.Multiple
paragraph.Format.LineSpacing = 14.0

# 行號(hào)設(shè)置
section.PageSetup.LineNumberingStartValue = 1
section.PageSetup.LineNumberingStep = 1
section.PageSetup.LineNumberingRestartMode = LineNumberingRestartMode.RestartPage
section.PageSetup.LineNumberingDistanceFromText = 12.0

# 保存為 PDF
doc.SaveToFile("output/Python-PDF.pdf", FileFormat.PDF)

轉(zhuǎn)換結(jié)果：

說(shuō)明與優(yōu)化點(diǎn)：

• 字體選擇：使用等寬字體（如 Courier New）保證代碼對(duì)齊整齊。
• 行間距：設(shè)置多倍行距可提高可讀性。
• 背景色與行號(hào)：輕微灰色背景搭配行號(hào)，更適合打印或閱讀。

這種方式的優(yōu)勢(shì)在于實(shí)現(xiàn)簡(jiǎn)單，代碼結(jié)構(gòu)完全保留，兼容性高，但缺點(diǎn)是無(wú)法提供語(yǔ)法高亮效果，對(duì)于較長(zhǎng)或復(fù)雜代碼可讀性稍差。

2. 使用 Pygments 生成帶語(yǔ)法高亮的 PDF

如果希望 PDF 中的代碼帶顏色區(qū)分關(guān)鍵字、注釋、字符串等，可以先使用 Pygments 將 Python 代碼轉(zhuǎn)換為 HTML，再通過(guò) Spire.Doc 將 HTML 插入 PDF。

from spire.doc import Document, FileFormat
from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter

def py_to_inline_html(py_file_path):
    with open(py_file_path, "r", encoding="utf-8") as f:
        code = f.read()
    # 生成行內(nèi) HTML，帶行號(hào)
    formatter = HtmlFormatter(noclasses=True, linenostart=1, linenos='inline')
    return highlight(code, PythonLexer(), formatter)

html_result = py_to_inline_html("Python.py")

doc = Document()
section = doc.AddSection()
paragraph = section.AddParagraph()
paragraph.AppendHTML(html_result)

# 保存帶高亮的 PDF
doc.SaveToFile("output/Python-PDF-Highlighted.pdf", FileFormat.PDF)

轉(zhuǎn)換結(jié)果：

關(guān)鍵說(shuō)明：

• HtmlFormatter(noclasses=True, linenos='inline')：生成內(nèi)聯(lián)樣式 HTML，并帶行號(hào)。
• AppendHTML 方法可以直接將 HTML 內(nèi)容插入到 PDF，保留語(yǔ)法高亮效果。
• 使用這種方法生成的 PDF 更美觀，適合演示文檔、教程或培訓(xùn)資料。

3. 兩種方法的對(duì)比與使用建議

總結(jié)來(lái)看，如果對(duì)語(yǔ)法高亮要求不高，按行插入文本即可；如果希望 PDF 更美觀、可讀性高，HTML 高亮方式更合適。

4. 擴(kuò)展說(shuō)明

• 合并重復(fù)操作：在按行插入的方式中，背景色、行距、字體等可封裝為函數(shù)，避免重復(fù)設(shè)置，提高代碼復(fù)用性。
• 代碼排版與打印：PDF 是固定排版格式的文檔，將 Python 代碼導(dǎo)出后可確保不同環(huán)境中顯示一致，避免字體或縮進(jìn)混亂。
• 批量處理：可將以上方法封裝為函數(shù)，循環(huán)處理多個(gè) .py 文件，實(shí)現(xiàn)批量生成 PDF，適合團(tuán)隊(duì)協(xié)作或項(xiàng)目文檔歸檔。

總結(jié)

本文介紹了兩種將 Python 腳本轉(zhuǎn)換為 PDF 的方法：一種是按行插入文本，另一種是通過(guò) HTML 生成語(yǔ)法高亮效果。前者簡(jiǎn)單高效，適合快速歸檔；后者美觀專(zhuān)業(yè)，適合文檔和演示場(chǎng)景。通過(guò)掌握 Spire.Doc 的 AppendText 和 AppendHTML 方法，以及 Pygments 的 HTML 轉(zhuǎn)換能力，可以輕松生成結(jié)構(gòu)清晰、可讀性強(qiáng)的 Python PDF 文檔。

無(wú)論是個(gè)人筆記整理、項(xiàng)目文檔歸檔，還是教學(xué)演示，這兩種方法都能滿(mǎn)足不同需求，提高代碼分享和管理的效率，同時(shí)保留排版美觀性。

以上就是使用Python將.py文件轉(zhuǎn)換為PDF并實(shí)現(xiàn)語(yǔ)法高亮的詳細(xì)內(nèi)容，更多關(guān)于Python.py文件轉(zhuǎn)PDF并高亮的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論