Ce document explique comment produire dynamiquement du contenu CSV (Comma Separated Values) en utilisant des vues Django. Pour cela, vous pouvez soit utiliser la bibliothèque CSV de Django, soit le système de gabarits de Django.
\nPython contient une bibliothèque CSV, csv. L’élément clé dans son utilisation avec Django est que les fonctionnalités de création de CSV du module csv agissent sur des objets de type fichier, et les objets HttpResponse de Django sont justement des objets de type fichier.
Voici un exemple :
\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\nLe code et les commentaires sont assez explicites, mais certains points méritent un éclaircissement :
\nLa réponse est initialisée avec un type MIME spécial, text/csv. Ceci indique aux navigateurs que le document est un fichier CSV, et non pas un fichier HTML. Si vous omettiez ce paramètre, les navigateurs interpréteraient probablement le contenu comme du HTML, ce qui résulterait en un affichage cryptique aux allures de code secret.
L’en-tête Content-Disposition de la réponse est aussi défini avec le nom du fichier CSV. Ce nom est totalement arbitraire, donnez-lui le nom que vous voulez. Il sera notamment utilisé par les navigateurs dans la boîte de dialogue « Enregistrer sous ».
Il est possible de se brancher à l’API de génération de CSV en passant response comme premier paramètre à csv.writer. La fonction csv.writer s’attend à un objet de type fichier et HttpResponse joue très bien ce rôle.
Pour chaque ligne de votre fichier CSV, appelez writer.writerow en lui passant un objet itérable.
Le module CSV s’occupe des guillemets, vous n’avez donc pas besoin de vous soucier d’échapper les chaînes contenant des guillemets ou des virgules. Passez vos chaînes brutes à writerow() et il s’occupera de faire ce qu’il faut.
Lorsque vous avez affaire à des vues qui génèrent des réponses très grandes, il faut considérer l’utilisation de réponses StreamingHttpResponse. Par exemple, avec la diffusion continue d’un fichier qui prend beaucoup de temps à générer, vous pouvez éviter la perte de connexion de l’équilibreur de charge qui, autrement, aurait expiré pendant que le serveur générait la réponse.
Dans cet exemple, nous utilisons pleinement les générateurs Python pour gérer efficacement l’assemblage et la transmission d’un fichier CSV volumineux :
\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 )\nVous avez aussi la possibilité d’utiliser le système de gabarits de Django pour produire le CSV. Cette technique est de plus bas niveau que l’utilisation du module Python csv, mais cette alternative est présentée ici par souci d’exhaustivité.
L’idée ici est de passer une liste d’éléments à un gabarit qui se chargera de générer les virgules dans une boucle for.
Voici un exemple qui génère le même fichier CSV que ci-dessus :
\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 hard-coded 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\nLa seule différence entre cet exemple et le précédent est que celui-ci utilise le chargement d’un gabarit à la place du module CSV. Le reste du code (comme content_type='text/csv') est identique.
Puis, créez le gabarit my_template_name.txt avec ce contenu :
{% for row in data %}"{{ row.0|addslashes }}", "{{ row.1|addslashes }}", "{{ row.2|addslashes }}", "{{ row.3|addslashes }}", "{{ row.4|addslashes }}"\n{% endfor %}\nCe court gabarit parcourt les données reçues et affiche une ligne de CSV pour chaque ligne. Il utilise le filtre de gabarit addslashes pour s’assurer qu’il n’y aura pas de problèmes avec les guillemets.
Vous constaterez que ces exemples ne contiennent pas beaucoup de code spécifique au format CSV, uniquement le format de sortie spécifique. Vous pouvez donc employer l’une de ces techniques pour générer tout autre format basé sur du texte. Vous pouvez aussi utiliser des techniques semblables pour produire n’importe quel contenu binaire ; consultez Création de fichiers PDF pour voir un exemple.
\n