Запись:
writelines()

Категория

Файлы

Уровень

Базовый

Связанные темы

Списки, генераторы, join()

Зачем это знать

Записывать коллекцию строк одним вызовом

§1Что делает метод

writelines(lines) принимает последовательность строк и записывает их подряд. По сути это цикл из главы 8.6, свёрнутый в один вызов.

for line in lines:        то же самое, что
    file.write(line)      file.writelines(lines)

Обратите внимание на правую часть схемы: в цикле не было + "\n". Это и есть источник главного недоразумения.

§2Ловушка названия

Название подсказывает, что метод пишет «строки файла» — то есть разделяет их. Это не так.

lines = ["первая", "вторая", "третья"]

with open("demo.txt", "w", encoding="utf-8") as file:
    file.writelines(lines)

print(repr(open("demo.txt", encoding="utf-8").read()))

'перваявтораятретья'

§3Переводы строк вручную

Чтобы получить настоящие строки файла, символ добавляют к каждому элементу — включением из главы 4.10.

lines = ["первая", "вторая", "третья"]

with open("demo.txt", "w", encoding="utf-8") as file:
    file.writelines([line + "\n" for line in lines])

print(repr(open("demo.txt", encoding="utf-8").read()))

'первая\nвторая\nтретья\n'

Заметьте: перевод строки оказался и после последнего элемента. Обычно это правильно — текстовые файлы принято завершать переводом строки.

§4Что возвращает

В отличие от write(), который возвращал число символов, этот метод не возвращает ничего.

with open("demo.txt", "w", encoding="utf-8") as file:
    result = file.writelines(["a", "b"])

print(result)

None

Если нужно знать объём записанного, его считают заранее: sum(len(line) for line in lines).

§5Принимает любую последовательность

Аргументом может быть не только список — подойдёт любая итерируемая коллекция.

with open("demo.txt", "w", encoding="utf-8") as file:
    file.writelines(("a", "b"))

print(repr(open("demo.txt", encoding="utf-8").read()))

'ab'

§6Только строки

Элементы должны быть строками — ограничение то же, что у write().

with open("demo.txt", "w", encoding="utf-8") as file:
    file.writelines([1, 2])

TypeError: write() argument must be str, not int

Текст ошибки упоминает write(), хотя вызывали writelines(), — потому что метод внутри и вызывает write() для каждого элемента.

§7Генератор вместо списка

Раз подойдёт любая итерируемая коллекция, годится и генераторное выражение из главы 4.10 — тогда промежуточный список не создаётся.

with open("demo.txt", "w", encoding="utf-8") as file:
    file.writelines(str(n) + "\n" for n in range(3))

print(repr(open("demo.txt", encoding="utf-8").read()))

'0\n1\n2\n'

Для больших объёмов это существенно: миллион строк не придётся держать в памяти целиком.

§8writelines() или join()

Тот же результат даёт join() из главы 5.9 в паре с обычным write().

lines = ["первая", "вторая", "третья"]

with open("demo.txt", "w", encoding="utf-8") as file:
    file.write("\n".join(lines) + "\n")

print(repr(open("demo.txt", encoding="utf-8").read()))

'первая\nвторая\nтретья\n'

Разница в разделителе тонкая: join() ставит перевод между строками, поэтому в конце его приходится добавлять отдельно.

§9writelines() или цикл

Третий вариант — обычный цикл из главы 8.6. Он выигрывает, когда каждую строку нужно ещё и обработать.

for line in lines:                  можно фильтровать, считать,
    if line.strip():                 логировать — что угодно
        file.write(line + "\n")

file.writelines(lines)              только запись, ничего больше

Если в теле цикла ничего, кроме write(), — writelines() короче. Как только появляется условие или счётчик, цикл читается лучше.

§10Как выбрать

§11Частые ошибки

§12Проверьте себя

§13Шпаргалка

Итог главы

writelines() записывает последовательность строк одним вызовом и, вопреки названию, переводов строк не добавляет — так задумано ради симметрии с readlines(). Метод принимает любую итерируемую коллекцию, включая генератор, и потому подходит для больших объёмов. Возвращает он None. Для небольших списков нагляднее пара write() и join(), а если строки нужно ещё и обрабатывать — обычный цикл.