Проверка наличия файла или каталога по указанному пути
Бывает, что надо проверить корректность введенного пользователем адреса файла или каталога. Сделать это можно с помощью функции os.path.exists , которая возвращает true , если объект файловой системы существует, и false – если нет.
Функция os.path.isfile проверяет, является ли объект файлом, а os.path.isdir — является ли каталогом.
В приведенном ниже скрипте проверяется наличие объекта по указанному пользователем адресу, после этого проверяется файл это или каталог. В зависимости от типа объекта выводится информация.
# Скрипт проверяет наличие пути. # Если файл, то выводит его размер, даты создания, открытия и модификации. # Если каталог, выводит список вложенных в него файлов и каталогов. import os import datetime test_path = input('Введите адрес: ') if os.path.exists(test_path): if os.path.isfile(test_path): print('ФАЙЛ') print('Размер:', os.path.getsize(test_path) // 1024, 'Кб') print('Дата создания:', datetime.datetime.fromtimestamp( int(os.path.getctime(test_path)))) print('Дата последнего открытия:', datetime.datetime.fromtimestamp( int(os.path.getatime(test_path)))) print('Дата последнего изменения:', datetime.datetime.fromtimestamp( int(os.path.getmtime(test_path)))) elif os.path.isdir(test_path): print('КАТАЛОГ') print('Список объектов в нем: ', os.listdir(test_path)) else: print('Объект не найден')В скрипте также используются функции os.path.getsize (возвращает размер файла), os.path.getctime (время создания), os.path.getatime (время последнего открытия), os.path.getmtime (дата последнего изменения). Метод datetime.datetime.fromtimestamp позволяет выводить время в местном формате.
В скрипте также используются функции os.path.getsize (возвращает размер файла), os.path.getctime (время создания), os.path.getatime (время последнего открытия), os.path.getmtime (дата последнего изменения). Метод datetime.datetime.fromtimestamp позволяет выводить время в местном формате.
Примеры выполнения программы:
Введите адрес: /home/pl/test.py ФАЙЛ Размер: 2 Кб Дата создания: 2021-10-14 19:55:58 Дата последнего открытия: 2022-04-21 08:21:00 Дата последнего изменения: 2021-10-14 19:55:58Введите адрес: /home/pl/pas КАТАЛОГ Список объектов в нем: ['vk', 'theory', 'tasks']Как проверить, существует ли файл при помощи Python
Руководство для тех, кому нужно узнать, существует ли файл (или папка) при помощи встроенных возможностей и функций Python из стандартной библиотеки.
Способность проверять, существует ли файл на диске или нет — очень важно для большинства программ Python:
Возможно, вам нужно убедиться в том, что файл с данным доступен, перед тем как вы попробуете загрузить его, или вам нужно предотвратить повторную запись файла в Python. Это же подходит и для папок. Возможно, вам нужно убедиться в том, что папка доступна, перед тем как ваша программа запустится.
В Python есть несколько способов подтвердить существование папки или файла, пользуясь встроенными в ядро языка функциями и стандартной библиотекой Python.
В данном руководстве вы увидите три отдельные техники для проверки существования файла в Python, с примерами кода и характерными преимуещствами и недостатками.
Проверяем если файл существует os.path.exists() и os.path.isfile()
Самый простой способ проверки существования файла в Python — это использование методов exists() и isfile() из модуля os.path в стандартной библиотеке.
Эти функции доступны в Python 2 и Python 3.7, и обычно их рекомендуют в первую очередь, если обращаться за помощью к документации Python или гуглу за решением проблемы.
Есть вопросы по Python?
На нашем форуме вы можете задать любой вопрос и получить ответ от всего нашего сообщества!
Telegram Чат & Канал
Вступите в наш дружный чат по Python и начните общение с единомышленниками! Станьте частью большого сообщества!
Паблик VK
Одно из самых больших сообществ по Python в социальной сети ВК. Видео уроки и книги для вас!
Вот пример того, как работать с функцией os.path.exists() . Мы проверим несколько путей (файлы и папки) на наличие:
import os.path
check_file = os.path . exists ( ‘storage/music.mp3’ ) # True
print ( os.path . exists ( ‘нет-такого-файла.txt’ ) ) # False
# Проверяем если папка существует.
os.path . exists ( ‘storage’ ) # True
Как мы видим, вызов os.path.exists() возвращает True для файлов и папок. Если вы хотите убедиться, что заданный путь указывает на файл, но не на папку, вы можете использовать функцию os.path.isfile()
import os.path
os.path . isfile ( ‘storage/music.mp3’ ) # True
os.path . isfile ( ‘нет-такого-файла.txt’ ) # False
os.path . isfile ( ‘storage’ ) # False, папка существует но это не файл.
Для обеих функций важно помнить о том, что они проверяют только существует файл, или нет, а не наличие доступа программы к нему. Если подтверждение доступа к файлу важно, то вам нужно выполнить простое открытия файла и поймать исключение IOError.
Мы вернемся к этой технике, когда будем подводить итоги в конце руководства. Но перед этим, рассмотрим еще один способ проверки существования файла в Python.
Проверка существует ли файл используя open() и try … except
Мы только что рассматривали, как функции в модуле os.path могут быть использованы для проверки существования файла или папки.
Есть еще один прямолинейный алгоритм Python для проверки существования файла: Вы просто пытаетесь открыть файл при помощи встроенной функции open() , вот так:
open ( ‘нет-такого-файла.txt’ )
FileNotFoundError :
«[Errno 2] No such file or directory: ‘нет-такого-файла.txt'»
Если файл существует, то файл успешно откроется и вернет валидный объект для дальнейшей обработки файла. Если файл не существует, появится ошибка FileNotFoundError:
Ошибка FileNotFoundError возникает, когда файл или папка запрошена, но не существует. Относится к errno ENOENT.
Это значит, что вы можете получить ошибку FileNotFoundError в своем коде, и использовать ее для обнаружения того, существует файл или нет. Вот пример кода, который демонстрирует работу этой техники:
f = open ( ‘нет-такого-файла.txt’ )
except FileNotFoundError :
print ( ‘Файл не существует!’ )
Обратите внимание, мы мгновенно вызываем метод close() для объекта файла для освобождения дескриптора файла. Это считается хорошей практикой при работе с файлами в Python:
Если вы не закроете дескриптор файлов, то будет сложно понять, когда именно он будет закрыт автоматически во время работы Python. Это занимает ресурсы системы и может снизить производительность ваших программ.
Вместо того, чтобы закрывать файл при помощи метода close() , есть еще один способ, которым можно воспользоваться контекстным менеджером и оператора with для автоматического закрытия файла.
Теперь, та же техника “просто попробуем открыть файл” также работает для выяснения, является ли файл доступным и читаемым. Вместо поиска ошибок FileNotFoundError, вам нужно искать любые ошибки типа IOError:
f = open ( ‘new-music.mp3’ )
except IOError :
print ( ‘Файл недоступен’ )
print ( ‘Файл доступен’ )
Если вы часто используете этот шаблон, вы можете выделить его в вспомогательную функцию, которая позволит вам проверить, существует ли файл и является ли он в то же время доступным:
def is_accessible ( path , mode = ‘r’ ) :
Проверка, является ли файл или папка из `path`
доступным для работы в предоставленным `mode` формате.
f = open ( path , mode )
except IOError :
return False
return True
Как альтернатива, вы можете использовать функцию os.access() из стандартной библиотеке для проверки того, существует ли файл и является ли он доступным в то же время. Это может быть похоже на использование функции path.exists() , если файл существует.
Использование open() и try . except имеет некоторые преимущества, когда доходит до обработки файлов в Python. Это может помочь вам избежать накладок, вызванных определенными условиями существования файла:
Представим, что файл существует в тот момент, когда вы запускаете проверку, файл удаляется другим процессом независящий от вас. Когда вы пытаетесь открыть файл для работы с ним, он исчезает и ваша программа получает ошибку.
Мы рассмотрим этот случай в конце руководства. Но перед этим, запрыгнем в еще одну кроличью нору. Рассмотрим еще один способ того, как проверить, существует ли файл в Python.
Пример проверки существования файла pathlib.Path.exists() (Python 3.4+)
Python 3.4 и выше содержит модуль pathlib , который предоставляет объектно-ориентированный интерфейс для работы с путями файловых систем. Использование этого модуля намного приятнее, чем работа с путями в виде объектов строк.
Он предоставляет абстракции и вспомогательные функции для множества операций с файловыми системами, включая проверку на наличие и поиск того, указывает ли путь на файл или папку.
Чтобы узнать, указывает ли путь на настоящий файл, вы можете использовать метод Path.exists() . Чтобы узнать, является путь файлом, или символической ссылкой, а не папкой, вам захочется воспользоваться Path.is_file() .
Вот рабочий пример для обоих методов pathlib.Path :
import pathlib
path = pathlib . Path ( ‘music.mp3’ )
print ( path . exists ( ) ) # True
print ( path . is_file ( ) ) # True
Как мы видим, этот подход по своему принципу схож с проверкой при помощи функций из модуля os.path .
Главное отличие в том, что pathlib предоставляет более чистый объекно-ориентированный интерфейс для работы с файловой системой. Вам больше не нужно работать с объектами str, представляющими пути файлов — вместо этого, вы обрабатываете объекты Path с релевантными методами и связанными с ними атрибутами.
Использование pathlib и преимущества объектно-ориентированного интерфейса может сделать ваш код обработки более читаемым и понятным. Не будем лгать и говорить, что это панацея. Но в ряде случаев это может помочь вам написать более “лучшую” версию программы Python.
Модуль pathlib также доступен как сторонний модуль с бэкпортом для PyPl, который работает на Python 2.x и 3.х Вы можете найти его здесь: pathlib2.
Подведем итоги проверки на наличие файла в Python
В данном руководстве мы сравнили три разных метода определения наличия или отсутствия файла в Python. Один метод также позволяет нам проверить, существует ли файл и является ли он доступным в то же время.
Конечно, имея в распоряжении три способа, вы можете подумать:
Какой способ проверки наличия файла при помощи Python является предпочтительнее?
В большинстве случаев, когда вам нужно проверить наличие файла, рекомендуется использование встроенного метода pathlib.Path.exists() на Python 3.4 и выше, или функцию os.path.exists() для Python 2.
Однако, есть одна важная оговорка…
Следует помнить о том, что файл который считается существующим, после проведения проверки может исчезнуть из за других программ который с ним работают.
Хотя вероятность такого события невысока, вполне может быть так, что файл будет существовать только во время проверки, и мгновенно будет удален после.
Чтобы избежать такой ситуации, стоит опираться не только на вопрос “существует ли файл?”. Вместо этого, неплохо просто попытаться сразу выполнить желаемую операцию. Это также называется “easier to ask for forgiveness than permission” (EAFP) (проще просить прощения, чем разрешения). Такой подход часто рекомендуется при работе с Python.
Например, вместо проверки того, существует ли файл перед тем, как его открыть, вам захочется просто попробовать открыть его и готовиться ловить ошибку FileNotFoundError, которая говорит нам о том, что файл недоступен. Это позволит избежать состояния гонки.
Итак, если вы планируете работать с файлом сразу после проверки, например, прочитать его содержимое путем внесение новых данных в него, рекомендуется выполнить проверку на наличие при помощи метода open() с последующей обработкой ошибки, пользуясь подходом EAFP. Это позволит вам избежать состояния гонки в вашем коде обработки файлов Python.
Являюсь администратором нескольких порталов по обучению языков программирования Python, Golang и Kotlin. В составе небольшой команды единомышленников, мы занимаемся популяризацией языков программирования на русскоязычную аудиторию. Большая часть статей была адаптирована нами на русский язык и распространяется бесплатно.
E-mail: vasile.buldumac@ati.utm.md
Образование
Universitatea Tehnică a Moldovei (utm.md)
- 2014 — 2018 Технический Университет Молдовы, ИТ-Инженер. Тема дипломной работы «Автоматизация покупки и продажи криптовалюты используя технический анализ»
- 2018 — 2020 Технический Университет Молдовы, Магистр, Магистерская диссертация «Идентификация человека в киберпространстве по фотографии лица»
Как проверить существование файла?
Для проверки существования заданного пути используйте функцию os.path.exists :
import os.path os.path.exists(file_path) Но она вернет True и для файла и для директории.
os.path.isfile проверит именно на наличие файла.
Отслеживать
ответ дан 7 апр 2015 в 16:46
757 1 1 золотой знак 6 6 серебряных знаков 15 15 бронзовых знаков
Кратко: вместо if exists(): open() используйте просто open() .
Если проверка нужна, чтобы выполнить позднее какую-либо операцию с файлом, то лучше прямо выполнить эту операцию и поймать возможные ошибки (предполагая, что вы на том же уровне ошибки хотите обработать):
#!/usr/bin/env python # -*- coding: utf-8 -*- try: file = open('input.txt') except IOError as e: print(u'не удалось открыть файл') else: with file: print(u'делаем что-то с файлом') Предварительная проверка всё равно не гарантирует, что файл всё ещё будет существовать позднее и всё равно придётся ошибки обрабатывать.
Ответы на комментарии:
- Где блок finally в котором вы закрывается поток
finally здесь не нужен. Если код попал в except блок, то файл не открыт — нечего закрывать. В else ветке, где файл открыт, with file: конструкция всегда закрывает файл при выходе из блока (нормальном или когда исключение возникло).
- Конструкция try-exept-else многими считается плохо читаемой.
Обычно try/except не используется на том же уровне, то есть в коде используется просто:
with open('input.txt') as file: print(u'делаем что-то с файлом') а возможные исключения выше по стеку обрабатываются. Но если вы хотите обработать ошибку в open() на том же уровне, то вы обязаны использовать try/except ( open() сигнализирует ошибки с помощью исключений).
- Каждый раз, когда файла нет, вы вызываете прерывание ОС (на нем строится механизм обработки исключения) самостоятельно, не слишком ли это раcточительно?
Исключения выбрасываются в случае ошибки в Питоне хотите вы этого или нет. Вот реализация os.path.exists() из стандартной библиотеки:
def exists(path): try: os.stat(path) except OSError: return False return True фактически, используя open() напрямую, а не if exists(): open() мы уменьшаем количество системных вызовов.
- Ваш код занял 7 строчек, не лучше ли эту задачу поручить операционной системе командой os.path.exists(path_to_file) в пару строчек ?
Длина кода, который не работает, не имеет значения. Ещё раз: вызов os.path.exists() не гарантирует что файл существует когда вы попытаетесь вызвать open() позднее: всё равно придётся обрабатывать ошибки.
Стоит упомянуть, что если отсутствие файла не является ошибкой в вашем случае (ожидается программой), то вполне можно os.path.exists() или его аналоги использовать, чтобы подчеркнуть вероятность отсутствия файла для читателя кода (но так как последующее открытие файла может быть всё равно неудачным, то это не освобождает код от добавления обработки ошибок, подходящего для вашей задачи, такого как try/except выше).
Как проверить, существует ли файл, при помощи Python
Работа с файлами – неотъемлемая составляющая взаимодействия с любым приложением с мало-мальски нормальным функционалом. И стандартная библиотека Python предоставляет возможность проверить файл на наличие в файловой системе.
В каких случаях это может пригодиться? Например, когда вы хотите удостовериться, что файл с данными доступен. Второй вариант – это профилактика того, чтобы файл не был записан повторно. Хотя функционал, который будет рассмотрен далее, может касаться и папок.
В Python есть несколько вариантов, как можно поступать, чтобы подтвердить наличие папки или файла, пользуясь внедренными в ядро возможностями.
Сегодня мы разберем три специальные техники. Они используются разработчиками для того того, чтобы проверить, есть ли нужный файл, с помощью средств Python. Также мы приведем примеры кода и конкретные преимущества и недостатки. Заранее скажем, что лучшей или худшей нет. Они просто подходят для разных ситуаций. Да и просто необходимо уметь читать код. Поэтому изучить их придется.
Проверка наличия файла с помощью os.path.exists() и os.path.isfile()
Чаще всего для определения наличия файла используются методы exists() и isfile() , которые находятся в модуле os.path . Поскольку он находится в стандартной библиотеке, его не нужно дополнительно устанавливать.
Воспользоваться этими возможностями можно в Python 2 и Python 3.7. Как правило, их именно эти версии рекомендуют в первую очередь для проверки существования файлов.
Какая же функция самая простая для работы с файлами? Конечно же, exists() . Она содержит всего один аргумент – путь файла. Работа с функцией os.path.exists() осуществляется следующим образом.
import os.path check_file = os.path.exists('storage/music.mp3') # True print(os.path.exists('нет-такого-файла.txt')) # False # Проверяем если папка существует. os.path.exists('storage') # True
Здесь мы проверили несколько путей на наличие. Как мы видим, мы получили True для файлов и папок с помощью этого вызова. Если вы хотите удостовериться, что этот путь указывает на файл, а не на папку, тогда можно воспользоваться функцией os.path.isfile() . Она по легкости ничуть не уступает предыдущей.
import os.path os.path.isfile('storage/music.mp3') # True os.path.isfile('нет-такого-файла.txt') # False os.path.isfile('storage') # False, папка существует но это не файл.
Для всех функций необходимо учитывать то, что они анализируют лишь существование файла. Доступ приложения к нему не проверяется. Поэтому если обязательно убедиться в том, что приложение может открывать файл и работать с ним, достаточно просто осуществить его открытие, а потом обработать исключение IOError .
К данной технике мы обратимся немного позже. А сейчас попробуем рассмотреть еще один способ.
Использование функции open() параллельно с try … except
Ранее мы рассмотрели, какие функции в модуле os.path могут использоваться для проверки наличия файла или папки. Есть еще одна последовательность действий, позволяющая проверить факт существования файла. Можно лишь попробовать использовать функцию open() , чтобы открыть его. Если это не получится сделать, то, соответственно, его не существует.
open('нет-такого-файла.txt') FileNotFoundError: "[Errno 2] No such file or directory: 'нет-такого-файла.txt'"
Если файл в наличии, то он откроется без проблем. Функция open() вернет валидный объект для того, чтобы осуществлять последующую обработку файла. Если же его нет, то появится ошибка, приведенная в коде выше (то есть, FileNotFoundError).
Эта ошибка всплывает в случаях, когда оказалось, что найти требуемый объект не получилось . С высокой долей вероятности это означает, что он отсутствует вообще.
Следовательно, данная ошибка может использоваться для того, чтобы проверить наличие файла. Вот пример кода, который показывает принцип работы этой техники.
try: f = open('нет-такого-файла.txt') f.close() except FileNotFoundError: print('Файл не существует!')
Обратите внимание, что нами мгновенно был вызван метод close() для объекта файла для того, чтобы освободить дескриптор файла. В процессе работы с файлами Python рекомендуется поступать именно таким образом.
Если вы решите не закрывать дескриптор файлов, то станет непросто разобраться в том, когда конкретно он будет закрыт при работе приложения. Известно лишь то, что он будет закрыт автоматически. Поскольку на это уходит часть ресурсов компьютера, это негативно влияет на итоговую эффективность программ, которые работают на этом ПК.
Вместо закрытия файла с использованием метода close() , есть еще один вариант действий. Как вариант возможно использовать контекстный менеджер, а также оператор with , чтобы осуществить процедуру автоматического назакрытия.
Теперь, аналогичная техника «лишь попытаемся открыть файл» тоже работает для того, чтобы понять, возможно ли прочитать этот файл.
Вместо того, чтобы осуществлять поиск ошибки FileNotFoundError , можно искать любые ошибки типа IOError . С высокой долей вероятности, среди них будет и та ,которая свидетельствует об отсутствии файла.
try: f = open('new-music.mp3') f.close() except IOError: print('Файл недоступен') print('Файл доступен')
Если вам часто приходится использовать данный шаблон, то его можно выделить во вспомогательную функцию, позволяющую проверить существование файла и его доступность.
def is_accessible(path, mode='r'): """ Проверка, является ли файл или папка из `path` доступным для работы в предоставленным `mode` формате. """ try: f = open(path, mode) f.close() except IOError: return False return True
В качестве альтернативы, можно применять функцию os.access() . Чтобы ею воспользоваться, никаких дополнительных модулей устанавливать не нужно. Она доступна непосредственно в стандартной библиотеке.
С помощью функции os.access() можно проверить факт существования файла и его доступность. Это похоже на использование функции path.exists() , если файл есть в наличии.
Использование open() и try … except имеет ряд положительных сторон, когда речь идет об обработке файлов в Python. Это позволяет не допустить сложностей, связанных с какими-то условиями наличия файла.
Допустим, что файл есть в наличии в тот момент, когда проверка с помощью нашего приложения запускается, но файл удаляется другой программой, на которую вы не влияете. Когда вы делаете попытки открыть файл, он попросту пропадает, а приложение получает ошибку.
Давайте еще один вариант действий проанализируем.
Пример проверки существования файла pathlib.Path.exists()
Python 3.4 и выше включает модуль pathlib , представляющий объектно-ориентированную среду для работы с путями файлов и папок. Это значительно лучше, чем работать с путями в форме объектов строк.
Модуль предоставляет абстракции и дополнительные функции для большого количества операций с файловыми системами. Сюда входит, например, проверка на существование файла, а также проверка того, указывает ли путь на файл либо папку.
Чтобы проверить, ведет ли путь к этому файлу, можно воспользоваться методом Path.exists() . А чтобы узнать, не является ли путь файлом или символической ссылкой, тогда надо воспользоваться методом Path.is_file() .
Вот пример, как это все работает.
import pathlib path = pathlib.Path('music.mp3') print(path.exists()) # True print(path.is_file()) # True
Как можно видеть с этого примера, данный подход чем-то напоминает проверку с использованием функций из модуля os.path .
Существенное отличие в том, что pathlib предоставляет более чистую объектно-ориентированную среду для взаимодействия с файловой системой. Больше нет необходимости взаимодействовать с объемами str , которые представляют пути файлов. Напротив, необходимо лишь обрабатывать объекты Path с релевантными методами и атрибутами, имеющими связь с ними.
Задействование pathlib и положительные стороны объектно-ориентированного интерфейса способны значительно увеличить читаемость и понятность кода. Но не будем говорить о том, что это средство от всех бед. Конечно, всех проблем это не решает, но помогает существенно улучшить код.
Модуль pathlib может быть использован в качестве стороннего модуля с бэкпортом для PyPI, работающего на Python 2.x и 3.x.
Выводы
Итак, мы сопоставили три различных метода для определения существования или отсутствия файла на флешке или жестком диске. Один из методов дает возможность проверить, действительно ли есть в наличии файл и является ли он доступным тогда же.
Естественно, имея в наличии три метода выполнения одной и той же задачи, вы можете подумать, о том, какой из них лучше. В подавляющем числе случаев, при необходимости проверки существования файла, рекомендуется использовать метод pathlib.Path.exists() на Python 3.4 и выше, либо функцию os.path.exists() для Python 2 версии.
Правда, есть один важный нюанс. Не стоит забывать, файл, который считается имеющимся в наличии, может из других программ просто исчезнуть после того, как будет выполнена проверка. Конечно, это событие не имеет такую высокую вероятность, чтобы она была критической. Тем не менее, такое бывает.
Чтобы не допустить их, не нужно проверять существование файла. Хорошо просто попытаться сразу выполнить операцию, которую нужно. Этот принцип называется «проще просить прощения, чем разрешения» и очень часто рекомендуется специалистами по Python новичкам.
Так, вместо проверки существования файла перед тем, как его открыть, гораздо лучше попробовать его открыть. И если появляется ошибка FileNotFoundError , то это говорит о недоступности файла. Это дает возможность не допустить состояния гонки.
Итак, если вам нужно работать с файлом непосредственно после проверки (например, внести какую-то информацию в него), то рекомендуется пользоваться методом open() для того, чтобы выполнить проверку, а потом просто обработать возникшие исключения.