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

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

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

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

Установка ReportLab

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

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