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