Вывод PDF-файлов с помощью Django

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

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

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

Установка ReportLab

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

...\> py -m pip install reportlab

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

>>> import reportlab

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

Написание представления

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

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

import io
from django.http import FileResponse
from reportlab.pdfgen import canvas

def some_view(request):
    # Create a file-like buffer to receive PDF data.
    buffer = io.BytesIO()

    # Create the PDF object, using the buffer 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, and we're done.
    p.showPage()
    p.save()

    # FileResponse sets the Content-Disposition header so that browsers
    # present the option to save the file.
    buffer.seek(0)
    return FileResponse(buffer, as_attachment=True, filename='hello.pdf')

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

• Браузер автоматически установит тип MIME application/pdf на основе расширения файла. Это сообщает браузерам, что документ является PDF-файлом, а не HTML-файлом или двоичным контентом общего типа application/octet-stream.
• Когда as_attachment=True передаётся в FileResponse, устанавливается соответствующий заголовок Content-Disposition, который сообщает веб-браузерам отобразить диалоговое окно, спрашивающее/подтверждающее, как обработать документ, даже если на компьютере установлены значения по умолчанию. Если параметр as_attachment опущен, браузеры обработают PDF с помощью программы/плагина, настроенных для работы с PDF-файлами.
• Вы можете указать произвольный параметр filename. Он будет использован браузерами в диалоговом окне «Сохранить как…».
• Вы можете подключиться к API ReportLab: тот же буфер, переданный в качестве первого аргумента функции canvas.Canvas, может быть передан классу FileResponse.
• Обратите внимание, что все последующие методы генерации PDF вызываются для объекта PDF (в данном случае p) — а не для buffer.
• Наконец, важно вызвать showPage() и save() для PDF-файла.

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

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