Dokumen ini menjelaskan bagaimana keluaran CSV (Comma Separated Values) secara dinamis menggunakan tampilan Django. Untuk melakukan ini, anda dapat salah satu menggunakan pustaka CSV Python atau sistem cetakan Django.
\nPython datang dengan pustaka CSV, csv. Kunci menggunakannya dengan Django adalah csv kemampuan modul pembuatan-CSV bertindak pada obyek seperti-berkas, dan obyek HttpResponse Django adalah obyek seperti-berkas.
Ini adalah sebuah contoh:
\nimport csv\nfrom django.http import HttpResponse\n\n\ndef some_view(request):\n # Create the HttpResponse object with the appropriate CSV header.\n response = HttpResponse(\n content_type="text/csv",\n headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},\n )\n\n writer = csv.writer(response)\n writer.writerow(["First row", "Foo", "Bar", "Baz"])\n writer.writerow(["Second row", "A", "B", "C", '"Testing"', "Here's a quote"])\n\n return response\nKode dan komentar seharunya sudah cukup jelas, tetapi sedikit hal pantas disebut:
\nTanggapan mendapatkan jenis MIME khusus, mimetype:text/csv. Ini memberitahu perambah bahwa dokumen adalah sebuah berkas CSV, daripada sebuah berkas HTML. Jika anda mengosongkan ini, perambah akan kemungkinan mentafsirkan keluaran sebagai HTML, yang akan menghasilkan buruk, uraian berbelit-belit yang menakutkan dalam jendela perambah.
Tanggapan mendapatkan sebuah kepala Content-Disposition tambahan, yang mengandung nama dari berkas CSV. Berkas nama ini berubah-ubah; panggil dia kapanpun anda inginkan. DIa akan digunakan oleh perambah dalam dialog "Save as...", dll.
Anda bisa mengait kedalam API pembangkitan-CSV dengan melewatkan response sebagai argumen pertama pada csv.writer. Fungsi csv.writer mengharapkan obyek seperti-berkas, dan obyek HttpResponse sesuai dengan tagihan.
Untuk setiap baris dalam berkas CSV anda, panggil writer.writerow, melewati sebuah iterable.
Modul CSV mengatasi kutipan untuk anda, sehingga anda tidak perlu khawatir tentang pelolosan string dengan kutip atau koma. Lewati writerow() string mentah anda, dan itu akan melakukan hal yang benar.
Ketika berurusan dengan tampilan yang membangkitkan tanggapan yang sangat besar, anda mungkin ingin mempertimbangkan menggunakan StreamingHttpResponse Django. Sebagai contoh, dengan mengalirkan sebuah berkas yang memakan waktu lama untuk membangkitkan anda dapat menghindari penyeimbang memuat menjatuhkan hubungan yang mungkin telah dinyatakan habis selagi peladen membangkitkan tanggapan.
Dalam contoh ini, kami membuat penggunaan penuh dari pembangkit Python untuk secara efisien menangani rakitan dan perpindahan dari berkas CSV besar:
\nimport csv\n\nfrom django.http import StreamingHttpResponse\n\n\nclass Echo:\n """An object that implements just the write method of the file-like\n interface.\n """\n\n def write(self, value):\n """Write the value by returning it, instead of storing in a buffer."""\n return value\n\n\ndef some_streaming_csv_view(request):\n """A view that streams a large CSV file."""\n # Generate a sequence of rows. The range is based on the maximum number of\n # rows that can be handled by a single sheet in most spreadsheet\n # applications.\n rows = (["Row {}".format(idx), str(idx)] for idx in range(65536))\n pseudo_buffer = Echo()\n writer = csv.writer(pseudo_buffer)\n return StreamingHttpResponse(\n (writer.writerow(row) for row in rows),\n content_type="text/csv",\n headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},\n )\nKalau tidak, anda dapat menggunakan Django template system untuk membangkitkan CSV. Ini adalah tingkatan lebih rendah daripada menggunakan modul csv mudah Python, tetapi pemecahannya adalah membawakannya kesini untuk kelengkapan.
Ide disini adalah melewatkan sebuah daftar dari barang-barang ke cetakan anda, dan mempunyai keluaran cetakan koma di for untuk berulang.
Ini adalah contoh, yang akan membangkitkan berkas CSV sama seperti diatas:
\nfrom django.http import HttpResponse\nfrom django.template import loader\n\n\ndef some_view(request):\n # Create the HttpResponse object with the appropriate CSV header.\n response = HttpResponse(\n content_type="text/csv",\n headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},\n )\n\n # The data is hardcoded here, but you could load it from a database or\n # some other source.\n csv_data = (\n ("First row", "Foo", "Bar", "Baz"),\n ("Second row", "A", "B", "C", '"Testing"', "Here's a quote"),\n )\n\n t = loader.get_template("my_template_name.txt")\n c = {"data": csv_data}\n response.write(t.render(c))\n return response\nSatu-satunya perbedaan diantara contoh ini dan contoh sebelumnya adalah bahwa satu ini menggunakan cetakan memuat daripada modul CSV. Sisa dari kode -- seperti content_type='text/csv' -- adalah sama.
Kemudian, buat cetakan my_template_name.txt, dengan kode cetakan ini:
{% for row in data %}"{{ row.0|addslashes }}", "{{ row.1|addslashes }}", "{{ row.2|addslashes }}", "{{ row.3|addslashes }}", "{{ row.4|addslashes }}"\n{% endfor %}\nCetakan pendek ini berulang terhadap data diberikan dan menampilkan baris CSV untuk setiap baris. Itu menggunakan penyaring cetakan addslashes untuk memastikan tidak ada masalah dengan kutipan.
Perhatikan bahwa tidak ada banyak spesifik pada CSV disini -- cukup bentuk keluaran spesifik. Anda dapat menggunakan salah satu dari teknik ini untuk mengeluarkan bentuk berdasarkan-teks apapun anda impikan. Anda dapat juga menggunakan teknik yang mirip untuk membangkitkan data biner berubah-ubah; lihat Bagaimana membuat berkas PDF untuk sebuah contoh.
\n