Выгрузка CSV с Django

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

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

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

Вот пример:

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')
    response['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’s 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)
    response = StreamingHttpResponse((writer.writerow(row) for row in rows),
                                     content_type="text/csv")
    response['Content-Disposition'] = 'attachment; filename="somefilename.csv"'
    return response

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

В качестве альтернативы вы можете использовать систему шаблонов 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')
    response['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 для примера.