Reportlab：如何为 pdf 文件添加页脚

Posted 2023-02-24

【中文标题】Reportlab：如何为 pdf 文件添加页脚

【英文标题】：Reportlab: How to add a footer to a pdf file

【发布时间】：2015-04-01 14:20:59

【问题描述】：

我已经问过这个question 但还没有答案，所以我想看看 Reportlab，它似乎正在积极开发并且比 fpdf python 库更好。

我已经看过这个question 给出的答案似乎和这个blog post 差不多。无论如何，显示的脚本充满了错误，但我不想投反对票，OP接受了它，似乎解决了他的问题，我与谁争论，我宁愿再问一个问题。

首先你需要导入

from reportlab.pdfgen.canvas import Canvas

这不是canvas 它是Canvas 然后你不能这样做

Canvas.restoreState() 或 Canvas.saveState()

也许还有更多的错误，我宁愿用另一个例子。我昨天整晚都在试图让 sn-p 工作，但没有成功。

还有其他创建页脚的方法吗？我想问的一个具体方法是this，这家伙做了一个for循环，在row[0]上他写了一些东西，row[1]一些东西

我统计了一份 LibreOffice 文档，它是 A4，使用Liberation Serif 12，有 49 行。假设平均有 45 行，取决于字体大小，页脚字体大小为 8，难道不能像这样插入页脚x=row[45] 然后根据页码增加 x 吗？这不是一个更简单的解决方案吗？

如果我可以检测到文件的结尾，或者插入文本的最后一行，那么我认为我可以做到。

如果您参考我的其他问题，您会注意到我将 powerpoint、excel 和 word 转换为 pdf，然后插入页脚。

如果有一个库可以在 linux 和 windows 上使用隐蔽的 powerpoint 和 excel to word，然后添加页脚然后转换为 pdf，那就太好了，因为我认为使用文档比使用 PDF 更容易

【问题讨论】：

在有人回答之前，我会尝试使用os.system("libreoffice --headless --invisible --convert-to doc 或其他东西

【参考方案1】：

首先，Reportlab 很棒。我发现生成 pdf 的最佳库。

请在尝试示例之前安装 reportlab：

pip install reportlab

为了创建脚注，您需要使用 multibuild 渲染文档并使用 canvasmaker 添加页脚。

首先，让我们创建一个包含两页的简单 pdf 文件：

from reportlab.platypus import (SimpleDocTemplate, Paragraph, PageBreak)
from reportlab.lib.styles import getSampleStyleSheet
from reportlab.lib.pagesizes import LETTER


if __name__ == '__main__':

    # Content
    styles = getSampleStyleSheet()
    elements = []
    elements.append(Paragraph("Hello", styles["Normal"]))
    elements.append(Paragraph("World", styles["Normal"]))
    elements.append(PageBreak())
    elements.append(Paragraph("You are in page 2", styles["Normal"]))

    # Build
    doc = SimpleDocTemplate("my_file.pdf", pagesize=LETTER)
    doc.build(elements)

检查 pdf 文件是否正确创建。

现在让我们添加一个画布类来绘制显示行和页码的页脚，并在最后一行将 build 更改为 multibuild：

from reportlab.pdfgen import canvas
from reportlab.platypus import (SimpleDocTemplate, Paragraph, PageBreak)
from reportlab.lib.styles import getSampleStyleSheet
from reportlab.lib.pagesizes import LETTER


class FooterCanvas(canvas.Canvas):

    def __init__(self, *args, **kwargs):
        canvas.Canvas.__init__(self, *args, **kwargs)
        self.pages = []

    def showPage(self):
        self.pages.append(dict(self.__dict__))
        self._startPage()

    def save(self):
        page_count = len(self.pages)
        for page in self.pages:
            self.__dict__.update(page)
            self.draw_canvas(page_count)
            canvas.Canvas.showPage(self)
        canvas.Canvas.save(self)

    def draw_canvas(self, page_count):
        page = "Page %s of %s" % (self._pageNumber, page_count)
        x = 128
        self.saveState()
        self.setStrokeColorRGB(0, 0, 0)
        self.setLineWidth(0.5)
        self.line(66, 78, LETTER[0] - 66, 78)
        self.setFont('Times-Roman', 10)
        self.drawString(LETTER[0]-x, 65, page)
        self.restoreState()


if __name__ == '__main__':

    # Content
    styles = getSampleStyleSheet()
    elements = []
    elements.append(Paragraph("Hello", styles["Normal"]))
    elements.append(Paragraph("World", styles["Normal"]))
    elements.append(PageBreak())
    elements.append(Paragraph("You are in page 2", styles["Normal"]))

    # Build
    doc = SimpleDocTemplate("my_file.pdf", pagesize=LETTER)
    doc.multiBuild(elements, canvasmaker=FooterCanvas)

在多构建中，如果您愿意，您还可以为第一页指定不同的画布：

doc.multiBuild(Elements, onFirstPage=myFirstPage, onLaterPages=myLaterPages)

希望这会有所帮助。

编辑

现在的目标是为现有的 pdf 文件添加页脚。不幸的是，这不能单独用 Reportlab 完成（至少开源版本，我认为专业版本有这个功能）。

首先，我们需要在配方中添加一点 pdfrw

pip install pdfrw

现在我们可以为现有的 pdf 添加页脚，这样做：打开原始 pdf，提取页面，并沿着页脚将页面“绘制”到新的 pdf，一次一页：

from reportlab.pdfgen.canvas import Canvas
from pdfrw import PdfReader
from pdfrw.toreportlab import makerl
from pdfrw.buildxobj import pagexobj

input_file = "my_file.pdf"
output_file = "my_file_with_footer.pdf"

# Get pages
reader = PdfReader(input_file)
pages = [pagexobj(p) for p in reader.pages]


# Compose new pdf
canvas = Canvas(output_file)

for page_num, page in enumerate(pages, start=1):

    # Add page
    canvas.setPageSize((page.BBox[2], page.BBox[3]))
    canvas.doForm(makerl(canvas, page))

    # Draw footer
    footer_text = "Page %s of %s" % (page_num, len(pages))
    x = 128
    canvas.saveState()
    canvas.setStrokeColorRGB(0, 0, 0)
    canvas.setLineWidth(0.5)
    canvas.line(66, 78, page.BBox[2] - 66, 78)
    canvas.setFont('Times-Roman', 10)
    canvas.drawString(page.BBox[2]-x, 65, footer_text)
    canvas.restoreState()

    canvas.showPage()

canvas.save()

免责声明：在 Linux 上使用 Reportlab 生成的 pdf 文件作为输入文件进行测试。它可能不适用于任意 pdf 文件。

【讨论】：

谢谢你的回答，明天我会接受你的回答，但是想问你一个问题，是不是一调用pagebreak就插入页脚？如果是这样，它对我不起作用，因为我使用的是现有文件，请参阅我之前的问题，上面的链接，我的意思是我无法知道页面何时结束，因为我没有手动插入，我正在对整个文件使用 for 循环，除非有一个函数可以检测 pdf 中的页面

我会尝试使用 OnlaterPages

页脚是在呈现文档后生成的。这就是我使用 multiBuild 的原因。我使用分页符只是为了轻松生成两页文档。你使用什么样的文件？文本文件？

Pdf 文件，我有 pdf 现有的 pdf 文件，我想为它们添加页脚，我没有创建的 PDF 文件

我用一个小程序编辑了我的答案