pdf生成：wkhtmltopdf

news2025/8/9 17:10:24

wkhtmltopdf 是开源（LGPLv3）命令行工具，使用Qt WebKit渲染引擎将HTML渲染为PDF和各种图像格式。这些完全以“headless”模式运行，不需要显示或显示服务 wkhtmltoimage。

建议：

不要将wkhtmltopdf与任何不受信任的HTML一起使用 - 请确保对用户提供的HTML/JS进行清理，否则可能会完全接管其运行的服务器！请考虑使用强制访问控制系统，如AppArmor或SELinux，请参阅建议的 AppArmor 策略。
如果您正在使用它生成报告（即使用您控制的HTML），也可以考虑使用 WeasyPrint 或商业工具Prince – 请注意 –请注意，我不属于这两个项目，请尽您的努力。
如果您 使用它来 转换使用动态JS的网站，请考虑使用 puppeteer 或它拥有的众多wrappers之一。

pdfkit是python对wkhtmltopdf这个把网页转成pdf工具的一个封装，必须得先安装一个wkhtmltopdf ( wkhtmltopdf )，根据自己的操作系统下载对应的版本即可。不要忘记它的安装目录。

一、Ubuntu安装Python pdfkit：

1、下载对应版本的wkhtmltopdf deb包 wkhtmltopdf

查看系统版本

2、sudo dpkg -i *.deb，如果报依赖错误执行下面语句再试sudo apt-get -f --fix-missing install

3、使用 which wkhtmltopdf检查是否安装成功，输出结果为：/usr/local/bin/wkhtmltopdf

4、安装pdfkit库 pip install pdfkit

二、wkhtmltopdf参数

General Options:
      --collate                       Collate when printing multiple copies  打印多份时进行校对
      --copies <number>               Number of copies to print into the pdf file (default 1)  要打印到pdf的副本数
      --extended-help                 Display more extensive help, detailing less common command switches
  -h, --help                          Display help
  -O, --orientation <orientation>     Set orientation to Landscape or Portrait  将方向设置为横向或纵向 
  -s, --page-size <size>              Set paper size to: A4, Letter, etc.     将纸张大小设置为：A4、Letter等。
      --password <password>           HTTP Authentication password   HTTP身份验证密码
  -p, --proxy <proxy>                 Use a proxy    使用代理
  -q, --quiet                         Be less verbose
      --username <username>           HTTP Authentication username  HTTP身份验证用户名
  -V, --version                       Output version information an exit   将版本信息输出到出口

三、pdfkit使用

给它一个url，它会自动获取url里的内容，帮你保存为pdf；给它一个html文件或者字符串，也可以保存为pdf文件。

import pdfkit

confg = pdfkit.configuration(wkhtmltopdf="/usr/local/bin/wkhtmltopdf")  # wkhtmltopdf的安装路径
options = {
    'page-size': 'A4',
    'encoding':"UTF-8",
    'enable-local-file-access': True  # 是否允许wkhtmltopdf访问本地资源，默认值为False。不加这行会报错 Exit with code 1 due to network error: ProtocolUnknownError
    'margin-top':'0.75in',
    'margin-right':'0.75in',
    'margin-bottom':'0.75in',
    'margin-left':'0.75in',
    'no-outline':None,       # 为None时表示确定，则不生成目录
    'header-line':None,      # 为None时表示确定，生成页眉下的线
    'header-spacing':'3',    # 设置页眉与正文之间的距离，单位是毫米
    'header-right':'Quality Report', # 设置页眉右侧数据
　　'header-font-size':10,   # 设置页眉字体大小
    # 'header-html': HEADER_PATH,    # 设置页眉数据，作为页眉的html页面必须有<!DOCTYPE html>
    # 'footer-html': FOOTER_PATH,
    'footer-font-size':10,   # 设置页脚字体大小
    # 'allow': ACESS_PATH,
    'animation':False,       # 导出PDF一定要设置，否则显示不全（关闭图表动画）
}

# 这个函数是从url里面获取内容， 这有3个参数，第一个是url或url列表，第二个是文件名，第三个就是khtmltopdf的路径， 返回值：成功返回True
url_list = ["https://www.cnblogs.com/mianbaoshu/p/13366074.html", "https://www.bbsmax.com/A/KE5Qj4G4dL/"]
pdfkit.from_url(url_list, 'url.pdf', options=options, configuration=confg)

# from_file这个函数是从文件里面获取内容，这有3个参数，第一个是一个html文件或html文件列表，第二个是文生成的pdf的名字，第三个就是khtmltopdf的路径。可以使用参数cover来设置pdf封面
pdfkit.from_file(['my.html', ], 'html.pdf', options=options, configuration=confg，cover='http://localhost:8080/static/data/pdfHeader.html')

# from_string这个函数是从一个字符串里面获取内容，这有3个参数，第一个是一个字符串，第二个是文生成的pdf的名字，第三个就是khtmltopdf的路径
html='''
        <div>
            <h1>title</h1>
            <p>content</p>
        </div>'''
pdfkit.from_string(html,'string.pdf', options=options, configuration=confg)

html中带css、png： 设置参数'enable-local-file-access': True

import pdfkit

file = "固件详情.html"

confg = pdfkit.configuration(wkhtmltopdf="/usr/local/bin/wkhtmltopdf")
wkhtmltopdf_options = {
    'enable-local-file-access': True  # 是否允许wkhtmltopdf.exe访问本地资源，默认值为False。不加这行会报错 Exit with code 1 due to network error: ProtocolUnknownError
}
pdfkit.from_file(file, 'html.pdf', configuration=confg, options=wkhtmltopdf_options)