Écrire des fichiers CSV en Python

Dans ce tutoriel, nous allons apprendre à écrire des fichiers CSV avec différents formats en Python à l'aide d'exemples.

Nous allons utiliser exclusivement le csvmodule intégré à Python pour cette tâche. Mais d'abord, nous devrons importer le module comme:

 import csv

Nous avons déjà couvert les bases de l'utilisation du csvmodule pour lire et écrire dans des fichiers CSV. Si vous n'avez aucune idée de l'utilisation du csvmodule, consultez notre tutoriel sur Python CSV: Lire et écrire des fichiers CSV

Utilisation basique de csv.writer ()

Examinons un exemple de base d'utilisation csv.writer()pour actualiser vos connaissances existantes.

Exemple 1: écrire dans des fichiers CSV avec csv.writer ()

Supposons que nous voulions écrire un fichier CSV avec les entrées suivantes:

 SN, Nom, Contribution 1, Linus Torvalds, Linux Kernel 2, Tim Berners-Lee, World Wide Web 3, Guido van Rossum, Programmation Python

Voici comment nous procédons.

 import csv with open('innovators.csv', 'w', newline='') as file: writer = csv.writer(file) writer.writerow(("SN", "Name", "Contribution")) writer.writerow((1, "Linus Torvalds", "Linux Kernel")) writer.writerow((2, "Tim Berners-Lee", "World Wide Web")) writer.writerow((3, "Guido van Rossum", "Python Programming"))

Lorsque nous exécutons le programme ci-dessus, un fichier innovators.csv est créé dans le répertoire de travail actuel avec les entrées données.

Ici, nous avons ouvert le fichier innovators.csv en mode écriture à l'aide de open()function.

Pour en savoir plus sur l'ouverture de fichiers en Python, visitez: Entrée / sortie de fichier Python

Ensuite, la csv.writer()fonction est utilisée pour créer un writerobjet. La writer.writerow()fonction est ensuite utilisée pour écrire des lignes uniques dans le fichier CSV.

Exemple 2: écriture de plusieurs lignes avec writerows ()

Si nous devons écrire le contenu de la liste bidimensionnelle dans un fichier CSV, voici comment nous pouvons le faire.

 import csv row_list = (("SN", "Name", "Contribution"), (1, "Linus Torvalds", "Linux Kernel"), (2, "Tim Berners-Lee", "World Wide Web"), (3, "Guido van Rossum", "Python Programming")) with open('protagonist.csv', 'w', newline='') as file: writer = csv.writer(file) writer.writerows(row_list)

La sortie du programme est la même que dans l' exemple 1 .

Ici, notre liste bidimensionnelle est passée à la writer.writerows()fonction pour écrire le contenu de la liste dans le fichier CSV.

Voyons maintenant comment nous pouvons écrire des fichiers CSV dans différents formats. Nous apprendrons ensuite à personnaliser la csv.writer()fonction pour les écrire.

Fichiers CSV avec des délimiteurs personnalisés

Par défaut, une virgule est utilisée comme délimiteur dans un fichier CSV. Cependant, certains fichiers CSV peuvent utiliser des délimiteurs autres qu'une virgule. Rares sont ceux qui sont populaires |et .

Supposons que nous voulions utiliser |comme délimiteur dans le fichier innovators.csv de l' exemple 1 . Pour écrire ce fichier, nous pouvons passer un delimiterparamètre supplémentaire à la csv.writer()fonction.

Prenons un exemple.

Exemple 3: écrire un fichier CSV avec un séparateur de tuyau

 import csv data_list = (("SN", "Name", "Contribution"), (1, "Linus Torvalds", "Linux Kernel"), (2, "Tim Berners-Lee", "World Wide Web"), (3, "Guido van Rossum", "Python Programming")) with open('innovators.csv', 'w', newline='') as file: writer = csv.writer(file, delimiter='|') writer.writerows(data_list)

Production

 SN | Nom | Contribution 1 | Linus Torvalds | Linux Kernel 2 | Tim Berners-Lee | World Wide Web 3 | Guido van Rossum | Programmation Python

Comme nous pouvons le voir, le paramètre facultatif delimiter = '|'permet de spécifier l' writerobjet que le fichier CSV doit avoir |comme délimiteur.

Fichiers CSV avec devis

Certains fichiers CSV ont des guillemets autour de chacune ou de certaines des entrées.

Prenons quotes.csv comme exemple, avec les entrées suivantes:

 "SN"; "Nom"; "Citations" 1; "Bouddha"; "Ce que nous pensons devenir" 2; "Mark Twain"; "Ne regrettez jamais rien qui vous a fait sourire" 3; "Oscar Wilde"; "Soyez vous-même tout le monde est déjà pris"

L'utilisation csv.writer()par défaut n'ajoutera pas ces guillemets aux entrées.

Pour les ajouter, nous devrons utiliser un autre paramètre optionnel appelé quoting.

Prenons un exemple de la façon dont les guillemets peuvent être utilisés autour des valeurs non numériques et ;comme délimiteurs.

Exemple 4: écrire des fichiers CSV avec des guillemets

 import csv row_list = ( ("SN", "Name", "Quotes"), (1, "Buddha", "What we think we become"), (2, "Mark Twain", "Never regret anything that made you smile"), (3, "Oscar Wilde", "Be yourself everyone else is already taken") ) with open('quotes.csv', 'w', newline='') as file: writer = csv.writer(file, quoting=csv.QUOTE_NONNUMERIC, delimiter=';') writer.writerows(row_list)

Production 

 "SN"; "Nom"; "Citations" 1; "Bouddha"; "Ce que nous pensons devenir" 2; "Mark Twain"; "Ne regrettez jamais rien qui vous a fait sourire" 3; "Oscar Wilde"; "Soyez vous-même tout le monde est déjà pris"

Ici, le fichier quotes.csv est créé dans le répertoire de travail avec les entrées ci-dessus.

Comme vous pouvez le voir, nous sommes passés csv.QUOTE_NONNUMERICau quotingparamètre. C'est une constante définie par le csvmodule.

csv.QUOTE_NONNUMERICspécifie l' writerobjet que des guillemets doivent être ajoutés autour des entrées non numériques.

Il existe 3 autres constantes prédéfinies que vous pouvez passer au quotingparamètre:

  • csv.QUOTE_ALL- Spécifie l' writerobjet pour écrire le fichier CSV avec des guillemets autour de toutes les entrées.
  • csv.QUOTE_MINIMAL- Spécifie l' writerobjet pour ne citer que les champs qui contiennent des caractères spéciaux ( délimiteur , quotechar ou tout caractère dans lineterminator )
  • csv.QUOTE_NONE- Spécifie l' writerobjet qu'aucune des entrées ne doit être citée. C'est la valeur par défaut.

Fichiers CSV avec caractère de guillemet personnalisé

We can also write CSV files with custom quoting characters. For that, we will have to use an optional parameter called quotechar.

Let's take an example of writing quotes.csv file in Example 4, but with * as the quoting character.

Example 5: Writing CSV files with custom quoting character

 import csv row_list = ( ("SN", "Name", "Quotes"), (1, "Buddha", "What we think we become"), (2, "Mark Twain", "Never regret anything that made you smile"), (3, "Oscar Wilde", "Be yourself everyone else is already taken") ) with open('quotes.csv', 'w', newline='') as file: writer = csv.writer(file, quoting=csv.QUOTE_NONNUMERIC, delimiter=';', quotechar='*') writer.writerows(row_list)

Output 

 *SN*;*Name*;*Quotes* 1;*Buddha*;*What we think we become* 2;*Mark Twain*;*Never regret anything that made you smile* 3;*Oscar Wilde*;*Be yourself everyone else is already taken*

Here, we can see that quotechar='*' parameter instructs the writer object to use * as quote for all non-numeric values.

Dialects in CSV module

Notice in Example 5 that we have passed multiple parameters (quoting, delimiter and quotechar) to the csv.writer() function.

This practice is acceptable when dealing with one or two files. But it will make the code more redundant and ugly once we start working with multiple CSV files with similar formats.

As a solution to this, the csv module offers dialect as an optional parameter.

Dialect helps in grouping together many specific formatting patterns like delimiter, skipinitialspace, quoting, escapechar into a single dialect name.

It can then be passed as a parameter to multiple writer or reader instances.

Example 6: Write CSV file using dialect

Suppose we want to write a CSV file (office.csv) with the following content:

 "ID"|"Name"|"Email" "A878"|"Alfonso K. Hamby"|"[email protected]" "F854"|"Susanne Briard"|"[email protected]" "E833"|"Katja Mauer"|"[email protected]"

The CSV file has quotes around each entry and uses | as a delimiter.

Instead of passing two individual formatting patterns, let's look at how to use dialects to write this file.

 import csv row_list = ( ("ID", "Name", "Email"), ("A878", "Alfonso K. Hamby", "[email protected]"), ("F854", "Susanne Briard", "[email protected]"), ("E833", "Katja Mauer", "[email protected]") ) csv.register_dialect('myDialect', delimiter='|', quoting=csv.QUOTE_ALL) with open('office.csv', 'w', newline='') as file: writer = csv.writer(file, dialect='myDialect') writer.writerows(row_list)

Output 

 "ID"|"Name"|"Email" "A878"|"Alfonso K. Hamby"|"[email protected]" "F854"|"Susanne Briard"|"[email protected]" "E833"|"Katja Mauer"|"[email protected]"

Here, office.csv is created in the working directory with the above contents.

From this example, we can see that the csv.register_dialect() function is used to define a custom dialect. Its syntax is:

 csv.register_dialect(name(, dialect(, **fmtparams)))

The custom dialect requires a name in the form of a string. Other specifications can be done either by passing a sub-class of the Dialect class, or by individual formatting patterns as shown in the example.

While creating the writer object, we pass dialect='myDialect' to specify that the writer instance must use that particular dialect.

The advantage of using dialect is that it makes the program more modular. Notice that we can reuse myDialect to write other CSV files without having to re-specify the CSV format.

Write CSV files with csv.DictWriter()

The objects of csv.DictWriter() class can be used to write to a CSV file from a Python dictionary.

The minimal syntax of the csv.DictWriter() class is:

 csv.DictWriter(file, fieldnames)

Here,

  • file - CSV file where we want to write to
  • fieldnames - a list object which should contain the column headers specifying the order in which data should be written in the CSV file

Example 7: Python csv.DictWriter()

 import csv with open('players.csv', 'w', newline='') as file: fieldnames = ('player_name', 'fide_rating') writer = csv.DictWriter(file, fieldnames=fieldnames) writer.writeheader() writer.writerow(('player_name': 'Magnus Carlsen', 'fide_rating': 2870)) writer.writerow(('player_name': 'Fabiano Caruana', 'fide_rating': 2822)) writer.writerow(('player_name': 'Ding Liren', 'fide_rating': 2801))

Output

The program creates a players.csv file with the following entries:

 player_name,fide_rating Magnus Carlsen,2870 Fabiano Caruana,2822 Ding Liren,2801

The full syntax of the csv.DictWriter() class is:

 csv.DictWriter(f, fieldnames, restval='', extrasaction='raise', dialect='excel', *args, **kwds)

To learn more about it in detail, visit: Python csv.DictWriter() class

CSV files with lineterminator

A lineterminator is a string used to terminate lines produced by writer objects. The default value is . You can change its value by passing any string as a lineterminator parameter.

However, the reader object only recognizes or as lineterminator values. So using other characters as line terminators is highly discouraged.

doublequote & escapechar in CSV module

In order to separate delimiter characters in the entries, the csv module by default quotes the entries using quotation marks.

So, if you had an entry: He is a strong, healthy man, it will be written as: "He is a strong, healthy man".

Similarly, the csv module uses double quotes in order to escape the quote character present in the entries by default.

If you had an entry: Go to "programiz.com", it would be written as: "Go to ""programiz.com""".

Here, we can see that each " is followed by a " to escape the previous one.

doublequote

It handles how quotechar present in the entry themselves are quoted. When True, the quoting character is doubled and when False, the escapechar is used as a prefix to the quotechar. By default its value is True.

escapechar

escapechar parameter is a string to escape the delimiter if quoting is set to csv.QUOTE_NONE and quotechar if doublequote is False. Its default value is None.

Example 8: Using escapechar in csv writer

 import csv row_list = ( ('Book', 'Quote'), ('Lord of the Rings', '"All we have to decide is what to do with the time that is given us."'), ('Harry Potter', '"It matters not what someone is born, but what they grow to be."') ) with open('book.csv', 'w', newline='') as file: writer = csv.writer(file, escapechar='/', quoting=csv.QUOTE_NONE) writer.writerows(row_list)

Output 

 Book,Quote Lord of the Rings,/"All we have to decide is what to do with the time that is given us./" Harry Potter,/"It matters not what someone is born/, but what they grow to be./"

Here, we can see that / is prefix to all the " and , because we specified quoting=csv.QUOTE_NONE.

If it wasn't defined, then, the output would be:

 Book,Quote Lord of the Rings,"""All we have to decide is what to do with the time that is given us.""" Harry Potter,"""It matters not what someone is born, but what they grow to be."""

Since we allow quoting, the entries with special characters(" in this case) are double-quoted. The entries with delimiter are also enclosed within quote characters.(Starting and closing quote characters)

The remaining quote characters are to escape the actual " present as part of the string, so that they are not interpreted as quotechar.

Note: The csv module can also be used for other file extensions (like: .txt) as long as their contents are in proper structure.

Lecture recommandée: lire des fichiers CSV en Python

Articles intéressants...