Python中如何使用pypandoc進行格式轉換操作

更新時間：2025年04月01日 16:40:04 作者：偷藏星星的老周

這篇文章主要介紹了Python中如何使用pypandoc進行格式轉換操作,pypandoc是一個強大的文檔轉換工具,它可以將各種標記語言轉換為不同的格式,支持多種輸入和輸出格式,并允許用戶添加自定義樣式、模板和過濾器

1.環(huán)境準備

首先，我們需要安裝必要的工具：安裝必要的庫

pip install python-pandoc pypandoc watchdog
注意：需要先在系統中安裝pandoc注意：需要先在系統中安裝pandoc
Windows: choco install pandoc
Mac: brew install pandoc
Linux: sudo apt-get install pandoc

小貼士：確保系統中已經安裝了pandoc，否則Python包無法正常工作

2.基礎轉換器實現

讓我們先創(chuàng)建一個基礎的文檔轉換類：

import pypandoc
import os
from typing import List, Dict
class DocumentConverter:
def \_\_init\_\_(self):
self.supported\_formats =
 {'input': \['md', 'docx', 'html', 'tex', 'epub'\],'output': \['pdf', 'docx', 'html', 'md', 'epub'\]}
def convert\_document(
self, input\_path: str, output\_path: str,extra\_args: List\[str\] = None) -> bool:
"""
轉換單個文檔
"""
try:input\_format = self.\_get\_file\_format(input\_path)
output\_format = self.\_get\_file\_format(output\_path)
if not self.\_validate\_formats(input\_format, output\_format):
print(f"不支持的格式轉換: {input\_format} -> {output\_format}")
return False
# 設置轉換參數
args = extra\_args or \[\]
# 執(zhí)行轉換
output = pypandoc.convert\_file(
input\_path,
output\_format,
outputfile=output\_path,
extra\_args=args)
print(f"成功轉換: {input\_path} -> {output\_path}")
return True
except Exception as e:
print(f"轉換失敗: {str(e)}")
return False
def \_get\_file\_format(self, file\_path: str) -> str:
"""獲取文件格式"""
return file\_path.split('.')\[-1\].lower()
def \_validate\_formats(self, input\_format: str, output\_format: str) -> bool:
 """驗證格式是否支持"""
return (input\_format in self.supported\_formats\['input'\] and 
output\_format in self.supported\_formats\['output'\])

3.增強功能批量轉換

讓我們添加批量轉換功能：

class BatchConverter(DocumentConverter):  
def \_\_init\_\_(self): super().\_\_init\_\_()  
self.conversion\_stats = {'success': 0,'failed': 0,'skipped': 0}  
def batch\_convert(
self,input\_dir: str,output\_dir: str,target\_format: str,recursive: bool = True):  
"""批量轉換文檔"""  
# 確保輸出目錄存在  
os.makedirs(output\_dir, exist\_ok=True)  
# 收集所有需要轉換的文件  
files\_to\_convert = \[\]if recursive:  
for root, \_, files in os.walk(input\_dir):  
for file in files:files\_to\_convert.append(os.path.join(root, file))  
else:  
files\_to\_convert = \[os.path.join(input\_dir, f)  
for f in os.listdir(input\_dir)if os.path.isfile(os.path.join(input\_dir, f))\]  
# 執(zhí)行轉換  
for input\_file in files\_to\_convert:input\_format = self.\_get\_file\_format(input\_file)  
# 檢查是否是支持的輸入格式  
if input\_format not in self.supported\_formats\['input'\]:  
print(f"跳過不支持的格式: {input\_file}")  
self.conversion\_stats\['skipped'\] += 1  
continue  
# 構建輸出文件路徑  
rel\_path = os.path.relpath(input\_file, input\_dir)output\_file = os.path.join
(output\_dir,os.path.splitext(rel\_path)\[0\] + f".{target\_format}")  
# 確保輸出目錄存在  
os.makedirs(os.path.dirname(output\_file), exist\_ok=True)  
# 執(zhí)行轉換  
if self.convert\_document(input\_file, output\_file):  
self.conversion\_stats\['success'\] += 1  
else:  
self.conversion\_stats\['failed'\] += 1  
return self.conversion\_stats

4.高級功能自定義轉換選項

class AdvancedConverter(BatchConverter):
def \_\_init\_\_(self):
super().\_\_init\_\_()
self.conversion\_options = {'pdf': \['--pdf-engine=xelatex','--variable', 'mainfont=SimSun'  # 中文支持\],
'docx': \['--reference-doc=template.docx'  # 自定義模板\],
'html': \['--self-contained',  # 獨立HTML文件'--css=style.css'    # 自定義樣式\]}
def convert\_with\_options(
self,input\_path: str,output\_path: str,options: Dict\[str, str\] = None):
"""使用自定義選項進行轉換"""
output\_format = self.\_get\_file\_format(output\_path)
# 合并默認選項和自定義選項
args = self.conversion\_options.get(output\_format, \[\]).copy()
if options:
for key, value in options.items():args.extend(\[f'--{key}', value\])
return
self.convert\_document(input\_path, output\_path, args)

實際應用示例

讓我們來看看如何使用這個轉換工具：

if \_\_name\_\_ == "\_\_main\_\_":  
# 創(chuàng)建轉換器實例  
converter = AdvancedConverter()  
# 單個文件轉換示例  
converter.convert\_document("我的文檔.md","輸出文檔.pdf")  
# 批量轉換示例  
stats = converter.batch\_convert("源文檔目錄","輸出目錄","pdf",recursive=True)  
# 使用自定義選項轉換  
custom\_options = {
'toc': '',  # 添加目錄
'number-sections': '',  # 添加章節(jié)編號  
'highlight-style': 'tango'  # 代碼高亮樣式}  
converter.convert\_with\_options(  
"技術文檔.md",  
"漂亮文檔.pdf",  
custom\_options)  
# 輸出轉換統計  
print("\\n轉換統計:")  
print(f"成功: {stats\['success'\]}個文件")  
print(f"失敗: {stats\['failed'\]}個文件")  
print(f"跳過: {stats\['skipped'\]}個文件")