极速转换，4步学会用Python将HTML转换成PDF

原创已于 2024-01-20 09:45:44 修改 · 3.1k 阅读

27 ·

CC 4.0 BY-SA版权

文章标签：

#python #html #pdf #Python编程 #Python学习 #开发语言

于 2023-12-18 17:30:03 首次发布

本文介绍了如何使用Python的pdfkit库将HTML内容转换为PDF，包括设置项目、编写转换代码、示例实现和单元测试的编写，确保代码的可靠性和实用性。

一、简介

在Web开发和报告任务中，将HTML内容转换为PDF是一种常见需求。Python作为一个庞大的生态系统，提供了各种库来完成这个任务。在这里我将指导你完成使用Python将HTML转换为PDF的过程，包括一个示例实现和一个单元测试。我们将使用pdfkit库，该库是wkhtmltopdf命令行工具的Python封装。

二、前提条件

要开始学习，需要：

在系统中已安装Python。可以从Python官方网站（https://www.python.org/）下载。
使用pip安装pdfkit库：

pip install pdfkit

wkhtmltopdf，pdfkit依赖于它。可以从wkhtmltopdf的网站（https://wkhtmltopdf.org/）下载。
一个测试库unittest，它包含在Python的标准库中。

三、具体步骤

步骤1：设置项目

为项目创建一个新目录。
创建一个用于PDF转换代码的Python文件，例如html_to_pdf.py。
可选择为测试创建一个单独的目录。

步骤2：编写HTML到PDF转换代码

在html_to_pdf.py中，编写以下函数：

import pdfkit

def convert_html_to_pdf(source_html, output_filename):
    pdfkit.from_string(source_html, output_filename)
    return output_filename

这个函数convert_html_to_pdf，以字符串形式接收HTML内容和输出文件名，然后使用pdfkit生成一个PDF文件。

步骤3：创建使用示例

创建一个示例来演示转换：

# example.py
from html_to_pdf import convert_html_to_pdf

html_content = "
Hello World
"
pdf_filename = "output.pdf"

convert_html_to_pdf(html_content, pdf_filename)

运行example.py将把指定的HTML内容转换为名为output.pdf的PDF文件。

步骤4：编写单元测试

创建一个测试文件test_html_to_pdf.py：

import unittest
import os
from html_to_pdf import convert_html_to_pdf

class TestHtmlToPdf(unittest.TestCase):
    def test_html_to_pdf_conversion(self):
        html_content = "
Test PDF

"
        output_filename = "test.pdf"

        result = convert_html_to_pdf(html_content, output_filename)
        
        self.assertTrue(os.path.exists(result))
        self.assertEqual(result, output_filename)
        
        # 清理
        os.remove(output_filename)

if __name__ == '__main__':
    unittest.main()