os.path --- Common pathname manipulations

Source code: Lib/genericpath.py, Lib/posixpath.py (for POSIX) and Lib/ntpath.py (for Windows).

Цей модуль реалізує деякі корисні функції для шляхів. Щоб прочитати або записати файли, перегляньте open(), а для доступу до файлової системи перегляньте модуль os. Параметри шляху можна передати як рядки, або байти, або будь-який об’єкт, що реалізує протокол os.PathLike.

Unlike a Unix shell, Python does not do any automatic path expansions. Functions such as expanduser() and expandvars() can be invoked explicitly when an application desires shell-like path expansion. (See also the glob module.)

Lihat juga

Modul pathlib menawarkan objek jalur tingkat tinggi.

Catatan

Усі ці функції приймають як параметри лише байти або лише рядкові об’єкти. Результатом є об’єкт того самого типу, якщо повертається шлях або ім’я файлу.

Catatan

Оскільки різні операційні системи мають різні імена шляхів, у стандартній бібліотеці є кілька версій цього модуля. Модуль os.path завжди є модулем шляху, який підходить для операційної системи, у якій працює Python, і тому його можна використовувати для локальних шляхів. Однак ви також можете імпортувати та використовувати окремі модулі, якщо хочете маніпулювати шляхом, який завжди має один із різних форматів. Усі вони мають однаковий інтерфейс:

  • posixpath для шляхів у стилі UNIX

  • ntpath для шляхів Windows

Berubah pada versi 3.8: exists(), lexists(), isdir(), isfile(), islink() і ismount() тепер замість цього повертають False створення винятку для шляхів, які містять символи або байти, які неможливо відобразити на рівні ОС.

os.path.abspath(path)

Повертає нормалізовану абсолютизовану версію імені шляху path. На більшості платформ це еквівалентно виклику функції normpath() таким чином: normpath(join(os.getcwd(), path)).

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.basename(path, /)

Повертає базову назву шляху path. Це другий елемент пари, що повертається шляхом передачі path до функції split(). Зверніть увагу, що результат цієї функції відрізняється від програми Unix basename; де basename для '/foo/bar/' повертає 'bar', функція basename() повертає порожній рядок ('').

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.commonpath(paths)

Return the longest common sub-path of each pathname in the iterable paths. Raise ValueError if paths contain both absolute and relative pathnames, if paths are on different drives, or if paths is empty. Unlike commonprefix(), this returns a valid path.

Added in version 3.5.

Berubah pada versi 3.6: Приймає послідовність шляхових об’єктів.

Berubah pada versi 3.13: Any iterable can now be passed, rather than just sequences.

os.path.commonprefix(list, /)

Повертає найдовший префікс шляху (взятий посимвольно), який є префіксом усіх шляхів у списку. Якщо список порожній, поверніть порожній рядок ('').

Catatan

Ця функція може повертати недійсні шляхи, оскільки вона працює по символам за раз. Щоб отримати правильний шлях, перегляньте commonpath().

>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.dirname(path, /)

Повертає назву каталогу path. Це перший елемент пари, який повертається шляхом передачі шляху до функції split().

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.exists(path)

Повертає True, якщо path посилається на існуючий шлях або дескриптор відкритого файлу. Повертає False для пошкоджених символічних посилань. На деяких платформах ця функція може повертати False, якщо не надано дозвіл на виконання os.stat() над запитуваним файлом, навіть якщо шлях фізично існує.

Berubah pada versi 3.3: шлях тепер може бути цілим числом: True повертається, якщо це дескриптор відкритого файлу, False інакше.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.lexists(path)

Return True if path refers to an existing path, including broken symbolic links. Equivalent to exists() on platforms lacking os.lstat().

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.expanduser(path)

В Unix і Windows поверніть аргумент із початковим компонентом ~ або ~user, заміненим домашнім каталогом користувача.

В Unix початковий ~ замінюється змінною середовища HOME, якщо вона встановлена; інакше домашній каталог поточного користувача шукається в каталозі паролів за допомогою вбудованого модуля pwd. Початковий ~користувач шукається безпосередньо в каталозі паролів.

On Windows, USERPROFILE will be used if set, otherwise a combination of HOMEPATH and HOMEDRIVE will be used. An initial ~user is handled by checking that the last directory component of the current user's home directory matches USERNAME, and replacing it if so.

Якщо розширення не вдається або якщо шлях не починається з тильди, шлях повертається без змін.

Berubah pada versi 3.6: Menerima sebuah path-like object.

Berubah pada versi 3.8: Більше не використовує HOME у Windows.

os.path.expandvars(path)

Повертає аргумент із розгорнутими змінними середовища. Підрядки у формі $name або ${name} замінюються значенням змінної середовища name. Неправильні назви змінних і посилання на неіснуючі змінні залишаються без змін.

У Windows підтримуються розширення %name% на додаток до $name і ${name}.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.getatime(path, /)

Return the time of last access of path. The return value is a floating-point number giving the number of seconds since the epoch (see the time module). Raise OSError if the file does not exist or is inaccessible.

os.path.getmtime(path, /)

Return the time of last modification of path. The return value is a floating-point number giving the number of seconds since the epoch (see the time module). Raise OSError if the file does not exist or is inaccessible.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.getctime(path, /)

Повертає системний час ctime, який у деяких системах (наприклад, Unix) є часом останньої зміни метаданих, а в інших (наприклад, Windows) є часом створення шляху. Поверненим значенням є число, що вказує кількість секунд з моменту епохи (див. модуль time). Викликати OSError, якщо файл не існує або недоступний.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.getsize(path, /)

Повертає розмір у байтах шляху. Викликати OSError, якщо файл не існує або недоступний.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.isabs(path, /)

Return True if path is an absolute pathname. On Unix, that means it begins with a slash, on Windows that it begins with two (back)slashes, or a drive letter, colon, and (back)slash together.

Berubah pada versi 3.6: Menerima sebuah path-like object.

Berubah pada versi 3.13: On Windows, returns False if the given path starts with exactly one (back)slash.

os.path.isfile(path)

Повертає True, якщо path є існуючим звичайним файлом. Це йде за символічними посиланнями, тому і islink(), і isfile() можуть бути істинними для одного шляху.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.isdir(path, /)

Повертає True, якщо path є існуючим каталогом. Це слідує за символічними посиланнями, тому і islink(), і isdir() можуть бути вірними для одного шляху.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.isjunction(path)

Return True if path refers to an existing directory entry that is a junction. Always return False if junctions are not supported on the current platform.

Added in version 3.12.

Повертає True, якщо path посилається на існуючий запис каталогу, який є символічним посиланням. Завжди False, якщо символічні посилання не підтримуються середовищем виконання Python.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.ismount(path)

Return True if pathname path is a mount point: a point in a file system where a different file system has been mounted. On POSIX, the function checks whether path's parent, path/.., is on a different device than path, or whether path/.. and path point to the same i-node on the same device --- this should detect mount points for all Unix and POSIX variants. It is not able to reliably detect bind mounts on the same filesystem. On Linux systems, it will always return True for btrfs subvolumes, even if they aren't mount points. On Windows, a drive letter root and a share UNC are always mount points, and for any other path GetVolumePathName is called to see if it is different from the input path.

Berubah pada versi 3.4: Added support for detecting non-root mount points on Windows.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.isdevdrive(path)

Return True if pathname path is located on a Windows Dev Drive. A Dev Drive is optimized for developer scenarios, and offers faster performance for reading and writing files. It is recommended for use for source code, temporary build directories, package caches, and other IO-intensive operations.

May raise an error for an invalid path, for example, one without a recognizable drive, but returns False on platforms that do not support Dev Drives. See the Windows documentation for information on enabling and creating Dev Drives.

Added in version 3.12.

Berubah pada versi 3.13: The function is now available on all platforms, and will always return False on those that have no support for Dev Drives

os.path.isreserved(path)

Return True if path is a reserved pathname on the current system.

On Windows, reserved filenames include those that end with a space or dot; those that contain colons (i.e. file streams such as "name:stream"), wildcard characters (i.e. '*?"<>'), pipe, or ASCII control characters; as well as DOS device names such as "NUL", "CON", "CONIN$", "CONOUT$", "AUX", "PRN", "COM1", and "LPT1".

Catatan

This function approximates rules for reserved paths on most Windows systems. These rules change over time in various Windows releases. This function may be updated in future Python releases as changes to the rules become broadly available.

Availability: Windows.

Added in version 3.13.

os.path.join(path, /, *paths)

Join one or more path segments intelligently. The return value is the concatenation of path and all members of *paths, with exactly one directory separator following each non-empty part, except the last. That is, the result will only end in a separator if the last part is either empty or ends in a separator. If a segment is an absolute path (which on Windows requires both a drive and a root), then all previous segments are ignored and joining continues from the absolute path segment.

On Windows, the drive is not reset when a rooted path segment (e.g., r'\foo') is encountered. If a segment is on a different drive or is an absolute path, all previous segments are ignored and the drive is reset. Note that since there is a current directory for each drive, os.path.join("c:", "foo") represents a path relative to the current directory on drive C: (c:foo), not c:\foo.

Berubah pada versi 3.6: Приймає path-like object для path і paths.

os.path.normcase(path, /)

Нормалізуйте регістр імені шляху. У Windows перетворіть усі символи в імені шляху на малі літери, а також перетворіть косі риски на зворотні. В інших операційних системах повертайте шлях без змін.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.normpath(path)

Нормалізуйте шлях шляхом згортання надлишкових роздільників і посилань верхнього рівня, щоб A//B, A/B/, A/./B і A/foo/.. /B всі стають A/B. Ця маніпуляція рядком може змінити значення шляху, який містить символічні посилання. У Windows він перетворює косі риски на зворотні. Щоб нормалізувати регістр, використовуйте normcase().

Catatan

On POSIX systems, in accordance with IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution, if a pathname begins with exactly two slashes, the first component following the leading characters may be interpreted in an implementation-defined manner, although more than two leading characters shall be treated as a single character.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.realpath(path, /, *, strict=False)

Return the canonical path of the specified filename, eliminating any symbolic links encountered in the path (if they are supported by the operating system). On Windows, this function will also resolve MS-DOS (also called 8.3) style names such as C:\\PROGRA~1 to C:\\Program Files.

Por padrão, o caminho é avaliado até o primeiro componente que não existe, é um laço de link simbólico ou cuja avaliação levanta OSError. Todos esses componentes são anexados inalterados à parte existente do caminho.

Alguns erros tratados dessa forma incluem "acesso negado", "não é um diretório" ou "argumento inválido para função interna". Assim, o caminho resultante pode estar ausente ou inacessível, ainda pode conter links ou laços e pode passar por diretórios não especificados.

Esse comportamento pode ser modificado por argumentos nomeados:

Se strict for True, o primeiro erro encontrado ao avaliar o caminho será levantado novamente. Em particular, FileNotFoundError é levantada se path não existir, ou outro OSError se ele estiver inacessível.

Se strict for os.path.ALLOW_MISSING, erros diferentes de FileNotFoundError serão levantados novamente (como em strict=True). Portanto, o caminho retornado não conterá nenhum link simbólico, mas o arquivo nomeado e alguns de seus diretórios pais podem estar ausentes.

Catatan

Ця функція емулює процедуру операційної системи, щоб зробити шлях канонічним, який дещо відрізняється між Windows і UNIX стосовно того, як взаємодіють посилання та наступні компоненти шляху.

API операційної системи роблять шляхи канонічними за потреби, тому зазвичай не потрібно викликати цю функцію.

Berubah pada versi 3.6: Menerima sebuah path-like object.

Berubah pada versi 3.8: Символічні зв’язки та з’єднання тепер розпізнаються у Windows.

Berubah pada versi 3.10: Parametr strict został dodany.

Berubah pada versi 3.14: O valor ALLOW_MISSING para o parâmetro strict foi adicionado.

os.path.ALLOW_MISSING

Valor especial usado para o argumento strict em realpath().

Added in version 3.14.

os.path.relpath(path, start=os.curdir)

Повертає відносний шлях до файлу до path або з поточного каталогу, або з додаткового каталогу start. Це обчислення шляху: доступ до файлової системи не здійснюється для підтвердження існування або природи шляху або початку. У Windows ValueError виникає, коли шлях і початок знаходяться на різних дисках.

start defaults to os.curdir.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.samefile(path1, path2, /)

Повертає True, якщо обидва аргументи шляху посилаються на той самий файл або каталог. Це визначається номером пристрою та номером i-вузла та викликає виняток, якщо виклик os.stat() будь-якого шляху не вдається.

Berubah pada versi 3.2: Dodano wsparcie dla WIndowsa.

Berubah pada versi 3.4: Windows тепер використовує ту саму реалізацію, що й усі інші платформи.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.sameopenfile(fp1, fp2)

Повертає True, якщо файлові дескриптори fp1 і fp2 стосуються одного файлу.

Berubah pada versi 3.2: Dodano wsparcie dla WIndowsa.

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.samestat(stat1, stat2, /)

Повертає True, якщо кортежі статистики stat1 і stat2 посилаються на той самий файл. Ці структури могли бути повернуті os.fstat(), os.lstat() або os.stat(). Ця функція реалізує основне порівняння, яке використовується samefile() і sameopenfile().

Berubah pada versi 3.4: Dodano wsparcie dla WIndowsa.

os.path.split(path, /)

Розділіть шлях path на пару, (head, tail), де tail — це останній компонент шляху, а head — усе, що веде до нього. Частина хвоста ніколи не міститиме косу риску; якщо шлях закінчується скісною рискою, хвіст буде порожнім. Якщо в path немає скісної риски, head буде порожнім. Якщо шлях порожній, і голова, і хвіст порожні. Кінцеві похилі риски видаляються з голови, якщо це не корінь (лише одна або кілька похилих). У всіх випадках join(head, tail) повертає шлях до того самого місця, що й path (але рядки можуть відрізнятися). Також перегляньте функції dirname() і basename().

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.splitdrive(path, /)

Розділіть назву шляху path на пару (диск, хвіст), де диск є або точкою монтування, або порожнім рядком. У системах, які не використовують специфікації дисків, drive завжди буде порожнім рядком. У всіх випадках drive + tail буде таким самим, як path.

У Windows розділяє шлях на диск/загальну точку UNC і відносний шлях.

Якщо шлях містить букву диска, диск міститиме все, аж до двокрапки включно:

>>> splitdrive("c:/dir")
("c:", "/dir")

If the path contains a UNC path, drive will contain the host name and share:

>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.splitroot(path, /)

Split the pathname path into a 3-item tuple (drive, root, tail) where drive is a device name or mount point, root is a string of separators after the drive, and tail is everything after the root. Any of these items may be the empty string. In all cases, drive + root + tail will be the same as path.

On POSIX systems, drive is always empty. The root may be empty (if path is relative), a single forward slash (if path is absolute), or two forward slashes (implementation-defined per IEEE Std 1003.1-2017; 4.13 Pathname Resolution.) For example:

>>> splitroot('/home/sam')
('', '/', 'home/sam')
>>> splitroot('//home/sam')
('', '//', 'home/sam')
>>> splitroot('///home/sam')
('', '/', '//home/sam')

On Windows, drive may be empty, a drive-letter name, a UNC share, or a device name. The root may be empty, a forward slash, or a backward slash. For example:

>>> splitroot('C:/Users/Sam')
('C:', '/', 'Users/Sam')
>>> splitroot('//Server/Share/Users/Sam')
('//Server/Share', '/', 'Users/Sam')

Added in version 3.12.

os.path.splitext(path, /)

Розділіть назву шляху path на пару (root, ext) таким чином, root + ext == path, а розширення ext буде порожнім або починається з крапки та містить щонайбільше один період.

Якщо шлях не містить розширення, ext буде '':

>>> splitext('bar')
('bar', '')

Якщо шлях містить розширення, то ext буде встановлено для цього розширення, включаючи початкову точку. Зауважте, що попередні періоди ігноруватимуться:

>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
>>> splitext('/foo/bar.exe')
('/foo/bar', '.exe')

Початкові періоди останнього компонента шляху вважаються частиною кореня:

>>> splitext('.cshrc')
('.cshrc', '')
>>> splitext('/foo/....jpg')
('/foo/....jpg', '')

Berubah pada versi 3.6: Menerima sebuah path-like object.

os.path.supports_unicode_filenames

True, якщо довільні рядки Unicode можуть використовуватися як імена файлів (в межах обмежень, накладених файловою системою).