Detta dokument förklarar hur man dynamiskt skriver ut CSV (Comma Separated Values) med hjälp av Django-vyer. För att göra detta kan du antingen använda Pythons CSV-bibliotek eller Djangos mallsystem.
\nPython levereras med ett CSV-bibliotek, csv. Nyckeln till att använda det med Django är att csv-modulens CSV-skapande kapacitet fungerar på filliknande objekt, och Djangos HttpResponse-objekt är filliknande objekt.
Här är ett exempel:
\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\nKoden och kommentarerna borde vara självförklarande, men det finns några saker som förtjänar att nämnas:
\nSvaret får en speciell MIME-typ, text/csv. Detta talar om för webbläsarna att dokumentet är en CSV-fil, snarare än en HTML-fil. Om du utelämnar detta kommer webbläsarna förmodligen att tolka utdata som HTML, vilket resulterar i ful, skrämmande gobbledygook i webbläsarfönstret.
Svaret får ytterligare en Content-Disposition header, som innehåller namnet på CSV-filen. Detta filnamn är godtyckligt; kalla det vad du vill. Det kommer att användas av webbläsare i dialogrutan ”Spara som…” etc.
Du kan koppla in dig på CSV-generering API genom att skicka response som det första argumentet till csv.writer. Funktionen csv.writer förväntar sig ett filliknande objekt, och HttpResponse-objekt passar bra.
För varje rad i CSV-filen anropar du writer.writerow och ger den en iterable.
CSV-modulen tar hand om citering åt dig, så du behöver inte oroa dig för att undkomma strängar med citattecken eller kommatecken i dem. Skicka dina råa strängar till writerow() så gör den det rätta.
När du hanterar vyer som genererar mycket stora svar kanske du vill överväga att använda Djangos StreamingHttpResponse istället. Genom att strömma en fil som tar lång tid att generera kan du till exempel undvika att en lastbalanserare tappar en anslutning som annars skulle ha avbrutits medan servern genererade svaret.
In this example, we make full use of Python generators to efficiently handle\nthe assembly and transmission of a large CSV file. Rows are batched together\nto reduce HTTP overhead and improve compression efficiency when used with\nGZipMiddleware:
import csv\nfrom itertools import batched\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\n def stream_batched_rows():\n for batch in batched(rows, 100):\n yield "".join(writer.writerow(row) for row in batch)\n\n return StreamingHttpResponse(\n stream_batched_rows(),\n content_type="text/csv",\n headers={"Content-Disposition": 'attachment; filename="somefilename.csv"'},\n )\nAlternativt kan du använda Django mallsystem för att generera CSV. Detta är på en lägre nivå än att använda den praktiska Python csv-modulen, men lösningen presenteras här för fullständighetens skull.
Tanken här är att skicka en lista med objekt till din mall och låta mallen mata ut kommatecken i en for-loop.
Här är ett exempel som genererar samma CSV-fil som ovan:
\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\nDen enda skillnaden mellan det här exemplet och det föregående är att det här exemplet använder template loading i stället för CSV-modulen. Resten av koden - till exempel content_type='text/csv' - är densamma.
Skapa sedan mallen my_template_name.txt, med denna mallkod:
{% for row in data %}"{{ row.0|addslashes }}", "{{ row.1|addslashes }}", "{{ row.2|addslashes }}", "{{ row.3|addslashes }}", "{{ row.4|addslashes }}"\n{% endfor %}\nDenna korta mall itererar över de angivna data och visar en rad CSV för varje rad. Den använder mallfiltret addslashes för att säkerställa att det inte finns några problem med citattecken.
Observera att det inte finns så mycket specifikt för CSV här - bara det specifika utdataformatet. Du kan använda någon av dessa tekniker för att mata ut vilket textbaserat format som helst som du kan drömma om. Du kan också använda en liknande teknik för att generera godtyckliga binära data; se Så här skapar du PDF-filer för ett exempel.
\n