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

Установка ReportLab

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

$ python -m pip install reportlab

...\> py -m pip install reportlab

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

>>> import reportlab

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

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

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

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

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