Вывод PDF-файлов с Django

В этом документе объясняется, как динамически выводить PDF-файлы с помощью представлений Django. Это становится возможным благодаря отличной, открытой библиотеке Python для PDF-файлов ReportLab.

Преимущество динамического создания PDF-файлов заключается в том, что вы можете создавать настраиваемые PDF-файлы для разных целей — например, для разных пользователей или разных фрагментов контента.

Например, Django использовался на kusports.com для генерации настраиваемых, удобных для печати турнирных таблиц NCAA, как PDF-файлы, для участников конкурса «Мартовский безумство».

Установка ReportLab

Библиотека ReportLab доступна на PyPI. Руководство пользователя (пользовательское руководство), неслучайно, также доступен в формате PDF. Вы можете установить ReportLab с помощью pip.

$ pip install reportlab

Проверьте установку, импортировав её в интерактивном интерпретаторе Python:

>>> import reportlab

Если эта команда не вызывает никаких ошибок, установка прошла успешно.

Напишите своё представление

Ключ к динамическому созданию PDF-файлов с Django заключается в том, что API ReportLab действует на объекты-подобные файлам, а объекты HttpResponse Django являются такими объектами.

Вот пример «Hello World»:

from django.http import HttpResponse
from reportlab.pdfgen import canvas

def some_view(request):
    # Create the HttpResponse object with the appropriate PDF headers.
    response = HttpResponse(content_type='application/pdf')
    response['Content-Disposition'] = 'attachment; filename="somefilename.pdf"'

    # Create the PDF object, using the response object as its "file."
    p = canvas.Canvas(response)

    # Draw things on the PDF. Here's where the PDF generation happens.
    # See the ReportLab documentation for the full list of functionality.
    p.drawString(100, 100, "Hello world.")

    # Close the PDF object cleanly, and we're done.
    p.showPage()
    p.save()
    return response

Код и комментарии должны быть понятны, но несколько моментов заслуживают упоминания:

• Отклик получает специальный тип MIME, application/pdf. Это сообщает браузерам, что документ является PDF-файлом, а не HTML-файлом. Если этого не сделать, браузеры, вероятно, интерпретируют вывод как HTML, что приведёт к некрасивому, пугающему результату в окне браузера.
• Отклик получает дополнительный Content-Disposition заголовок, который содержит имя PDF-файла. Это имя произвольное: назовите его как хотите. Оно будет использоваться браузерами в диалоговом окне «Сохранить как…».

• Заголовок Content-Disposition начинается с 'attachment; ' в этом примере. Это заставляет веб-браузеры отображать диалоговое окно, запрашивая/подтверждая способ обработки документа, даже если на компьютере установлен параметр по умолчанию. Если вы опустите 'attachment;', браузеры будут обрабатывать PDF с помощью любой программы/плагина, с которой они настроены работать с PDF-файлами. Вот как будет выглядеть этот код:

  response['Content-Disposition'] = 'filename="somefilename.pdf"'
  

• Связь с API ReportLab проста: просто передайте response в качестве первого аргумента функции canvas.Canvas. Класс Canvas ожидает объект, подобный файлу, и объекты HttpResponse подходят для этой цели.
• Обратите внимание, что все последующие методы генерации PDF вызываются для объекта PDF (в этом случае p) — а не для response.
• Наконец, важно вызвать showPage() и save() для файла PDF.

Сложные PDF-файлы

Если вы создаёте сложный PDF-документ с ReportLab, рассмотрите возможность использования библиотеки io в качестве временного места хранения вашего PDF-файла. Эта библиотека предоставляет интерфейс объекта, подобного файлу, который особенно эффективен. Вот пример «Hello World» выше, переписанный с использованием io:

from io import BytesIO
from reportlab.pdfgen import canvas
from django.http import HttpResponse

def some_view(request):
    # Create the HttpResponse object with the appropriate PDF headers.
    response = HttpResponse(content_type='application/pdf')
    response['Content-Disposition'] = 'attachment; filename="somefilename.pdf"'

    buffer = BytesIO()

    # Create the PDF object, using the BytesIO object as its "file."
    p = canvas.Canvas(buffer)

    # Draw things on the PDF. Here's where the PDF generation happens.
    # See the ReportLab documentation for the full list of functionality.
    p.drawString(100, 100, "Hello world.")

    # Close the PDF object cleanly.
    p.showPage()
    p.save()

    # Get the value of the BytesIO buffer and write it to the response.
    pdf = buffer.getvalue()
    buffer.close()
    response.write(pdf)
    return response

Другие форматы

Обратите внимание, что в этих примерах не так много специфичного для PDF — только части с reportlab. Вы можете использовать аналогичный метод для генерации любого произвольного формата, для которого вы найдёте Python-библиотеку. Также обратитесь к Вывод CSV с Django для другого примера и некоторых приёмов, которые можно использовать при генерации текстовых форматов.