Документация Python неофициальный перевод

os.path.md

218 строк · 24.7 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.5/library/os.path.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 11.2. [`os.path`](https://python-all.ru/3.5/library/os.path.html#module-os.path) – Общие манипуляции с путями89**Исходный код:** [Lib/posixpath.py](https://python-all.ru/src/3.5/Lib/posixpath.py) (для POSIX), [Lib/ntpath.py](https://python-all.ru/src/3.5/Lib/ntpath.py) (для Windows NT), и [Lib/macpath.py](https://python-all.ru/src/3.5/Lib/macpath.py) (для Macintosh)1011---1213Этот модуль реализует несколько полезных функций для работы с путями. Для чтения или записи файлов см. [`open()`](https://python-all.ru/3.5/library/functions.html#open), а для доступа к файловой системе – модуль [`os`](https://python-all.ru/3.5/library/os.html#module-os). Параметры пути могут передаваться как строки (str) или байты (bytes). Приложениям рекомендуется представлять имена файлов в виде строк (Unicode). К сожалению, некоторые имена файлов в Unix невозможно представить в виде строк, поэтому приложениям, которым требуется поддержка произвольных имён файлов в Unix, следует использовать объекты bytes для представления путей. И наоборот: с помощью объектов bytes нельзя представить все имена файлов в Windows (в стандартной кодировке `mbcs`), поэтому приложения Windows должны использовать строковые объекты для доступа ко всем файлам.1415В отличие от оболочки Unix, Python не выполняет *автоматического* раскрытия путей. Функции [`expanduser()`](https://python-all.ru/3.5/library/os.path.html#os.path.expanduser) и [`expandvars()`](https://python-all.ru/3.5/library/os.path.html#os.path.expandvars) можно вызывать явно, если приложению требуется раскрытие путей как в оболочке. (См. также модуль [`glob`](https://python-all.ru/3.5/library/glob.html#module-glob).)1617> **См. также**18>19> Модуль [`pathlib`](https://python-all.ru/3.5/library/pathlib.html#module-pathlib) предоставляет высокоуровневые объекты путей.2021> **Примечание**22>23> Все эти функции принимают в качестве параметров только объекты байт или только строки. Если возвращается путь или имя файла, результатом будет объект того же типа.2425> **Примечание**26>27> Поскольку в разных операционных системах разные соглашения об именах путей, в стандартной библиотеке есть несколько версий этого модуля. Модуль [`os.path`](https://python-all.ru/3.5/library/os.path.html#module-os.path) всегда представляет собой модуль путей, подходящий для операционной системы, на которой выполняется Python, и поэтому пригоден для локальных путей. Однако вы также можете импортировать и использовать отдельные модули, если хотите работать с путём, который *всегда* находится в одном из этих форматов. Все они имеют одинаковый интерфейс:28>29> - `posixpath` для путей в стиле UNIX30> - `ntpath` для путей Windows31> - [`macpath`](https://python-all.ru/3.5/library/macpath.html#module-macpath) для путей MacOS старого стиля3233#### `os.path.abspath(path)`3435Возвращает нормализованную абсолютную версию имени пути *path*. На большинстве платформ это эквивалентно вызову функции [`normpath()`](https://python-all.ru/3.5/library/os.path.html#os.path.normpath) следующим образом: `normpath(join(os.getcwd(), path))`.3637#### `os.path.basename(path)`3839Возвращает базовое имя пути *path*. Это второй элемент пары, возвращаемой при передаче *path* функции [`split()`](https://python-all.ru/3.5/library/os.path.html#os.path.split). Обратите внимание, что результат этой функции отличается от программы Unix **basename**; если **basename** для `'/foo/bar/'` возвращает `'bar'`, то функция [`basename()`](https://python-all.ru/3.5/library/os.path.html#os.path.basename) возвращает пустую строку (`''`).4041#### `os.path.commonpath(paths)`4243Возвращает самый длинный общий подпуть для каждого пути в последовательности *paths*. Возбуждает ValueError, если *paths* содержит как абсолютные, так и относительные пути, или если *paths* пуст. В отличие от [`commonprefix()`](https://python-all.ru/3.5/library/os.path.html#os.path.commonprefix), возвращает корректный путь.4445Доступность: Unix, Windows4647Новое в версии 3.5.4849#### `os.path.commonprefix(list)`5051Возвращает самый длинный префикс пути (по одному символу), который является префиксом всех путей в *list*. Если *list* пуст, возвращается пустая строка (`''`).5253> **Примечание**54>55> Эта функция может возвращать некорректные пути, так как она работает по одному символу за раз. Чтобы получить корректный путь, см. [`commonpath()`](https://python-all.ru/3.5/library/os.path.html#os.path.commonpath).56>57> ```python58> >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])59> '/usr/l'60>61> >>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])62> '/usr'63> ```6465#### `os.path.dirname(path)`6667Возвращает имя каталога пути *path*. Это первый элемент пары, возвращаемой при передаче *path* функции [`split()`](https://python-all.ru/3.5/library/os.path.html#os.path.split).6869#### `os.path.exists(path)`7071Возвращает `True`, если *path* указывает на существующий путь или открытый файловый дескриптор. Возвращает `False` для битых символических ссылок. На некоторых платформах эта функция может вернуть `False`, если нет разрешения на выполнение [`os.stat()`](https://python-all.ru/3.5/library/os.html#os.stat) для запрошенного файла, даже если *path* физически существует.7273Изменено в версии 3.3: *path* теперь может быть целым числом: возвращается `True`, если это открытый файловый дескриптор, и `False` в противном случае.7475#### `os.path.lexists(path)`7677Возвращает `True`, если *path* указывает на существующий путь. Возвращает `True` для битых символических ссылок. Эквивалент [`exists()`](https://python-all.ru/3.5/library/os.path.html#os.path.exists) на платформах без [`os.lstat()`](https://python-all.ru/3.5/library/os.html#os.lstat).7879#### `os.path.expanduser(path)`8081В Unix и Windows возвращает аргумент, в котором начальный компонент `~` или `~user` заменён на домашний каталог этого *пользователя*.8283В Unix начальный `~` заменяется на значение переменной окружения `HOME`, если она установлена; в противном случае домашний каталог текущего пользователя ищется в базе паролей через встроенный модуль [`pwd`](https://python-all.ru/3.5/library/pwd.html#module-pwd). Начальный `~user` ищется напрямую в базе паролей.8485В Windows `HOME` и `USERPROFILE` используются, если они заданы; в противном случае используется комбинация `HOMEPATH` и `HOMEDRIVE`. Начальный `~user` обрабатывается путём удаления последнего компонента каталога из созданного выше пути пользователя.8687Если разворачивание не удалось или путь не начинается с тильды, путь возвращается без изменений.8889#### `os.path.expandvars(path)`9091Возвращает аргумент с развёрнутыми переменными окружения. Подстроки вида `$name` или `${name}` заменяются значением переменной окружения *name*. Некорректные имена переменных и ссылки на несуществующие переменные остаются без изменений.9293В Windows поддерживаются расширения `%name%` в дополнение к `$name` и `${name}`.9495#### `os.path.getatime(path)`9697Возвращает время последнего доступа к *path*. Возвращаемое значение – число, представляющее количество секунд с начала эпохи (см. модуль [`time`](https://python-all.ru/3.5/library/time.html#module-time)). Возбуждает [`OSError`](https://python-all.ru/3.5/library/exceptions.html#OSError), если файл не существует или недоступен.9899Если [`os.stat_float_times()`](https://python-all.ru/3.5/library/os.html#os.stat_float_times) возвращает `True`, результатом является число с плавающей точкой.100101#### `os.path.getmtime(path)`102103Возвращает время последнего изменения *path*. Возвращаемое значение – число, представляющее количество секунд с начала эпохи (см. модуль [`time`](https://python-all.ru/3.5/library/time.html#module-time)). Возбуждает [`OSError`](https://python-all.ru/3.5/library/exceptions.html#OSError), если файл не существует или недоступен.104105Если [`os.stat_float_times()`](https://python-all.ru/3.5/library/os.html#os.stat_float_times) возвращает `True`, результатом является число с плавающей точкой.106107#### `os.path.getctime(path)`108109Возвращает системное ctime, которое в одних системах (например, Unix) является временем последнего изменения метаданных, а в других (например, Windows) – временем создания для *path*. Возвращаемое значение – число секунд с начала эпохи (см. модуль [`time`](https://python-all.ru/3.5/library/time.html#module-time)). Возбуждает [`OSError`](https://python-all.ru/3.5/library/exceptions.html#OSError), если файл не существует или недоступен.110111#### `os.path.getsize(path)`112113Возвращает размер в байтах *path*. Возбуждает [`OSError`](https://python-all.ru/3.5/library/exceptions.html#OSError), если файл не существует или недоступен.114115#### `os.path.isabs(path)`116117Возвращает `True`, если *path* является абсолютным именем пути. В Unix это означает, что он начинается с косой черты, в Windows – что он начинается с обратной или косой черты после отбрасывания символа диска.118119#### `os.path.isfile(path)`120121Возвращает `True`, если *путь* является существующим обычным файлом. Функция следует символическим ссылкам, поэтому оба значения [`islink()`](https://python-all.ru/3.5/library/os.path.html#os.path.islink) и [`isfile()`](https://python-all.ru/3.5/library/os.path.html#os.path.isfile) могут быть истинными для одного пути.122123#### `os.path.isdir(path)`124125Возвращает `True`, если *путь* является существующим каталогом. Функция следует символическим ссылкам, поэтому оба значения [`islink()`](https://python-all.ru/3.5/library/os.path.html#os.path.islink) и [`isdir()`](https://python-all.ru/3.5/library/os.path.html#os.path.isdir) могут быть истинными для одного пути.126127#### `os.path.islink(path)`128129Возвращает `True`, если *путь* указывает на запись каталога, являющуюся символической ссылкой. Всегда `False`, если символические ссылки не поддерживаются средой выполнения Python.130131#### `os.path.ismount(path)`132133Возвращает `True`, если путь *path* является *точкой монтирования*: точкой в файловой системе, куда смонтирована другая файловая система. В POSIX функция проверяет, находится ли родитель *path*, `path/..`, на другом устройстве, чем *path*, или указывают ли `path/..` и *path* на один и тот же индексный дескриптор на том же устройстве – это должно выявлять точки монтирования для всех вариантов Unix и POSIX. В Windows корень буквы диска и общая папка UNC всегда являются точками монтирования, а для любого другого пути вызывается `GetVolumePathName`, чтобы проверить, отличается ли он от входного пути.134135Новое в версии 3.4: Поддержка обнаружения точек монтирования, не являющихся корневыми, в Windows.136137#### `os.path.join(path, *paths)`138139Интеллектуально объединяет один или несколько компонентов пути. Возвращаемое значение представляет собой конкатенацию *path* и любых элементов *\*paths* ровно с одним разделителем каталогов (`os.sep`) после каждой непустой части, кроме последней, то есть результат заканчивается разделителем, только если последняя часть пуста. Если компонент является абсолютным путём, все предыдущие компоненты отбрасываются, и объединение продолжается с этого абсолютного компонента пути.140141В Windows буква диска не сбрасывается при обнаружении абсолютного компонента пути (например, `r'\foo'`). Если компонент содержит букву диска, все предыдущие компоненты отбрасываются, а буква диска сбрасывается. Обратите внимание, что для каждого диска существует текущий каталог, поэтому `os.path.join("c:", "foo")` представляет собой путь относительно текущего каталога на диске `C:` (`c:foo`), а не `c:\foo`.142143#### `os.path.normcase(path)`144145Нормализует регистр пути. В Unix и Mac OS X возвращает путь без изменений; в файловых системах, нечувствительных к регистру, приводит путь к нижнему регистру. В Windows также заменяет прямые слеши на обратные. Вызывает TypeError, если тип *пути* не `str` или `bytes`.146147#### `os.path.normpath(path)`148149Нормализует имя пути, удаляя лишние разделители и ссылки на родительский каталог, так что `A//B`, `A/B/`, `A/./B` и `A/foo/../B` все превращаются в `A/B`. Эта строковая операция может изменить значение пути, содержащего символические ссылки. В Windows преобразует прямые косые черты в обратные. Для нормализации регистра используйте [`normcase()`](https://python-all.ru/3.5/library/os.path.html#os.path.normcase).150151#### `os.path.realpath(path)`152153Возвращает канонический путь указанного имени файла, устраняя все символические ссылки, встречающиеся в пути (если они поддерживаются операционной системой).154155#### `os.path.relpath(path, start=os.curdir)`156157Возвращает относительный путь к *path* либо от текущего каталога, либо от необязательного стартового каталога *start*. Это вычисление пути: файловая система не используется для подтверждения существования или типа *path* или *start*.158159*start* по умолчанию равен [`os.curdir`](https://python-all.ru/3.5/library/os.html#os.curdir).160161Доступность: Unix, Windows.162163#### `os.path.samefile(path1, path2)`164165Возвращает `True`, если оба указанных пути ссылаются на один и тот же файл или каталог. Это определяется по номеру устройства и номеру индексного дескриптора; возбуждается исключение, если вызов [`os.stat()`](https://python-all.ru/3.5/library/os.html#os.stat) для любого из путей завершается ошибкой.166167Доступность: Unix, Windows.168169Изменено в версии 3.2: Добавлена поддержка Windows.170171Изменено в версии 3.4: Теперь в Windows используется та же реализация, что и на всех остальных платформах.172173#### `os.path.sameopenfile(fp1, fp2)`174175Возвращает `True`, если файловые дескрипторы *fp1* и *fp2* ссылаются на один и тот же файл.176177Доступность: Unix, Windows.178179Изменено в версии 3.2: Добавлена поддержка Windows.180181#### `os.path.samestat(stat1, stat2)`182183Возвращает `True`, если кортежи stat *stat1* и *stat2* ссылаются на один и тот же файл. Эти структуры могли быть возвращены [`os.fstat()`](https://python-all.ru/3.5/library/os.html#os.fstat), [`os.lstat()`](https://python-all.ru/3.5/library/os.html#os.lstat) или [`os.stat()`](https://python-all.ru/3.5/library/os.html#os.stat). Эта функция реализует сравнение, лежащее в основе [`samefile()`](https://python-all.ru/3.5/library/os.path.html#os.path.samefile) и [`sameopenfile()`](https://python-all.ru/3.5/library/os.path.html#os.path.sameopenfile).184185Доступность: Unix, Windows.186187Изменено в версии 3.4: Добавлена поддержка Windows.188189#### `os.path.split(path)`190191Разделяет имя пути *path* на пару, `(head, tail)` где *tail* – это последний компонент имени пути, а *head* – все, что ему предшествует. Часть *tail* никогда не содержит косую черту; если *path* заканчивается косой чертой, *tail* будет пуст. Если в *path* нет косой черты, *head* будет пуст. Если *path* пуст, то и *head*, и *tail* пусты. Замыкающие косые черты удаляются из *head*, если только он не является корнем (только одна или несколько косых черт). Во всех случаях `join(head, tail)` возвращает путь к тому же расположению, что и *path* (хотя строки могут различаться). Также см. функции [`dirname()`](https://python-all.ru/3.5/library/os.path.html#os.path.dirname) и [`basename()`](https://python-all.ru/3.5/library/os.path.html#os.path.basename).192193#### `os.path.splitdrive(path)`194195Разделяет путь *path* на пару `(drive, tail)`, где *drive* – либо точка монтирования, либо пустая строка. В системах, не использующих спецификации дисков, *drive* всегда будет пустой строкой. В любом случае `drive + tail` будет тем же, что и *path*.196197В Windows разделяет путь на диск/UNC-ресурс и относительный путь.198199Если путь содержит букву диска, drive будет содержать всё до двоеточия включительно. Например, `splitdrive("c:/dir")` возвращает `("c:", "/dir")`200201Если путь содержит UNC-путь, drive будет содержать имя узла и общую папку (share) до четвёртого разделителя, не включая его. Например, `splitdrive("//host/computer/dir")` возвращает `("//host/computer", "/dir")`202203#### `os.path.splitext(path)`204205Разделяет путь *путь* на пару `(root, ext)` так, что `root + ext == path`, а *ext* является пустой строкой или начинается с точки и содержит не более одной точки. Начальные точки в базовом имени игнорируются; `splitext('.cshrc')` возвращает `('.cshrc', '')`.206207#### `os.path.splitunc(path)`208209Устарело с версии 3.1: Вместо этого используйте *splitdrive*.210211Разделяет путь *path* на пару `(unc, rest)` так, что *unc* – это точка монтирования UNC (например, `r'\\host\mount'`), если она присутствует, а *rest* – остальная часть пути (например, `r'\path\file.ext'`). Для путей, содержащих буквы дисков, *unc* всегда будет пустой строкой.212213Доступность: Windows.214215#### `os.path.supports_unicode_filenames`216217`True`, если произвольные строки Unicode могут использоваться в качестве имён файлов (с учётом ограничений, накладываемых файловой системой).218