Как создать файлы PDF

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