Режим x:
создание файла

Категория

Файлы

Уровень

Базовый

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

Режимы открытия, исключения

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

Гарантированно не перезаписать существующий файл

§1Проблема режима w

Глава 8.6 показала: open(path, "w") стирает содержимое в момент открытия. Если программа создаёт файл отчёта, а такой файл уже есть, прежние данные исчезнут — без предупреждения и без возможности вернуть.

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

§2Как работает режим x

Режим "x" — от exclusive creation, «исключительное создание». Он создаёт файл и открывает его на запись.

with open("newfile.txt", "x", encoding="utf-8") as file:
    file.write("создан")

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

создан

Пока файла нет, режим ведёт себя точно как "w". Разница проявляется во втором запуске.

§3Файл уже существует

with open("newfile.txt", "x", encoding="utf-8") as file:
    file.write("второй раз")

FileExistsError: [Errno 17] File exists: 'newfile.txt'

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

§4Обработка исключения

FileExistsError — потомок OSError из главы 8.3, и обрабатывается как любое другое исключение.

try:
    with open("newfile.txt", "x", encoding="utf-8") as file:
        file.write("данные")
except FileExistsError:
    print("Файл уже существует, перезапись отменена.")

Файл уже существует, перезапись отменена.

Дальше решение принимает программа: предложить другое имя, добавить к имени номер или спросить пользователя.

§5Двоичный вариант

Как и остальные режимы, "x" сочетается с буквой b.

with open("data.bin", "xb") as file:
    file.write(b"bin")

print(open("data.bin", "rb").read())

b'bin'

Есть и форма "x+" — создание с возможностью чтения, по аналогии с "w+" из главы 8.6.

§6Сравнение режимов

Последние две строки зеркальны: "x" требует отсутствия файла, "r" — его наличия. Оба сообщают о несоответствии исключением, а не молча.

§7Чем лучше проверки exists()

Тот же результат кажется достижимым проверкой перед открытием.

import os                          между проверкой и открытием
                                   файл может появиться —
if not os.path.exists(path):       и тогда он будет стёрт
    with open(path, "w") as f:
        ...

with open(path, "x") as f:         проверка и создание —
    ...                            одна неделимая операция

Разница не теоретическая: если файл создаёт другая программа или другой процесс той же программы, между проверкой и открытием проходит время, и в этот промежуток файл может появиться. Режим "x" выполняет проверку и создание одним действием на уровне операционной системы, поэтому такого промежутка не возникает.

§8Где применяется

Общий признак: файл создаётся один раз, и его повторное создание — признак ошибки в сценарии работы, о которой лучше узнать.

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

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

§11Шпаргалка

Итог главы

Режим "x" создаёт файл только при его отсутствии, а иначе вызывает FileExistsError — существующие данные при этом не страдают. Он зеркален режиму "r", который требует, чтобы файл был. Главное его преимущество перед проверкой os.path.exists() в том, что проверка и создание выполняются одной неделимой операцией, и файл не может появиться в промежутке. Этим завершается разбор режимов открытия и всего модуля о файлах.