Psaní souborů CSV v Pythonu

V tomto tutoriálu se pomocí příkladů naučíme psát soubory CSV v různých formátech v Pythonu.

K csvtomuto úkolu použijeme výhradně modul zabudovaný do Pythonu. Nejprve ale budeme muset modul importovat jako:

 import csv

Již jsme se csvseznámili se základy používání modulu ke čtení a zápisu do souborů CSV. Pokud nemáte ponětí o používání csvmodulu, podívejte se na náš výukový program Python CSV: Čtení a zápis souborů CSV

Základní použití csv.writer ()

Podívejme se na základní příklad použití csv.writer()k aktualizaci vašich stávajících znalostí.

Příklad 1: Zápis do souborů CSV pomocí csv.writer ()

Předpokládejme, že chceme napsat soubor CSV s následujícími položkami:

 SN, Jméno, Příspěvek 1, Linus Torvalds, Linux Kernel 2, Tim Berners-Lee, World Wide Web 3, Guido van Rossum, Programování v Pythonu

Takto to děláme.

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

Když jsme se spustit výše programu se innovators.csv soubor je vytvořen v aktuální pracovní adresář s uvedenými položkami.

Zde jsme otevřeli soubor innovators.csv v režimu psaní pomocí open()funkce.

Další informace o otevírání souborů v Pythonu najdete na stránce: Vstup / výstup souboru Pythonu

Dále se csv.writer()funkce používá k vytvoření writerobjektu. writer.writerow()Funkce je pak použit k napsání jediné řádky do souboru CSV.

Příklad 2: Zápis více řádků pomocí Writerows ()

Pokud potřebujeme zapsat obsah dvourozměrného seznamu do souboru CSV, můžeme to udělat takto.

 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)

Výstup programu je stejný jako v příkladu 1 .

Zde je náš dvourozměrný seznam předán writer.writerows()funkci, která zapíše obsah seznamu do souboru CSV.

Nyní se podívejme, jak můžeme psát soubory CSV v různých formátech. Poté se naučíme, jak přizpůsobit csv.writer()funkci pro jejich zápis.

Soubory CSV s vlastními oddělovači

Ve výchozím nastavení se v souboru CSV používá jako oddělovač čárka. Některé soubory CSV však mohou používat jiné oddělovače než čárku. Několik populárních je |a .

Předpokládejme, že chceme použít |jako oddělovač v souboru innovators.csv z příkladu 1 . Chcete-li napsat tento soubor, můžeme funkci předat další delimiterparametr csv.writer().

Vezměme si příklad.

Příklad 3: Zápis souboru CSV s oddělovačem potrubí

 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)

Výstup

 SN | Název | Příspěvek 1 | Linus Torvalds | Linuxové jádro 2 | Tim Berners-Lee | World Wide Web 3 | Guido van Rossum | Programování v Pythonu

Jak vidíme, volitelný parametr delimiter = '|'pomáhá určit writerobjekt, který by měl mít soubor CSV |jako oddělovač.

Soubory CSV s uvozovkami

Některé soubory CSV obsahují uvozovky kolem každé nebo některých položek.

Vezměme si jako příklad soubor quotes.csv s následujícími položkami:

 „SN“; „Jméno“; „Citáty“ 1; „Buddha“; „To, o čem si myslíme, že se z nás stane“ 2; „Mark Twain“; „Nikdy nelitujte ničeho, co vás rozesmálo“ 3; „Oscar Wilde“; „Buďte sami sebou všichni ostatní už jsou zadaní"

csv.writer()Výchozí použití tyto citace k položkám nepřidá.

Abychom je mohli přidat, budeme muset použít další volitelný parametr s názvem quoting.

Pojďme si vzít příklad toho, jak lze citovat kolem nečíselných hodnot a ;jako oddělovače.

Příklad 4: Zápis souborů CSV s uvozovkami

 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)

Výstup 

 „SN“; „Jméno“; „Citáty“ 1; „Buddha“; „To, o čem si myslíme, že se z nás stane“ 2; „Mark Twain“; „Nikdy nelitujte ničeho, co vás rozesmálo“ 3; „Oscar Wilde“; „Buďte sami sebou všichni ostatní už jsou zadaní"

Zde se v pracovním adresáři vytvoří soubor quotes.csv s výše uvedenými položkami.

Jak vidíte, jsme přešli csv.QUOTE_NONNUMERICna quotingparametru. Je to konstanta definovaná csvmodulem.

csv.QUOTE_NONNUMERICUrčuje writerobjekt, který by měl být přidán do uvozovek kolem nečíselných položek.

K quotingparametru můžete předat další 3 předdefinované konstanty :

  • csv.QUOTE_ALL- Určuje writerobjekt pro zápis souboru CSV s uvozovkami kolem všech položek.
  • csv.QUOTE_MINIMAL- Určuje writerobjekt, který bude citovat pouze ta pole, která obsahují speciální znaky ( oddělovač , quechar nebo jakékoli znaky v lineterminátoru )
  • csv.QUOTE_NONE- Určuje writerobjekt, u kterého by neměla být citována žádná z položek. Je to výchozí hodnota.

Soubory CSV s vlastními uvozovkami

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.

Doporučené čtení: Číst soubory CSV v Pythonu

Zajímavé články...