django生成CSV文件

生成CSV和Excel文件:
有时候我们做的网站,需要将一些数据导出到文件中以方便统计,在导出文件类型中生成CSV文件或者是Excel文件是常用的方式,导出的CSV文件或者Excel文件将以附件的方式下载下来,以下将讲解如何生成CSV文件。

生成小的CSV文件:我们用Python内置的csv模块来处理csv文件,并且使用HttpResponse来将csv文件返回回去,首先来介绍一下把数据写入到CSV文件的一种方法:

  import csv

  with open('abc.csv') as fp:

    writer = csv.writer(fp)
    writer.writerow(['name', 'age', 'gender'])
    writer.writerow(['xdm', 20, '男'])
使用这种方法就可以把两行数据写入到abc.csv文件中,类似的,我们想要在响应中生成CSV文件,可以把HttpResponse对象类比成上面的文件句柄fp,这样在写入数据的时候,就可以把数据写入到HttpResponse对象中。

具体写法如下:

  import csv
  from django.http import HttpResponse

  def csv_view(request):
    # 设置响应的content_type,表明响应的是CSV文件
    response = HttpResponse(content_type='text/csv')


    # 设置响应头,描述生成的CSV文件
    response['Content-Disposition'] = 'attachment; filename="somefilename.csv"'


    # 使用CSV模块,把响应体content封装到类似文件句柄内,这样写入的内容都会被写入到response.content之中
    writer = csv.writer(response)


    # 以行为单位写入数据
    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格式的文件定义成模板,然后使用Django内置的模板系统,并给这个模板传入一个Context对象,这样模板系统就会根据传入的Context对象,生成具体的csv文件。示例代码如下:

使用模板生成csv文件:

模板文件,在django项目的templates文件夹中定义一个模板文件,示例代码如下:
定义一个名为abc.txt的模板:
  {% for row in rows %}{{row.0}},{{row.1}},{{row.2}}
  {% endfor %}

然后编写视图函数如下:
  from django.template import loader
  from django.http import HttpResponse
  def template_csv_view(request):
    resp = HttpResponse(content_type='text/csv')
    resp['Content-Disposition'] = 'attachment;filename="abc.csv"'
    # 加载模板
    template = loader.get_template('abc.csv')
    context = {
      'rows': [
        ['name', 'age', 'gender'],
        ['xdm', 19, '男'],
        ]
      }
    # 把数据渲染到模板上
    content = template.render(context)
    resp.content = content
    return resp


以上的例子是生成的一个小的csv文件,使用HttpResponse生成CSV文件,实际上服务器在生成CSV文件的时候服务器会把CSV文件完全生成之后返回。这样如果想要生成大型的csv文件,那么以上方式将有可能会发生超时的情况(服务器要生成一个大型csv文件,需要的时间可能会超过浏览器默认的超时时间)。此时如果我们要生成大型CSV文件,这时候我们可以借助另外一个类,叫做StreamingHttpResponse对象,这个对象是将响应的数据作为一个流返回给客户端,而不是作为一个整体返回。

生成大型的csv文件

  from django.http import JsonResponse, StreamingHttpResponse
  def large_csv_view(request):
    resp = StreamingHttpResponse(content_type='text/csv')
    resp['Content-Disposition'] = 'attachment;filename="large.csv"'
    content = ("name{},age{},gender{}\n".format(row, row, row) for row in range(1000000))
    resp.streaming_content = content
    return resp

 

关于StreamingHttpResponse
  这个类是专门用来处理流数据的。使得在处理一些大型文件的时候,不会因为服务器处理时间过长而到时连接超时。这个类不是继承自HttpResponse,并且跟HttpResponse对比有以下几点区别:

  这个类没有属性content,相反是streaming_content。
  这个类的streaming_content必须是一个可以迭代的对象。
  这个类没有write方法,如果给这个类的对象写入数据将会报错。
注意:StreamingHttpResponse会启动一个进程来和客户端保持长连接,所以会很消耗资源。所以如果不是特殊要求,尽量少用这种方法。

posted @ 2018-08-16 22:33  大蒙  阅读(693)  评论(0编辑  收藏  举报