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

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

Библиотека ReportLab - это available on PyPI. Руководство user guide (не случайно, в виде 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 для другого примера и некоторых приемов, которые можно использовать при генерации текстовых форматов.