Выгрузка PDF-файлов с помощью Django

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

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

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

Установка ReportLab

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

$ pip install reportlab

...\> pip install reportlab

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

>>> import reportlab

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

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

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

Вот пример «Привет, мир»:

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.
    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 с использованием программы/плагина, для которого они были настроены.
• Вы можете предоставить произвольный параметр filename. Он будет использоваться браузерами в диалоговом окне «Сохранить как…».
• Связь с API ReportLab проста: тот же буфер, переданный в качестве первого аргумента в canvas.Canvas, может быть передан в класс FileResponse.
• Обратите внимание, что все последующие методы генерации PDF вызываются на объекте PDF (в данном случае, p) — а не на buffer.
• Наконец, важно вызвать showPage() и save() для файла PDF.

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

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