Как создать вывод CSV

Этот документ объясняет, как динамически выводить CSV (Comma Separated Values) с помощью Django-представлений. Для этого можно использовать либо библиотеку Python CSV, либо систему шаблонов Django.

Использование библиотеки Python CSV

Python поставляется с библиотекой CSV, csv. Ключ к её использованию с Django заключается в том, что возможности создания CSV модуля csv действуют на объекты типа "подобные файлам", а объекты Django HttpResponse являются такими объектами.

Вот пример:

import csv
from django.http import HttpResponse


def some_view(request):
    # Create the HttpResponse object with the appropriate CSV header.
    response = HttpResponse(
        content_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},
    )

    writer = csv.writer(response)
    writer.writerow(["First row", "Foo", "Bar", "Baz"])
    writer.writerow(["Second row", "A", "B", "C", '"Testing"', "Here's a quote"])

    return response

Код и комментарии должны быть понятны, но несколько моментов заслуживают упоминания:

• Ответ получает специальный тип MIME, text/csv. Это сообщает браузерам, что документ является файлом CSV, а не HTML-файлом. Если этого не сделать, браузеры, вероятно, интерпретируют вывод как HTML, что приведёт к некрасивому, пугающему результату в окне браузера.
• Ответ получает дополнительный заголовок Content-Disposition, который содержит имя файла CSV. Это имя файла произвольное; назовите его как хотите. Оно будет использовано браузерами в диалоговом окне "Сохранить как" и т. д.
• Вы можете подключиться к API генерации CSV, передав response в качестве первого аргумента функции csv.writer. Функция csv.writer ожидает объект типа "подобный файлу", а объекты HttpResponse подходят для этой задачи.
• Для каждой строки в файле CSV вызовите writer.writerow, передав ему итерируемый объект.
• Модуль CSV позаботится о кавычках, поэтому вам не нужно беспокоиться об экранировании строк с кавычками или запятыми в них. Передайте writerow() ваши исходные строки, и он сделает всё правильно.

Потоковая передача больших файлов CSV

При работе с представлениями, генерирующими очень большие ответы, вы можете рассмотреть возможность использования Django StreamingHttpResponse вместо этого. Например, передавая файл, для генерации которого требуется много времени, вы можете избежать отключения соединения балансировщиком нагрузки, которое могло бы произойти, если бы сервер генерировал ответ в течение слишком долгого времени.

В этом примере мы полностью используем генераторы Python для эффективной сборки и передачи большого файла CSV:

import csv

from django.http import StreamingHttpResponse


class Echo:
    """An object that implements just the write method of the file-like
    interface.
    """

    def write(self, value):
        """Write the value by returning it, instead of storing in a buffer."""
        return value


def some_streaming_csv_view(request):
    """A view that streams a large CSV file."""
    # Generate a sequence of rows. The range is based on the maximum number of
    # rows that can be handled by a single sheet in most spreadsheet
    # applications.
    rows = (["Row {}".format(idx), str(idx)] for idx in range(65536))
    pseudo_buffer = Echo()
    writer = csv.writer(pseudo_buffer)
    return StreamingHttpResponse(
        (writer.writerow(row) for row in rows),
        content_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},
    )

Использование системы шаблонов

В качестве альтернативы можно использовать систему шаблонов Django для генерации CSV. Это менее удобный способ, чем использование удобного модуля Python csv, но это решение представлено здесь для полноты.

Здесь идея заключается в том, чтобы передать список элементов в шаблон и заставить шаблон выводить запятые в цикле for.

Вот пример, который генерирует тот же файл CSV, что и выше:

from django.http import HttpResponse
from django.template import loader


def some_view(request):
    # Create the HttpResponse object with the appropriate CSV header.
    response = HttpResponse(
        content_type="text/csv",
        headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},
    )

    # The data is hard-coded here, but you could load it from a database or
    # some other source.
    csv_data = (
        ("First row", "Foo", "Bar", "Baz"),
        ("Second row", "A", "B", "C", '"Testing"', "Here's a quote"),
    )

    t = loader.get_template("my_template_name.txt")
    c = {"data": csv_data}
    response.write(t.render(c))
    return response

Единственное различие между этим примером и предыдущим заключается в том, что этот пример использует загрузку шаблона вместо модуля CSV. Остальной код, такой как content_type='text/csv', такой же.

Затем создайте шаблон my_template_name.txt, с этим кодом шаблона:

{% for row in data %}"{{ row.0|addslashes }}", "{{ row.1|addslashes }}", "{{ row.2|addslashes }}", "{{ row.3|addslashes }}", "{{ row.4|addslashes }}"
{% endfor %}

Этот короткий шаблон итерируется по предоставленным данным и отображает строку CSV для каждой строки. Он использует фильтр шаблона addslashes для предотвращения проблем с кавычками.

Другие текстовые форматы

Обратите внимание, что здесь нет ничего специфичного для CSV — только конкретный формат вывода. Вы можете использовать любой из этих методов для вывода любого текстового формата, который вы только можете придумать. Вы также можете использовать аналогичный метод для генерации произвольных двоичных данных; см. Как создать файлы PDF для примера.