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

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

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

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

Установка ReportLab

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

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