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

Использование библиотеки 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() ваши исходные строки, и он сделает всё правильно.

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 для примера.