生成CSV文件
有时候我们做的网站,需要将一些数据,生成有一个CSV文件给浏览器,并且是作为附件的形式下载下来。、
生成小的CSV文件
用Python内置的csv模块来处理csv文件,并且使用HttpResponse来将csv文件返回回去。
import csvfrom django.http import HttpResponsedef csv_view(request):response = HttpResponse(content_type='text/csv')response['Content-Disposition'] = 'attachment; filename="somefilename.csv"'# 下面类似于# with open("xxx.csv", "w") as fp:# csv.writer(fp)writer = csv.writer(response) #HttpResponse重写了write方法,这里可以当成句柄使用writer.writerow(['username', 'age', 'height', 'weight']) #写一行writer.writerow(['zhiliao', '18', '180', '110'])return response
- 在初始化
HttpResponse的时候,指定了Content-Type为text/csv,这将告诉浏览器,这是一个csv格式的文件而不是一个HTML格式的文件,如果用默认值,默认值就是html,那么浏览器将把csv格式的文件按照html格式输出 - 第二个在
response中添加一个Content-Disposition头,这个东西是用来告诉浏览器该如何处理这个文件,我们给这个头的值设置为attachment;,那么浏览器将不会对这个文件进行显示,而是作为附件的形式下载,第二个filename="somefilename.csv"是用来指定这个csv文件的名字。 - 使用
csv模块的writer方法,将相应的数据写入到response中。
将csv文件定义成模板
我们还可以将csv格式的文件定义成模板,然后使用Django内置的模板系统,并给这个模板传入一个Context对象,这样模板系统就会根据传入的Context对象,生成具体的csv文件。
模板文件:
{# abc.txt #}{# 下面会换行 #}{% for row in rows %}{{row.0}} {{row.1}}{% endfor %}{# 下面这个不会换行 #}{% for row in rows %}{{row.0}}{row.1}{% endfor %}
视图函数:
from django.http import HttpResponsefrom django.template import loaderdef some_view(request):response = HttpResponse(content_type='text/csv')response['Content-Disposition'] = 'attachment; filename="somefilename.csv"'context = {'rows': [['name', 'jack'],['age', 22]]}template = loader.get_template('abc.txt') #加载模版csv_template = template.render(context) #渲染模版response.content = csv_template #将渲染好的模版添加金response里return response
生成大的CSV文件
以上的例子是生成的一个小的csv文件,如果想要生成大型的csv文件,那么以上方式将有可能会发生超时的情况(服务器要生成一个大型csv文件,需要的时间可能会超过浏览器默认的超时时间)。这时候我们可以借助另外一个类,叫做StreamingHttpResponse对象,这个对象是将响应的数据作为一个流返回给客户端,而不是作为一个整体返回。示例代码如下:
from django.http import StreamingHttpResponsedef large_csv(request):response = StreamingHttpResponse(content_type='text/csv')response["Content-Disposition"] = "attachement;filename='large.csv'"rows = ("Row {}, {}\n".format(row, row) for row in range(0, 100000))response.streaming_content = rows # 需要可迭代的return response
注意:StreamingHttpResponse会启动一个进程来和客户端保持长连接,所以会很消耗资源。所以如果不是特殊要求,尽量少用这种方法。
关于StreamingHttpResponse
这个类是专门用来处理流数据的。使得在处理一些大型文件的时候,不会因为服务器处理时间过长而到时连接超时。这个类不是继承自HttpResponse,并且跟HttpResponse对比有以下几点区别:
- 这个类没有属性
content,相反是streaming_content。 - 这个类的
streaming_content必须是一个可以迭代的对象。 - 这个类没有
write方法,如果给这个类的对象写入数据将会报错。
注意:StreamingHttpResponse会启动一个进程来和客户端保持长连接,所以会很消耗资源。所以如果不是特殊要求,尽量少用这种方法。
