返回

Django 中 PDF 库的不确定性行为：故障排查和修复指南

python

# Django 中 PDF 库的不确定性行为诊断与修复

## 导言

在使用 Python、Django 和 pypdf 库构建的应用程序中，我们遇到了一个棘手的 PDF 生成问题。当应用程序同时访问 Postgresql 数据库和 pypdf 库时，偶尔会出现损坏的 PDF 文档。本文将详细介绍我们诊断和解决此问题的步骤，提供详细的代码示例和故障排除技巧。

## 确定触发条件

通过比较生成 PDF 文档的大小，我们发现当输出文档大小与预期不符时，就会触发错误。

## 创建重现问题的示例

为了重现问题并进行调试，我们创建了一个最小示例代码：

# 运行方式：python3 manage.py minrepro input.pdf
import argparse, io
from django.core.management.base import BaseCommand
from pypdf import PdfReader, PdfWriter
from djangoapp.models import DjangoModel


def main(fin):
    pdfout = PdfWriter()
    pageout = pdfout.add_blank_page(width=200, height=200)

    for i in range(8):
        # 注意：在此处访问数据库！
        # 如果没有下一行，无法重现问题
        for c in range(31): a = DjangoModel.objects.first()

        fin.seek(0)
        for pagein in PdfReader(fin, strict=True).pages:
            pageout.merge_page(pagein)

    with io.BytesIO() as fout:
        pdfout.write(fout)
        return fout.tell()

class Command(BaseCommand):
    def add_arguments(self, parser):
        parser.add_argument(dest="pdf", type=argparse.FileType("rb") )
    def handle(self, *args, **options):
        for i in range(30):
            if i == 0: first_size = main(options["pdf"])
            current_size = main(options["pdf"])
            if not first_size == current_size:
                print(f"presumed stateless call was not {i=}, {first_size=} != {current_size=}")

## 检查代码

仔细检查重现问题的代码，特别是访问数据库和处理 PDF 文档的代码。

## 启用调试

启用 Python 的调试选项 -W all 以获取更多详细信息。

## 分析日志

查看应用程序的日志以查找任何相关的错误消息或警告。

## 可能的成因

造成此问题的可能成因包括：

  • pypdf 在处理重复标识符时无法生成真正唯一的名称，而数据库访问仅提供了让此问题变得明显的机会（延迟）。
  • 多线程问题，即使代码在单线程管理命令中重现。

## 解决办法

解决此问题的方法取决于具体成因：

  • 更新到 pypdf 的最新版本。
  • 检查应用程序代码是否存在任何多线程问题。
  • 联系 pypdf 的开发人员以报告此问题。

## 结论

通过系统的故障排查，我们确定了导致 Django 应用程序中 PDF 生成不确定性行为的潜在原因。我们提出了解决此问题的建议，并鼓励读者在遇到类似问题时遵循这些步骤。通过仔细的调试和分析，我们能够诊断和修复问题，确保应用程序的稳定和可靠。

## 常见问题解答

  1. 为什么要访问数据库？

    • 数据库访问是重现问题的必要条件，因为它会在 pypdf 处理 PDF 文档时引入延迟。

  2. 为什么错误不是每次都发生？

    • 触发错误的条件是数据库访问和 pypdf 处理 PDF 文档的特定组合，这是一种罕见的事件。

  3. 还有其他解决方法吗？

    • 在 pypdf 生成 PDF 文档之前，可以手动生成唯一的名称，但这可能是一个繁琐且容易出错的过程。

  4. 如何避免多线程问题？

    • 确保应用程序中的所有操作都在单线程上下文中执行，避免在不同线程中并发访问数据库和 pypdf。

  5. 如何与 pypdf 开发人员联系？

    • 可以通过 pypdf 的 GitHub 存储库或官方文档中提供的联系方式联系开发人员。