生成CSV文件
有时候我们做的网站,需要将一些数据,生成有一个CSV
文件给浏览器,并且是作为附件的形式下载下来。、
生成小的CSV文件
用Python
内置的csv
模块来处理csv
文件,并且使用HttpResponse
来将csv
文件返回回去。
import csv
from django.http import HttpResponse
def 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 HttpResponse
from django.template import loader
def 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 StreamingHttpResponse
def 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
会启动一个进程来和客户端保持长连接,所以会很消耗资源。所以如果不是特殊要求,尽量少用这种方法。