Pisanie plików CSV w Pythonie

W tym samouczku nauczymy się pisać pliki CSV w różnych formatach w Pythonie na przykładach.

Do csvtego zadania będziemy używać wyłącznie modułu wbudowanego w Python. Ale najpierw będziemy musieli zaimportować moduł jako:

 import csv 

Omówiliśmy już podstawy korzystania z csvmodułu do odczytu i zapisu w plikach CSV. Jeśli nie masz pomysłu na korzystanie z csvmodułu, zapoznaj się z naszym samouczkiem na temat Python CSV: Odczytywanie i zapisywanie plików CSV

Podstawowe użycie csv.writer ()

Spójrzmy na podstawowy przykład użycia csv.writer()do odświeżenia istniejącej wiedzy.

Przykład 1: Zapisz do plików CSV za pomocą csv.writer ()

Załóżmy, że chcemy napisać plik CSV z następującymi wpisami:

 SN, nazwa, wkład 1, Linus Torvalds, Linux Kernel 2, Tim Berners-Lee, World Wide Web 3, Guido van Rossum, Programowanie w Pythonie 

Oto jak to robimy.

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

Kiedy uruchamiamy powyższy program, w bieżącym katalogu roboczym z podanymi wpisami tworzony jest plik innovators.csv .

Tutaj otworzyliśmy plik innovators.csv w trybie pisania przy użyciu open()funkcji.

Aby dowiedzieć się więcej o otwieraniu plików w Pythonie, odwiedź: Python File Input / Output

Następnie csv.writer()funkcja służy do tworzenia writerobiektu. writer.writerow()Funkcja jest następnie używany do pisania pojedyncze wiersze do pliku CSV.

Przykład 2: Pisanie wielu wierszy za pomocą funkcji writerows ()

Jeśli musimy zapisać zawartość dwuwymiarowej listy do pliku CSV, oto jak możemy to zrobić.

 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) 

Wynik programu jest taki sam, jak w przykładzie 1 .

Tutaj nasza dwuwymiarowa lista jest przekazywana do writer.writerows()funkcji zapisującej zawartość listy do pliku CSV.

Zobaczmy teraz, jak możemy pisać pliki CSV w różnych formatach. Dowiemy się wtedy, jak dostosować csv.writer()funkcję, aby je napisać.

Pliki CSV z niestandardowymi separatorami

Domyślnie przecinek jest używany jako separator w pliku CSV. Jednak w niektórych plikach CSV mogą być używane separatory inne niż przecinek. Niewiele popularnych to |i .

Załóżmy, że chcemy użyć |jako separatora w pliku innovators.csv z przykładu 1 . Aby zapisać ten plik, możemy przekazać delimiterdo csv.writer()funkcji dodatkowy parametr .

Weźmy przykład.

Przykład 3: Napisz plik CSV z ogranicznikiem potoku

 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) 

Wynik

 SN | Nazwa | Wkład 1 | Linus Torvalds | Linux Kernel 2 | Tim Berners-Lee | World Wide Web 3 | Guido van Rossum | Programowanie w Pythonie 

Jak widać, opcjonalny parametr delimiter = '|'pomaga określić writerobiekt, który plik CSV powinien mieć |jako separator.

Pliki CSV z cytatami

Niektóre pliki CSV mają cudzysłowy wokół każdego lub niektórych wpisów.

Weźmy jako przykład quotes.csv z następującymi wpisami:

 „SN”; „Imię”; „Cytaty” 1; „Budda”; „Tym, czym myślimy, że się stajemy” 2; „Mark Twain”; „Nigdy nie żałuj niczego, co sprawiło, że się uśmiechałeś” 3; „Oscar Wilde”; „Bądź sobą wszyscy inni są już zajęci ” 

Użycie csv.writer()domyślnie nie spowoduje dodania tych cudzysłowów do wpisów.

Aby je dodać, będziemy musieli użyć innego opcjonalnego parametru o nazwie quoting.

Weźmy przykład, jak można zastosować cytowanie wokół wartości nienumerycznych i ;jako ograniczników.

Przykład 4: Napisz pliki CSV z cudzysłowami

 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) 

Wynik

 „SN”; „Imię”; „Cytaty” 1; „Budda”; „Tym, czym myślimy, że się stajemy” 2; „Mark Twain”; „Nigdy nie żałuj niczego, co sprawiło, że się uśmiechałeś” 3; „Oscar Wilde”; „Bądź sobą wszyscy inni są już zajęci ” 

Tutaj plik quotes.csv jest tworzony w katalogu roboczym zawierającym powyższe wpisy.

Jak widać, mamy przeszedł csv.QUOTE_NONNUMERICdo quotingparametru. Jest to stała definiowana przez csvmoduł.

csv.QUOTE_NONNUMERICokreśla writerobiekt, do którego należy dodać cudzysłowy wokół pozycji nienumerycznych.

Istnieją 3 inne predefiniowane stałe, które można przekazać do quotingparametru:

  • csv.QUOTE_ALL- Określa writerobiekt do zapisania pliku CSV z cudzysłowami wokół wszystkich wpisów.
  • csv.QUOTE_MINIMAL- Określa writerobiekt, aby cytować tylko te pola, które zawierają znaki specjalne ( separator , cudzysłów lub dowolne znaki w wyznaczniku linii )
  • csv.QUOTE_NONE- określa writerobiekt, którego nie należy cytować w żadnym z wpisów. Jest to wartość domyślna.

Pliki CSV z niestandardowym cudzysłowem

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.

Zalecana lektura: Przeczytaj pliki CSV w języku Python

Interesujące artykuły...