当前位置： 技术文章>> 如何在 Python 中使用 FPDF 生成 PDF 文档？

文章标题：如何在 Python 中使用 FPDF 生成 PDF 文档？
  • 文章分类: 后端
  • 6736 阅读

在Python中，使用FPDF库生成PDF文档是一项高效且灵活的任务，它允许开发者以编程方式创建格式化的PDF文件，无需依赖外部软件或图形界面。FPDF（Free PDF）是一个流行的Python库，专为生成PDF文件而设计，具有易于学习和使用的API。下面，我们将详细探讨如何在Python项目中集成FPDF库，并通过一系列示例来展示其强大功能。

安装FPDF

首先，你需要在你的Python环境中安装FPDF库。这可以通过pip命令轻松完成：

pip install fpdf

安装完成后，你就可以在你的Python脚本中导入FPDF类并开始创建PDF文档了。

基础使用

导入FPDF并创建PDF对象

在你的Python脚本中，首先需要导入FPDF类。然后，你可以创建一个FPDF类的实例，这个实例将作为你创建PDF文档的“画笔”。

from fpdf import FPDF

# 创建一个PDF对象
pdf = FPDF()

添加页面

默认情况下，FPDF会创建一个A4大小的页面，但你可以通过调用add_page()方法手动添加更多页面，并可以指定页面的大小和方向。

# 添加一个默认大小的页面
pdf.add_page()

# 添加一个自定义大小的页面（例如，宽度190mm，高度277mm）
pdf.add_page(format='A3')

# 添加一个横向页面
pdf.add_page(orientation='L')

设置字体和大小

在添加文本之前，你可能需要设置字体和字体大小。FPDF支持几种内置字体，但你也可以通过扩展库来添加更多字体。

# 设置字体
pdf.set_font("Arial", size=12)

# 注意：如果使用了非内置字体，需要先通过add_font方法添加字体
# 例如：pdf.add_font('DejaVu', '', 'path_to_font.ttf', uni=True)

添加文本

添加文本到PDF页面是一个直接的过程，你可以使用cell()方法或者multi_cell()方法来添加单行或多行文本。

# 添加单行文本
pdf.cell(200, 10, txt="Hello, FPDF!", ln=True, align='C')

# 添加多行文本，自动换行
pdf.set_font("Arial", size=10)
pdf.multi_cell(200, 10, txt="这是一个多行文本示例。\n请注意，当文本达到边界时，它会自动换行。")

进阶功能

绘制线条和形状

FPDF也支持绘制基本图形，如线条、矩形和圆形。

# 绘制线条
pdf.line(10, 20, 100, 20)  # 从(10, 20)到(100, 20)

# 绘制矩形
pdf.rect(10, 40, 90, 20, fill=False)  # 不填充的矩形
pdf.rect(10, 70, 90, 20, fill=True)  # 填充的矩形

# 绘制圆形（实际上是椭圆形，但长宽相同时即为圆形）
pdf.ellipse(100, 100, 40, 20)  # 椭圆
pdf.ellipse(150, 100, 20, 20)  # 圆形

插入图像

FPDF支持在PDF中插入图像，但需要注意图像格式和路径。

# 插入图像
# 注意：图像路径可以是相对路径或绝对路径
pdf.image('logo.png', x=10, y=120, w=50)

设置页眉和页脚

虽然FPDF没有直接设置页眉和页脚的函数，但你可以通过重写header()和footer()方法来自定义它们。

class MyPDF(FPDF):
    def header(self):
        # 自定义页眉
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, '页眉文本', 0, 1, 'C')

    def footer(self):
        # 自定义页脚
        self.set_y(-15)
        self.set_font('Arial', 'I', 8)
        self.cell(0, 10, '页码: ' + str(self.page_no()), 0, 0, 'C')

# 使用自定义的PDF类
pdf = MyPDF()
pdf.add_page()
pdf.set_font("Arial", size=12)
pdf.cell(200, 10, txt="这是一个带有自定义页眉和页脚的PDF示例。", ln=True, align='C')
pdf.output('example_with_header_footer.pdf')

输出PDF

完成所有内容的添加后，你需要将PDF对象的内容输出到文件中。这可以通过调用output()方法来实现。

# 将PDF输出到文件
pdf.output('example.pdf')

整合与扩展

FPDF的强大之处在于其灵活性和可扩展性。通过继承FPDF类并添加自定义方法，你可以创建满足特定需求的PDF生成器。此外，还有许多扩展库（如FPDF_Unicode、FPDF_merge等）可用于增强FPDF的功能，比如支持Unicode字符、合并PDF文件等。

总结

在Python中使用FPDF库生成PDF文档是一个既高效又灵活的选择。通过简单的API调用，你可以轻松创建包含文本、图像、线条和形状的PDF文件。此外，FPDF的扩展性和自定义能力使其成为处理PDF生成任务的强大工具。在实际应用中，你可以根据自己的需求调整FPDF的使用方式，甚至通过继承FPDF类来创建自己的PDF生成器类。

希望这篇文章能帮助你更好地理解和使用FPDF库来在Python中生成PDF文档。如果你在探索FPDF的过程中遇到任何问题，不妨访问我的码小课网站，那里可能有更多关于FPDF的教程和示例代码，可以帮助你更快地掌握这一技能。

推荐文章