Поток CSV файла в Django
Я пытаюсь передать файл csv как загрузку вложений. Файлы CSV имеют размер 4 МБ или больше, и мне нужен способ для активного скачивания файлов, не дожидаясь, пока все данные будут созданы и будут сохранены в памяти.
Сначала я использовал свою собственную файловую оболочку на основе класса Django FileWrapper
. Это не удалось. Затем я увидел способ использования генератора для потока ответа:
Как передать HttpResponse с Django
Когда я вызываю ошибку в генераторе, я вижу, что я создаю правильные данные с помощью функции get_row_data()
, но когда я пытаюсь вернуть ответ, он возвращается пустым. Я также отключил Django GZipMiddleware
. Кто-нибудь знает, что я делаю неправильно?
Изменить: проблема, с которой я столкнулась, была с ConditionalGetMiddleware
. Я должен был заменить его, код находится в ответе ниже.
Вот представление:
from django.views.decorators.http import condition
@condition(etag_func=None)
def csv_view(request, app_label, model_name):
""" Based on the filters in the query, return a csv file for the given model """
#Get the model
model = models.get_model(app_label, model_name)
#if there are filters in the query
if request.method == 'GET':
#if the query is not empty
if request.META['QUERY_STRING'] != None:
keyword_arg_dict = {}
for key, value in request.GET.items():
#get the query filters
keyword_arg_dict[str(key)] = str(value)
#generate a list of row objects, based on the filters
objects_list = model.objects.filter(**keyword_arg_dict)
else:
#get all the model objects
objects_list = model.objects.all()
else:
#get all the model objects
objects_list = model.objects.all()
#create the reponse object with a csv mimetype
response = HttpResponse(
stream_response_generator(model, objects_list),
mimetype='text/plain',
)
response['Content-Disposition'] = "attachment; filename=foo.csv"
return response
Вот генератор, который я использую для потока ответа:
def stream_response_generator(model, objects_list):
"""Streaming function to return data iteratively """
for row_item in objects_list:
yield get_row_data(model, row_item)
time.sleep(1)
И вот как я создаю данные строки csv:
def get_row_data(model, row):
"""Get a row of csv data from an object"""
#Create a temporary csv handle
csv_handle = cStringIO.StringIO()
#create the csv output object
csv_output = csv.writer(csv_handle)
value_list = []
for field in model._meta.fields:
#if the field is a related field (ForeignKey, ManyToMany, OneToOne)
if isinstance(field, RelatedField):
#get the related model from the field object
related_model = field.rel.to
for key in row.__dict__.keys():
#find the field in the row that matches the related field
if key.startswith(field.name):
#Get the unicode version of the row in the related model, based on the id
try:
entry = related_model.objects.get(
id__exact=int(row.__dict__[key]),
)
except:
pass
else:
value = entry.__unicode__().encode("utf-8")
break
#if it isn't a related field
else:
#get the value of the field
if isinstance(row.__dict__[field.name], basestring):
value = row.__dict__[field.name].encode("utf-8")
else:
value = row.__dict__[field.name]
value_list.append(value)
#add the row of csv values to the csv file
csv_output.writerow(value_list)
#Return the string value of the csv output
return csv_handle.getvalue()
Ответы
Ответ 1
Вот какой простой код, который будет передавать CSV; вы, вероятно, можете перейти от этого к тому, что вам нужно:
import cStringIO as StringIO
import csv
def csv(request):
def data():
for i in xrange(10):
csvfile = StringIO.StringIO()
csvwriter = csv.writer(csvfile)
csvwriter.writerow([i,"a","b","c"])
yield csvfile.getvalue()
response = HttpResponse(data(), mimetype="text/csv")
response["Content-Disposition"] = "attachment; filename=test.csv"
return response
Это просто записывает каждую строку в файл в памяти, читает строку и возвращает ее.
Эта версия более эффективна для генерации массивных данных, но прежде чем использовать ее, обязательно ознакомьтесь с ней:
import cStringIO as StringIO
import csv
def csv(request):
csvfile = StringIO.StringIO()
csvwriter = csv.writer(csvfile)
def read_and_flush():
csvfile.seek(0)
data = csvfile.read()
csvfile.seek(0)
csvfile.truncate()
return data
def data():
for i in xrange(10):
csvwriter.writerow([i,"a","b","c"])
data = read_and_flush()
yield data
response = HttpResponse(data(), mimetype="text/csv")
response["Content-Disposition"] = "attachment; filename=test.csv"
return response
Ответ 2
Проблема промежуточного программного обеспечения была решена с Django 1.5, и был введен StreamingHttpResponse. Необходимо сделать следующее:
import cStringIO as StringIO
import csv
def csv_view(request):
...
# Assume `rows` is an iterator or lists
def stream():
buffer_ = StringIO.StringIO()
writer = csv.writer(buffer_)
for row in rows:
writer.writerow(row)
buffer_.seek(0)
data = buffer_.read()
buffer_.seek(0)
buffer_.truncate()
yield data
response = StreamingHttpResponse(
stream(), content_type='text/csv'
)
disposition = "attachment; filename=file.csv"
response['Content-Disposition'] = disposition
return response
Там есть документация по как вывести csv из Django, но она не использует преимущества StreamingHttpResponse
, поэтому я пошел вперед и открыл билет, чтобы отслеживать его.
Ответ 3
Проблема, с которой я столкнулась, была связана с ConditionalGetMiddleware. Я видел, как django-piston придумал замену промежуточного программного обеспечения для ConditionalGetMiddleware, которое позволяет передавать потоки:
from django.middleware.http import ConditionalGetMiddleware
def compat_middleware_factory(klass):
"""
Class wrapper that only executes `process_response`
if `streaming` is not set on the `HttpResponse` object.
Django has a bad habbit of looking at the content,
which will prematurely exhaust the data source if we're
using generators or buffers.
"""
class compatwrapper(klass):
def process_response(self, req, resp):
if not hasattr(resp, 'streaming'):
return klass.process_response(self, req, resp)
return resp
return compatwrapper
ConditionalMiddlewareCompatProxy = compat_middleware_factory(ConditionalGetMiddleware)
Итак, вы замените ConditionalGetMiddleware своим промежуточным программным обеспечением ConditionalMiddlewareCompatProxy и, на ваш взгляд, (заимствованный код из умного ответа на этот вопрос):
def csv_view(request):
def data():
for i in xrange(10):
csvfile = StringIO.StringIO()
csvwriter = csv.writer(csvfile)
csvwriter.writerow([i,"a","b","c"])
yield csvfile.getvalue()
#create the reponse object with a csv mimetype
response = HttpResponse(
data(),
mimetype='text/csv',
)
#Set the response as an attachment with a filename
response['Content-Disposition'] = "attachment; filename=test.csv"
response.streaming = True
return response