Порой разработчику приходится отойти от мира программной абстракции и обратиться к практическим вещам. Например, к файловой системе. Манипуляции путями файловых систем в Python 3 реализуется несколькими библиотеками. Одна из них — pathlib. И в этой статье мы хотели бы вам рассказать о том, как использовать модуль pathlib и решать практические задачи с помощью него.
Файловая система
Прежде, чем перейти непосредственно к практической части применения библиотеки pathlib, необходимо повторить матчасть и обсудить основную концепцию файловой системы и её терминологию.
Итак, у нас есть файл example.exe расположенный в C:\Program Files (файловая система Windows). У этого файла есть 4 основные характеристики с точки зрения файловой системы:
- Путь — это идентификатор файла, определяющий его местонахождение в файловой системе, исходя из последовательности названий каталогов. Их разделяют на два типа:
- Абсолютный путь — полный путь файла, начинающийся с корневого каталога. Например, C:\Program Files\example.exe
- Относительный путь — путь к файлу относительно другого каталога. Например, Program Files\example.exe
- Каталог (C:\Program Files) — это объект в файловой системе, необходимой для иерархической организации файловой системы. Иногда его называют директория или папка. Название «папка» отлично описывает практическое название этого объекта — удобное хранение и быстрое нахождение при необходимости.
- Расширение (.exe) — это формат файла. С помощью расширения пользователь или программы определяют тип данных, хранящихся в файле (видео, текст, музыка и т.д.).
Экземпляры Path
Импортируем модуль pathlib для манипуляции путями файловых систем:
Классы этого модуля можно разбить на два типа: Pure (или «чистые») и Concrete (или «конкретные»). Первые нужны для абстрактной вычислительной работы с путями, при которой не осуществляется непосредственное взаимодействие с файловой системой ОС. Вторые же необходимы для взаимодействия с ней (создания и удаление директорий, чтения файлов и т.д.).
Если вы не уверены, какой класс подходит для выполнения вашей задачи, то, скорее всего, класс Path будет в самый раз. Он позволяет взаимодействовать с файловой системой ОС, под которую сам подстраивается (UNIX или Windows), но и при этом ваша манипуляция путями не страдает от ограничений. В рамках этой статьи мы рассмотрим все классы и их применение, но сосредоточимся конкретно на Path.
Итак, начнем с малого. Создадим переменную с типом данных Path:
Как видим, модуль сам подстроился под операционную систему — в нашем случае Windows 10. Конструктор Path(args) создает новый экземпляр класса Path и на вход принимает его компоненты (директории, файлы, другие пути).
Путь PathExample — относительный. Чтобы он стал абсолютным необходимо добавить корневой каталог.
С помощью методов Path.home() и Path.cwd() мы можем получить каталог текущего пользователя и текущую рабочую папку:
Сделаем PathExample абсолютным и рассмотрим другие аспекты работы с pathlib:
С помощью оператора «/» мы можем создавать новые пути.
VDS и VPS
биллингом по всему миру: Россия, Азия и Европа.
Атрибуты Path
Pathlib предоставляет различные методы и свойства для получения разнообразной информации о путях. Для наглядности добавим введем новую переменную AttributeExample и добавим в неё файл:
Диск
Чтобы узнать букву или имя диска, необходимо использовать свойство.drive:
Родительские каталоги
Мы можем получить родительские каталоги с помощью двух свойств: parent и parents[n].
Parent возвращает родительский каталог:
Чтобы получить более «высокие» родительские каталоги, можно использовать parent несколько раз:
Или воспользоваться свойством parents[n], который возвращает n-го предка:
Имя
Для получения имени файла нужно использовать свойство .name:
Расширение
Для того, чтобы получить расширение файла, необходимо использовать свойство .suffix или .suffixes (при наличии двойного расширения, например .tar.gz):
Абсолютный или относительный путь
Мы можем определить, является ли путь абсолютным, с помощью метода .is_absolute():
Составные части
Мы можем разложить путь на компоненты с помощью свойства .parts:
Сравнение путей
Мы можем сравнивать пути как с помощью операторов сравнения, так и с помощью различных методов.
Операторы сравнения
Мы можем узнать, являются ли пути одинаковыми:
Стоит упомянуть, что такое же сравнение для UNIX-систем будет давать результат False:
Это связано с тем, что в Windows регистр не имеет значения в имени директории, в отличие от файловой системы UNIX-систем.
Методы сравнения
Мы можем узнать, является ли один путь частью другого, с помощью метода .is_relative_to():
Также можно использовать шаблоны для проверки с помощью метода .match():
Создание и удаление папок и файлов
Для создания папок с помощью модуля pathlib необходимо использовать метод .mkdir(parents = True/False, exist_ok =True/False). Метод получает на вход (помимо пути, по которому нужно создать папку) 2 логические переменные: parents и exist_ok.
Если значение parents = True, то метод создаст родительские каталоги (при их отсутствии). Если False, то вернет ошибку при их отсутствии.
Exist_ok отвечает за обработку ошибок, возникающих при существовании целевой папки.
Создадим папку CreateExample, но сначала проверим, есть ли уже такая директория с помощью метода .is_dir():
Теперь попробуем его создать:
Проверим папку в проводнике:
Как видим, появилась именно папка, а не файл. Чтобы создать пустой файл, необходимо использовать метод .touch(). Но сначала удалим папку file.txt с помощью метода .rmdir():
Для удаления файлов существует метод .unlink().
Поиск файлов
На основе имеющегося каталога создадим более сложную структуру:
Мы создали и получили такую структуру (начиная с C:\Users\Blog\Timeweb):
Использование модуля pathlib для поиска файлов подразумевает применение цикла for и метода .glob():
Этот код не смог ничего найти, так как он не рассматривал вложенные папки. Чтобы он корректно работал, необходимо его немного изменить:
Подготовили для вас выгодные тарифы на VDS/VPS
477 ₽/мес
657 ₽/мес
Чтение и запись в файл
Обе операции можно выполнять как в текстовом, так и в бинарном режиме. Мы сосредоточимся на первом варианте. Для работы с содержимым файла pathlib предоставляет 4 метода:
- Чтение: .read_text() и .read_bytes();
- Запись: .write_text() и .write_bytes();
Запишем какую-нибудь важную информацию в файл, которую просто необходимо запомнить. Например, «Timeweb Cloud предлагает очень крутые облачные серверы!». Действительно, такое лучше где-нибудь записать:
