Вывод CSV с Django

Этот документ объясняет, как динамически выводить 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 с помощью Django для примера.