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

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

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

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

Установление ReportLab

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

$ pip install reportlab

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