Python-PDFKit: HTML 转 PDF 封装器
Python 2 和 3 的 wkhtmltopdf 工具封装器使用了Webkit，且是由ruby PDFKit改造而来的。
安装
- 安装 python-pdfkit:
$ pip install pdfkit (or pip3 for python3)
- 安装 wkhtmltopdf:
- Debian/Ubuntu:
$ sudo apt-get install wkhtmltopdf
- macOS:
$ brew install caskroom/cask/wkhtmltopdf
警告！Debian/ubuntu repos中的版本减少了这样一些功能(因为它没有wkhtmltopdf Qt补丁就直接编译了)，比如添加轮廓、页眉、页脚、TOC等。要使用此选项，得在这里安装静态二进制文件 wkhtmltopdf ，或者可以用这个描述文件.
- Windows和其他选项：检查 wkhtmltopdf主页里的二进制程序
用法
简单使用:
import pdfkit
pdfkit.from_url('http://google.com', 'out.pdf')
pdfkit.from_file('test.html', 'out.pdf')
pdfkit.from_string('Hello!', 'out.pdf')
可以使用网址或文件的列表作为传递的参数:
pdfkit.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.pdf')
pdfkit.from_file(['file1.html', 'file2.html'], 'out.pdf')
也可以传入文件对象 opened file:
with open('file.html') as f:
pdfkit.from_file(f, 'out.pdf')
If you wish to further process generated PDF, you can read it to a variable:
# 如果不想输出路径，那么可以使用false参数，将pdf保存到变量中。
pdf = pdfkit.from_url('http://google.com', False)
你可以查看所有的wkhtmltopdf 设置参数.
你可以在选项名中写上“—”。如果选项没有值，则将None、False或* " *用于dict value:。对于可重复选项(包括 allow, cookie, custom-header, post, postfile, run-script, replace)，您可以使用列表或元组。使用需要多个值的选项(例如:custom-header认证秘钥)，我们可以使用一个双元组(参见下面的示例)。
options = {
'page-size': 'Letter',
'margin-top': '0.75in',
'margin-right': '0.75in',
'margin-bottom': '0.75in',
'margin-left': '0.75in',
'encoding': "UTF-8",
'custom-header' : [
('Accept-Encoding', 'gzip')
]
'cookie': [
('cookie-name1', 'cookie-value1'),
('cookie-name2', 'cookie-value2'),
],
'no-outline': None
}
pdfkit.from_url('http://google.com', 'out.pdf', options=options)
默认情况下， PDFKit 会显示所有的wkhtmltopdf 输出。不想要的话, 要在设置里传入quiet :
options = {
'quiet': ''
}
pdfkit.from_url('google.com', 'out.pdf', options=options)
由于wkhtmltopdf命令语法，必须单独指定** TOC 和 Cover **选项。 如果您在TOC之前需要加封面，请使用cover_first选项：
toc = {
'xsl-style-sheet': 'toc.xsl'
}
cover = 'cover.html'
pdfkit.from_file('file.html', options=options, toc=toc, cover=cover)
pdfkit.from_file('file.html', options=options, toc=toc, cover=cover, cover_first=True)
使用css选项转换文件或字符串时，可以指定外部CSS文件。
Warning 对于wkhtmltopdf里面的 这个 bug 有一个变通的办法。可以先尝试--user-style-sheet 选项。
# Single CSS file
css = 'example.css'
pdfkit.from_file('file.html', options=options, css=css)
# Multiple CSS files
css = ['example.css', 'example2.css']
pdfkit.from_file('file.html', options=options, css=css)
也可以传递HTML的元标签:
body = """
<html>
<head>
<meta name="pdfkit-page-size" content="Legal"/>
<meta name="pdfkit-orientation" content="Landscape"/>
</head>
Hello World!
</html>
"""
pdfkit.from_string(body, 'out.pdf') #with --page-size=Legal and --orientation=Landscape
配置
每个API调用都采用可选的配置参数。 这应该是pdfkit.configuration（）API调用的一个实例. 它将配置选项作为初始参数。 可用选项包括：
-
wkhtmltopdf-wkhtmltopdf二进制文件的位置. 默认情况下pdfkit会使用which(UNIX) 或者where(Windows)来定位文件。 -
meta_tag_prefix-pdfkit特定元标记的前缀 - 默认情况下为pdfkit -。
实例 - 当 wkhtmltopdf 不在 $PATH上:
config = pdfkit.configuration(wkhtmltopdf='/opt/bin/wkhtmltopdf')
pdfkit.from_string(html_string, output_file, configuration=config)
故障排除
-
IOError: 'No wkhtmltopdf executable found':确保在$ PATH中有wkhtmltopdf或通过自定义配置设置（参见上一节）。
where wkhtmltopdf（Windows） 或者which wkhtmltopdf（Linux） 应当能返回二进制路径。 -
IOError: 'Command Failed'此错误意味着PDFKit无法处理输入。您可以尝试从错误消息直接运行命令，并查看哪些错误导致了失败(在某些wkhtmltopdf版本上，这可能是由于分段错误造成的)，从而使用Webkit将HTML转换为PDF。
