Python FPDF 手把手教程

介绍

在进行数据可视化或生成报告时，经常需要将数据转换为 PDF 格式。Python 提供了一个强大而灵活的库，即 FPDF（完全支持 Unicode 编码的 PDF 类库）。FPDF 允许我们通过编写 Python 代码来创建 PDF 文件，无论是简单的文本文档还是复杂的报告，都可以轻松生成。

本教程将带您深入了解使用 FPDF 库生成 PDF 文件的基本知识。我们将介绍 FPDF 的安装过程，并提供一些示例代码帮助您了解如何使用 FPDF。

安装

要安装 FPDF 库，我们可以使用 pip 包管理器。打开终端或命令提示符，并运行以下命令：

pip install fpdf

以上命令将自动下载并安装 FPDF 库。

HelloWorld 示例

让我们从一个简单的 HelloWorld 示例开始，以帮助您了解 FPDF 的基本用法。创建一个名为 hello_world.py 的文件，并通过以下代码保存：

from fpdf import FPDF

class PDF(FPDF):
    def header(self):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, 'Hello World', 1, 1, 'C')

    def footer(self):
        self.set_y(-15)
        self.set_font('Arial', 'I', 8)
        self.cell(0, 10, 'Page %s' % self.page_no(), 0, 0, 'C')

    def chapter_title(self, title):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, title, 0, 1, 'L')

    def chapter_body(self, body):
        self.set_font('Arial', '', 12)
        self.multi_cell(0, 10, body)

pdf = PDF()
pdf.add_page()
pdf.chapter_title('Chapter 1')
pdf.chapter_body('This is the content of chapter 1.')

pdf.add_page()
pdf.chapter_title('Chapter 2')
pdf.chapter_body('This is the content of chapter 2.')

pdf.output('hello_world.pdf')

保存并运行此代码，将生成一个名为 hello_world.pdf 的 PDF 文件。打开该文件，您将看到标题为 “Hello World” 的页眉，包含两个章节的内容：Chapter 1 和 Chapter 2。

让我们逐行解释上述代码：

我们首先导入 FPDF 类。
然后，我们创建一个名为 PDF 的新类，继承自 FPDF 类。
在 PDF 类中，我们定义了一些方法，如 header、footer、chapter_title 和 chapter_body。这些方法用于自定义 PDF 文件的头部、尾部、章节标题和章节内容的显示样式。
实例化 PDF 类，并调用 add_page 方法添加新的页面。
使用 chapter_title 和 chapter_body 方法添加章节标题和内容。
使用 output 方法将生成的 PDF 文件保存为 hello_world.pdf。

添加文本

在上一个示例中，我们添加了一些简单的文本内容。让我们看一个更复杂的示例，演示如何在 PDF 中添加不同字体、字号和颜色的文本。

from fpdf import FPDF

class PDF(FPDF):
    def header(self):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, 'Adding Text', 1, 1, 'C')

    def footer(self):
        self.set_y(-15)
        self.set_font('Arial', 'I', 8)
        self.cell(0, 10, 'Page %s' % self.page_no(), 0, 0, 'C')

    def add_text(self, text, font='', size=12, color=(0, 0, 0)):
        self.set_text_color(*color)
        self.set_font(font, '', size)
        self.multi_cell(0, 10, text)

pdf = PDF()
pdf.add_page()
pdf.add_text('This is default text.')

pdf.add_page()
pdf.add_text('This is Arial bold text.', 'Arial', 12, (0, 0, 255))

pdf.add_page()
pdf.add_text('This is italic text.', '', 12, (255, 0, 0))

pdf.output('adding_text.pdf')

上述代码将生成一个名为 adding_text.pdf 的 PDF 文件。打开该文件，您将看到一个标题为 “Adding Text” 的页眉，并在每个页面上添加了不同样式和颜色的文本。

在上述代码中，我们添加了一个名为 add_text 的新方法，用于在 PDF 中添加文本。此方法接受四个参数：text（文本内容）、font（字体名称，默认为空）、size（字号，默认为12）和 color（颜色，默认为黑色）。

在每个页面中，我们使用 add_text 方法添加了不同样式和颜色的文本。

添加图片

除了文本，FPDF 还允许我们在 PDF 文件中添加图像。让我们看一个示例来演示如何添加图像。

首先，我们需要准备一张名为 logo.png 的图像，并确保它与 Python 脚本在同一目录下。

from fpdf import FPDF

class PDF(FPDF):
    def header(self):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, 'Adding Image', 1, 1, 'C')

    def footer(self):
        self.set_y(-15)
        self.set_font('Arial', 'I', 8)
        self.cell(0, 10, 'Page %s' % self.page_no(), 0, 0, 'C')

    def add_image(self, image, x, y, w, h):
        self.image(image, x, y, w, h)

pdf = PDF()
pdf.add_page()
pdf.add_image('logo.png', 10, 10, 50, 0)

pdf.output('adding_image.pdf')

上述代码将生成一个名为 adding_image.pdf 的 PDF 文件。打开该文件，您将在第一页中看到一个标题为 “Adding Image” 的页眉，并在左上角添加了名为 logo.png 的图像。

在上述代码中，我们添加了一个名为 add_image 的新方法，用于在 PDF 中添加图像。此方法接受五个参数：image（图像文件名）、x 和 y（图像左上角的坐标）、w 和 h（图像的宽度和高度）。

自定义页眉和页脚

FPDF 还允许我们自定义 PDF 文件的页眉和页脚。让我们看一个示例，演示如何添加自定义页眉和页脚。

from fpdf import FPDF

class PDF(FPDF):
    def header(self):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, 'Custom Header and Footer', 1, 1, 'C')

    def footer(self):
        self.set_y(-15)
        self.set_font('Arial', 'I', 8)
        self.cell(0, 10, 'Page %s' % self.page_no(), 0, 0, 'C')

    def chapter_title(self, title):
        self.set_font('Arial', 'B', 12)
        self.cell(0, 10, title, 0, 1, 'L')

    def chapter_body(self, body):
        self.set_font('Arial', '', 12)
        self.multi_cell(0, 10, body)

pdf = PDF()
pdf.add_page()
pdf.chapter_title('Chapter 1')
pdf.chapter_body('This is the content of chapter 1.')

pdf.add_page()
pdf.chapter_title('Chapter 2')
pdf.chapter_body('This is the content of chapter 2.')

pdf.output('custom_header_footer.pdf')