Escribir archivos CSV en Python

En este tutorial, aprenderemos a escribir archivos CSV con diferentes formatos en Python con la ayuda de ejemplos.

Vamos a utilizar exclusivamente el csvmódulo integrado en Python para esta tarea. Pero primero, tendremos que importar el módulo como:

 import csv 

Ya hemos cubierto los conceptos básicos de cómo usar el csvmódulo para leer y escribir en archivos CSV. Si no tiene idea sobre cómo usar el csvmódulo, consulte nuestro tutorial sobre Python CSV: Leer y escribir archivos CSV

Uso básico de csv.writer ()

Veamos un ejemplo básico de uso csv.writer()para actualizar su conocimiento existente.

Ejemplo 1: escribir en archivos CSV con csv.writer ()

Supongamos que queremos escribir un archivo CSV con las siguientes entradas:

 SN, Nombre, Contribución 1, Linus Torvalds, Linux Kernel 2, Tim Berners-Lee, World Wide Web 3, Guido van Rossum, Programación Python 

Así es como lo hacemos.

 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")) 

Cuando ejecutamos el programa anterior, se crea un archivo innovators.csv en el directorio de trabajo actual con las entradas dadas.

Aquí, hemos abierto el archivo innovators.csv en modo de escritura usando open()function.

Para obtener más información sobre cómo abrir archivos en Python, visite: Entrada / Salida de archivos de Python

A continuación, la csv.writer()función se utiliza para crear un writerobjeto. La writer.writerow()función se utiliza para escribir una sola fila en el archivo CSV.

Ejemplo 2: escribir varias filas con writerows ()

Si necesitamos escribir el contenido de la lista bidimensional en un archivo CSV, así es como podemos hacerlo.

 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 salida del programa es la misma que en el Ejemplo 1 .

Aquí, nuestra lista bidimensional se pasa a la writer.writerows()función para escribir el contenido de la lista en el archivo CSV.

Ahora veamos cómo podemos escribir archivos CSV en diferentes formatos. Luego aprenderemos cómo personalizar la csv.writer()función para escribirlos.

Archivos CSV con delimitadores personalizados

De forma predeterminada, se utiliza una coma como delimitador en un archivo CSV. Sin embargo, algunos archivos CSV pueden usar delimitadores que no sean una coma. Son pocos los populares |y .

Suponga que queremos usarlo |como delimitador en el archivo innovators.csv del Ejemplo 1 . Para escribir este archivo, podemos pasar un delimiterparámetro adicional a la csv.writer()función.

Pongamos un ejemplo.

Ejemplo 3: escribir un archivo CSV con delimitador de tubería

 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) 

Salida

 SN | Nombre | Contribución 1 | Linus Torvalds | Kernel de Linux 2 | Tim Berners-Lee | World Wide Web 3 | Guido van Rossum | Programación Python 

Como podemos ver, el parámetro opcional delimiter = '|'ayuda a especificar el writerobjeto que debe tener el archivo CSV |como delimitador.

Archivos CSV con cotizaciones

Algunos archivos CSV tienen comillas alrededor de todas o algunas de las entradas.

Tomemos quotes.csv como ejemplo, con las siguientes entradas:

 "SN"; "Nombre"; "Citas" 1; "Buda"; "Lo que creemos que nos convertimos" 2; "Mark Twain"; "Nunca te arrepientas de nada que te haya hecho sonreír" 3; "Oscar Wilde"; "Sé tú mismo todos los demás ya están ocupados " 

El uso csv.writer()predeterminado no agregará estas comillas a las entradas.

Para agregarlos, tendremos que usar otro parámetro opcional llamado quoting.

Tomemos un ejemplo de cómo se pueden usar las comillas alrededor de los valores no numéricos y ;como delimitadores.

Ejemplo 4: escribir archivos CSV con comillas

 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) 

Salida

 "SN"; "Nombre"; "Citas" 1; "Buda"; "Lo que creemos que nos convertimos" 2; "Mark Twain"; "Nunca te arrepientas de nada que te haya hecho sonreír" 3; "Oscar Wilde"; "Sé tú mismo todos los demás ya están ocupados " 

Aquí, el archivo quotes.csv se crea en el directorio de trabajo con las entradas anteriores.

Como puede ver, hemos pasado csv.QUOTE_NONNUMERICal quotingparámetro. Es una constante definida por el csvmódulo.

csv.QUOTE_NONNUMERICespecifica el writerobjeto al que se deben agregar comillas alrededor de las entradas no numéricas.

Hay otras 3 constantes predefinidas que puede pasar al quotingparámetro:

  • csv.QUOTE_ALL- Especifica el writerobjeto para escribir un archivo CSV con comillas alrededor de todas las entradas.
  • csv.QUOTE_MINIMAL- Especifica el writerobjeto para citar solo aquellos campos que contienen caracteres especiales ( delimitador , quotechar o cualquier carácter en lineterminator )
  • csv.QUOTE_NONE- Especifica el writerobjeto en el que no se debe citar ninguna de las entradas. Es el valor predeterminado.

Archivos CSV con carácter de comillas personalizado

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.

Lectura recomendada: leer archivos CSV en Python

Articulos interesantes...