生成 CSV · Django 中文文檔 1.8

{% raw %} # 使用Django輸出CSV # 這篇文檔闡述了如何通過使用Django視圖動態輸出CSV (Comma Separated Values)。你可以使用Python CSV 庫或者Django的模板系統來達到目的。 ## 使用Python CSV庫 ## Python自帶了CSV庫，`csv`。在Django中使用它的關鍵是，`csv`模塊的CSV創建功能作用于類似于文件的對象，并且Django的`HttpResponse`對象就是類似于文件的對象。這里是個例子： ``` 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文件的名稱。文件名可以是任意的；你想把它叫做什么都可以。瀏覽器會在”另存為“對話框中使用它，或者其它。 + 鉤住CSV生成API非常簡單：只需要把`response`作為第一個參數傳遞給`csv.writer`。`csv.writer` 函數接受一個類似于文件的對象，而`HttpResponse` 對象正好合適。 + 對于你CSV文件的每一行，調用`writer.writerow`，向它傳遞一個可迭代的對象比如列表或者元組。 + CSV模板會為你處理引用，所以你不用擔心沒有轉義字符串中的引號或者逗號。只需要向`writerow()`傳遞你的原始字符串，它就會執行正確的操作。 > 在Python 2中處理Unicode > > Python2的`csv`模塊不支持Unicode輸入。由于Django在內部使用Unicode，這意味著從一些來源比如`HttpRequest`讀出來的字符串可能導致潛在的問題。有一些選項用于處理它： > > + 手動將所有Unicode對象編碼為兼容的編碼。 > + 使用[csv模塊示例章節](https://docs.python.org/library/csv.html#examples)中提供的`UnicodeWriter`類。 > + 使用[python-unicodecsv 模塊](https://github.com/jdunck/python-unicodecsv)，它作為`csv`模塊隨時可用的替代方案，能夠優雅地處理Unicode。 > > 更多信息請見`csv`模塊的Python文檔。 ### 流式傳輸大尺寸CSV文件 ### 當處理生成大尺寸響應的視圖時，你可能想要使用Django的`StreamingHttpResponse`類。例如，通過流式傳輸需要長時間來生成的文件，可以避免負載均衡器在服務器生成響應的時候斷掉連接。在這個例子中，我們利用Python的生成器來有效處理大尺寸CSV文件的拼接和傳輸： ``` import csv from django.utils.six.moves import range from django.http import StreamingHttpResponse class Echo(object): """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模板系統](http://python.usyiyi.cn/django/topics/templates.html)來生成CSV。比起便捷的Python `csv`模板來說，這樣比較低級，但是為了完整性，這個解決方案還是在這里展示一下。它的想法是，傳遞一個項目的列表給你的模板，并且讓模板在`for`循環中輸出逗號。這里是一個例子，它像上面一樣生成相同的CSV文件： ``` from django.http import HttpResponse from django.template import loader, Context 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 = Context({ '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來說，這里并沒有什么特別之處 -- 只是特定了輸出格式。你可以使用這些技巧中的任何一個，來輸出任何你想要的，基于文本的格式。你也可以使用相似的技巧來生成任意的二進制數據。例子請參見[在Django中輸出PDF](http://python.usyiyi.cn/django/howto/outputting-pdf.html)。 > 譯者：[Django 文檔協作翻譯小組](http://python.usyiyi.cn/django/index.html)，原文：[Generating CSV](https://docs.djangoproject.com/en/1.8/howto/outputting-csv/)。 > > 本文以 [CC BY-NC-SA 3.0](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/) 協議發布，轉載請保留作者署名和文章出處。 > > [Django 文檔協作翻譯小組](http://python.usyiyi.cn/django/index.html)人手緊缺，有興趣的朋友可以加入我們，完全公益性質。交流群：467338606。 {% endraw %}