Написание файлов CSV на Python

Содержание

Базовое использование csv.writer ()
Файлы CSV с настраиваемыми разделителями
CSV-файлы с котировками
CSV-файлы с настраиваемым символом цитирования
Dialects in CSV module
Write CSV files with csv.DictWriter()
CSV files with lineterminator
doublequote & escapechar in CSV module

В этом руководстве мы научимся писать файлы CSV в разных форматах на Python с помощью примеров.

Мы собираемся использовать csvдля этой задачи исключительно модуль, встроенный в Python. Но сначала нам нужно будет импортировать модуль как:

 import csv

Мы уже рассмотрели основы того, как использовать csvмодуль для чтения и записи в файлы CSV. Если вы не знаете, как использовать csvмодуль, ознакомьтесь с нашим руководством по Python CSV: чтение и запись файлов CSV.

Базовое использование csv.writer ()

Давайте посмотрим на базовый пример использования, csv.writer()чтобы освежить ваши знания.

Пример 1. Запись в файлы CSV с помощью csv.writer ()

Предположим, мы хотим написать CSV-файл со следующими записями:

 SN, имя, вклад 1, Линус Торвальдс, ядро Linux 2, Тим Бернерс-Ли, World Wide Web 3, Гвидо ван Россум, программирование на Python

Вот как мы это делаем.

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

Когда мы запускаем указанную выше программу, в текущем рабочем каталоге создается файл Innovators.csv с заданными записями.

Здесь мы открыли файл Innovators.csv в режиме записи с помощью open()функции.

Чтобы узнать больше об открытии файлов в Python, посетите: Python File Input / Output

Далее csv.writer()функция используется для создания writerобъекта. Затем writer.writerow()функция используется для записи отдельных строк в файл CSV.

Пример 2: Написание нескольких строк с помощью writerows ()

Если нам нужно записать содержимое двумерного списка в файл CSV, вот как мы можем это сделать.

 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)

Вывод программы такой же, как в Примере 1 .

Здесь наш двухмерный список передается writer.writerows()функции для записи содержимого списка в файл CSV.

Теперь давайте посмотрим, как мы можем писать файлы CSV в разных форматах. Затем мы узнаем, как настроить csv.writer()функцию для их записи.

Файлы CSV с настраиваемыми разделителями

По умолчанию в CSV-файле в качестве разделителя используется запятая. Однако в некоторых файлах CSV могут использоваться другие разделители, кроме запятой. Немногие популярные - это |и .

Предположим, мы хотим использовать |в качестве разделителя в файле Innovators.csv из Примера 1 . Чтобы записать этот файл, мы можем передать функции дополнительный delimiterпараметр csv.writer().

Возьмем пример.

Пример 3: запись файла CSV с разделителем каналов

 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)

Вывод

 SN | Имя | Вклад 1 | Линус Торвальдс | Ядро Linux 2 | Тим Бернерс-Ли | World Wide Web 3 | Гвидо ван Россум | Программирование на Python

Как мы видим, необязательный параметр delimiter = '|'помогает указать writerобъект, который должен быть в CSV-файле |в качестве разделителя.

CSV-файлы с котировками

В некоторых файлах CSV есть кавычки вокруг каждой или некоторых записей.

В качестве примера возьмем файл quotes.csv со следующими записями:

 «SN»; «Имя»; «Цитаты» 1; «Будда»; «То, чем мы думаем, мы стали» 2; «Марк Твен»; «Никогда не сожалей ни о чем, что заставило тебя улыбнуться» 3; «Оскар Уайльд»; «Будь собой все остальные уже заняты"

Использование csv.writer()по умолчанию не добавляет эти кавычки к записям.

Чтобы добавить их, нам нужно будет использовать еще один необязательный параметр с именем quoting.

Давайте рассмотрим пример того, как можно использовать кавычки вокруг нечисловых значений и в ;качестве разделителей.

Пример 4. Запишите CSV-файлы с кавычками

 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)

Вывод

 «SN»; «Имя»; «Цитаты» 1; «Будда»; «То, чем мы думаем, мы стали» 2; «Марк Твен»; «Никогда не сожалей ни о чем, что заставило тебя улыбнуться» 3; «Оскар Уайльд»; «Будь собой все остальные уже заняты"

Здесь в рабочем каталоге создается файл quotes.csv с указанными выше записями.

Как видите, мы перешли csv.QUOTE_NONNUMERICк quotingпараметру. Это константа, определяемая csvмодулем.

csv.QUOTE_NONNUMERICуказывает writerобъект, который следует заключить в кавычки вокруг нечисловых записей.

Есть еще 3 предопределенные константы, которые вы можете передать quotingпараметру:

csv.QUOTE_ALL- Задает writerобъект для записи CSV-файла с кавычками вокруг всех записей.
csv.QUOTE_MINIMAL- Указывает, что writerобъект должен заключать в кавычки только те поля, которые содержат специальные символы ( разделитель , quotechar или любые символы в указателе конца строки )
csv.QUOTE_NONE- Задает writerобъект, для которого не следует цитировать ни одну из записей. Это значение по умолчанию.

CSV-файлы с настраиваемым символом цитирования

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.

Рекомендуемая литература: чтение файлов CSV на Python