Вывод 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 работает с объектами, похожими на файлы, а объекты Django HttpResponse являются объектами, похожими на файлы.

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

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"'

    # 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 для другого примера и некоторых методов, которые можно использовать при генерации текстовых форматов.