pathlib — Шляхи до об’єктно-орієнтованої файлової системи

Нове в версії 3.4.

Вихідний код: Lib/pathlib.py

---

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

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

Чисті шляхи корисні в деяких особливих випадках; наприклад:

1. Якщо ви хочете маніпулювати шляхами Windows на машині Unix (або навпаки). Ви не можете створити екземпляр WindowsPath під час роботи в Unix, але ви можете створити екземпляр PureWindowsPath.

2. Ви хочете переконатися, що ваш код обробляє лише шляхи без фактичного доступу до ОС. У цьому випадку створення одного з чистих класів може бути корисним, оскільки вони просто не мають жодних операцій доступу до ОС.

Дивись також

PEP 428: Модуль pathlib – шляхи об’єктно-орієнтованої файлової системи.

Дивись також

Для низькорівневих маніпуляцій шляхом до рядків ви також можете використовувати модуль os.path.

Основне використання

Імпорт основного класу:

>>> from pathlib import Path

Перелік підкаталогів:

>>> p = Path('.')
>>> [x for x in p.iterdir() if x.is_dir()]
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
 PosixPath('__pycache__'), PosixPath('build')]

Перелік вихідних файлів Python у цьому дереві каталогів:

>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
 PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
 PosixPath('build/lib/pathlib.py')]

Навігація всередині дерева каталогів:

>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')

Властивості шляху запиту:

>>> q.exists()
True
>>> q.is_dir()
False

Відкриття файлу:

>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'

Чисті стежки

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

class pathlib.PurePath(*pathsegments)

Загальний клас, який представляє шлях до системи (його екземпляр створює або PurePosixPath, або PureWindowsPath):

>>> PurePath('setup.py')      # Running on a Unix machine
PurePosixPath('setup.py')

Each element of pathsegments can be either a string representing a path segment, an object implementing the os.PathLike interface which returns a string, or another path object:

>>> PurePath('foo', 'some/path', 'bar')
PurePosixPath('foo/some/path/bar')
>>> PurePath(Path('foo'), Path('bar'))
PurePosixPath('foo/bar')

Якщо pathsegments порожній, передбачається поточний каталог:

>>> PurePath()
PurePosixPath('.')

If a segment is an absolute path, all previous segments are ignored (like os.path.join()):

>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')

On Windows, the drive is not reset when a rooted relative path segment (e.g., r'\foo') is encountered:

>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')

Фальшиві косі риски та одиночні крапки згортаються, але подвійні крапки ('..'') і початкові подвійні косі риски ('//') – ні, оскільки це може змінити значення шляху з різних причин (наприклад, символічні посилання, шляхи UNC):

>>> PurePath('foo//bar')
PurePosixPath('foo/bar')
>>> PurePath('//foo/bar')
PurePosixPath('//foo/bar')
>>> PurePath('foo/./bar')
PurePosixPath('foo/bar')
>>> PurePath('foo/../bar')
PurePosixPath('foo/../bar')

(наївний підхід зробив би PurePosixPath('foo/../bar') еквівалентним PurePosixPath('bar'), що є неправильним, якщо foo є символічним посиланням на інший каталог )

Об’єкти чистого шляху реалізують інтерфейс os.PathLike, що дозволяє використовувати їх будь-де, де прийнятний інтерфейс.

Змінено в версії 3.6: Додано підтримку інтерфейсу os.PathLike.

class pathlib.PurePosixPath(*pathsegments)

Підклас PurePath, цей варіант шляху представляє шляхи до файлової системи не Windows:

>>> PurePosixPath('/etc')
PurePosixPath('/etc')

pathsegments вказується подібно до PurePath.

class pathlib.PureWindowsPath(*pathsegments)

Підклас PurePath, цей варіант шляху представляє шляхи файлової системи Windows, включаючи шляхи UNC:

>>> PureWindowsPath('c:/Program Files/')
PureWindowsPath('c:/Program Files')
>>> PureWindowsPath('//server/share/file')
PureWindowsPath('//server/share/file')

pathsegments вказується подібно до PurePath.

Незалежно від системи, на якій ви працюєте, ви можете створити екземпляри всіх цих класів, оскільки вони не забезпечують жодних операцій, які виконують системні виклики.

Загальні властивості

Paths are immutable and hashable. Paths of a same flavour are comparable and orderable. These properties respect the flavour’s case-folding semantics:

>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True

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

>>> PureWindowsPath('foo') == PurePosixPath('foo')
False
>>> PureWindowsPath('foo') < PurePosixPath('foo')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'

Оператори

The slash operator helps create child paths, like os.path.join(). If the argument is an absolute path, the previous path is ignored. On Windows, the drive is not reset when the argument is a rooted relative path (e.g., r'\foo'):

>>> p = PurePath('/etc')
>>> p
PurePosixPath('/etc')
>>> p / 'init.d' / 'apache2'
PurePosixPath('/etc/init.d/apache2')
>>> q = PurePath('bin')
>>> '/usr' / q
PurePosixPath('/usr/bin')
>>> p / '/an_absolute_path'
PurePosixPath('/an_absolute_path')
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')

Об’єкт шляху можна використовувати скрізь, де прийнятний об’єкт, що реалізує os.PathLike:

>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'

Рядкове представлення шляху — це сам необроблений шлях до файлової системи (у рідній формі, наприклад із зворотними похилими рисками під Windows), який ви можете передати будь-якій функції, яка приймає шлях до файлу як рядок:

>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'

Подібним чином виклик bytes для шляху дає необроблений шлях до файлової системи як об’єкт bytes, закодований os.fsencode():

>>> bytes(p)
b'/etc'

Примітка

Виклик bytes рекомендовано лише в Unix. У Windows форма Юнікод є канонічним представленням шляхів файлової системи.

Доступ до окремих частин

Щоб отримати доступ до окремих «частин» (компонентів) шляху, використовуйте наступну властивість:

PurePath.parts

Кортеж, що надає доступ до різних компонентів шляху:

>>> p = PurePath('/usr/bin/python3')
>>> p.parts
('/', 'usr', 'bin', 'python3')

>>> p = PureWindowsPath('c:/Program Files/PSF')
>>> p.parts
('c:\\', 'Program Files', 'PSF')

(зверніть увагу, як диск і локальний корінь перегруповані в одній частині)

Методи та властивості

Чисті шляхи забезпечують такі методи та властивості:

PurePath.drive

Рядок, що представляє літеру або назву диска, якщо є:

>>> PureWindowsPath('c:/Program Files/').drive
'c:'
>>> PureWindowsPath('/Program Files/').drive
''
>>> PurePosixPath('/etc').drive
''

Акції UNC також вважаються накопичувачами:

>>> PureWindowsPath('//host/share/foo.txt').drive
'\\\\host\\share'

PurePath.root

Рядок, що представляє (локальний або глобальний) корінь, якщо такий є:

>>> PureWindowsPath('c:/Program Files/').root
'\\'
>>> PureWindowsPath('c:Program Files/').root
''
>>> PurePosixPath('/etc').root
'/'

Акції UNC завжди мають корінь:

>>> PureWindowsPath('//host/share').root
'\\'

Якщо шлях починається з більш ніж двох послідовних похилих рисок, PurePosixPath їх згортає:

>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'

Примітка

This behavior conforms to The Open Group Base Specifications Issue 6, paragraph 4.11 Pathname Resolution:

«Ім’я шляху, що починається з двох послідовних похилих рисок, може інтерпретуватися у спосіб, визначений реалізацією, хоча більше двох початкових похилих рисок повинні розглядатися як одна похила риска.»

PurePath.anchor

Конкатенація диска та кореня:

>>> PureWindowsPath('c:/Program Files/').anchor
'c:\\'
>>> PureWindowsPath('c:Program Files/').anchor
'c:'
>>> PurePosixPath('/etc').anchor
'/'
>>> PureWindowsPath('//host/share').anchor
'\\\\host\\share\\'

PurePath.parents

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

>>> p = PureWindowsPath('c:/foo/bar/setup.py')
>>> p.parents[0]
PureWindowsPath('c:/foo/bar')
>>> p.parents[1]
PureWindowsPath('c:/foo')
>>> p.parents[2]
PureWindowsPath('c:/')

Змінено в версії 3.10: Батьківська послідовність тепер підтримує slices і від’ємні значення індексу.

PurePath.parent

Логічний батько шляху:

>>> p = PurePosixPath('/a/b/c/d')
>>> p.parent
PurePosixPath('/a/b/c')

Ви не можете пройти повз якір або порожній шлях

>>> p = PurePosixPath('/')
>>> p.parent
PurePosixPath('/')
>>> p = PurePosixPath('.')
>>> p.parent
PurePosixPath('.')

Примітка

Це суто лексична операція, тому така поведінка:

>>> p = PurePosixPath('foo/..')
>>> p.parent
PurePosixPath('foo')

If you want to walk an arbitrary filesystem path upwards, it is recommended to first call Path.resolve() so as to resolve symlinks and eliminate ".." components.

PurePath.name

Рядок, що представляє кінцевий компонент шляху, за винятком диска та кореня, якщо такі є:

>>> PurePosixPath('my/library/setup.py').name
'setup.py'

Назви дисків UNC не враховуються:

>>> PureWindowsPath('//some/share/setup.py').name
'setup.py'
>>> PureWindowsPath('//some/share').name
''

PurePath.suffix

Розширення файлу кінцевого компонента, якщо є:

>>> PurePosixPath('my/library/setup.py').suffix
'.py'
>>> PurePosixPath('my/library.tar.gz').suffix
'.gz'
>>> PurePosixPath('my/library').suffix
''

PurePath.suffixes

Список розширень файлів шляху:

>>> PurePosixPath('my/library.tar.gar').suffixes
['.tar', '.gar']
>>> PurePosixPath('my/library.tar.gz').suffixes
['.tar', '.gz']
>>> PurePosixPath('my/library').suffixes
[]

PurePath.stem

Остаточний компонент шляху без суфікса:

>>> PurePosixPath('my/library.tar.gz').stem
'library.tar'
>>> PurePosixPath('my/library.tar').stem
'library'
>>> PurePosixPath('my/library').stem
'library'

PurePath.as_posix()

Повертає рядкове представлення шляху з похилою рискою (/):

>>> p = PureWindowsPath('c:\\windows')
>>> str(p)
'c:\\windows'
>>> p.as_posix()
'c:/windows'

PurePath.as_uri()

Уявіть шлях як URI файлу. ValueError виникає, якщо шлях не є абсолютним.

>>> p = PurePosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = PureWindowsPath('c:/Windows')
>>> p.as_uri()
'file:///c:/Windows'

PurePath.is_absolute()

Повернути, чи є шлях абсолютним чи ні. Шлях вважається абсолютним, якщо він має як корінь, так і (якщо дозволяє аромат) диск:

>>> PurePosixPath('/a/b').is_absolute()
True
>>> PurePosixPath('a/b').is_absolute()
False

>>> PureWindowsPath('c:/a/b').is_absolute()
True
>>> PureWindowsPath('/a/b').is_absolute()
False
>>> PureWindowsPath('c:').is_absolute()
False
>>> PureWindowsPath('//some/share').is_absolute()
True

PurePath.is_relative_to(*other)

Повертає, чи є цей шлях відносно іншого шляху.

>>> p = PurePath('/etc/passwd')
>>> p.is_relative_to('/etc')
True
>>> p.is_relative_to('/usr')
False

If multiple arguments are supplied, they are joined together.

This method is string-based; it neither accesses the filesystem nor treats «..» segments specially. The following code is equivalent:

>>> u = PurePath('/usr')
>>> u == p or u in p.parents
False

Нове в версії 3.9.

PurePath.is_reserved()

За допомогою PureWindowsPath поверніть True, якщо шлях вважається зарезервованим під Windows, False інакше. З PurePosixPath завжди повертається False.

>>> PureWindowsPath('nul').is_reserved()
True
>>> PurePosixPath('nul').is_reserved()
False

Виклики файлової системи за зарезервованими шляхами можуть призвести до таємничої помилки або призвести до небажаних наслідків.

PurePath.joinpath(*other)

Calling this method is equivalent to combining the path with each of the other arguments in turn:

>>> PurePosixPath('/etc').joinpath('passwd')
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
PurePosixPath('/etc/init.d/apache2')
>>> PureWindowsPath('c:').joinpath('/Program Files')
PureWindowsPath('c:/Program Files')

PurePath.match(pattern)

Зіставте цей шлях із наданим шаблоном у стилі glob. Повертає True, якщо зіставлення вдалось, False інакше.

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

>>> PurePath('a/b.py').match('*.py')
True
>>> PurePath('/a/b/c.py').match('b/*.py')
True
>>> PurePath('/a/b/c.py').match('a/*.py')
False

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

>>> PurePath('/a.py').match('/*.py')
True
>>> PurePath('a/b.py').match('/*.py')
False

Як і в інших методах, чутливість до регістру відповідає стандартам платформи:

>>> PurePosixPath('b.py').match('*.PY')
False
>>> PureWindowsPath('b.py').match('*.PY')
True

PurePath.relative_to(*other)

Compute a version of this path relative to the path represented by other. If it’s impossible, ValueError is raised:

>>> p = PurePosixPath('/etc/passwd')
>>> p.relative_to('/')
PurePosixPath('etc/passwd')
>>> p.relative_to('/etc')
PurePosixPath('passwd')
>>> p.relative_to('/usr')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 694, in relative_to
    .format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other absolute.

If multiple arguments are supplied, they are joined together.

NOTE: This function is part of PurePath and works with strings. It does not check or access the underlying file structure.

PurePath.with_name(name)

Повертає новий шлях зі зміненим name. Якщо вихідний шлях не має імені, виникає ValueError:

>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_name('setup.py')
PureWindowsPath('c:/Downloads/setup.py')
>>> p = PureWindowsPath('c:/')
>>> p.with_name('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name

PurePath.with_stem(stem)

Повертає новий шлях зі зміненим stem. Якщо вихідний шлях не має імені, виникає ValueError:

>>> p = PureWindowsPath('c:/Downloads/draft.txt')
>>> p.with_stem('final')
PureWindowsPath('c:/Downloads/final.txt')
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_stem('lib')
PureWindowsPath('c:/Downloads/lib.gz')
>>> p = PureWindowsPath('c:/')
>>> p.with_stem('')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 861, in with_stem
    return self.with_name(stem + self.suffix)
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 851, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name

Нове в версії 3.9.

PurePath.with_suffix(suffix)

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

>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_suffix('.bz2')
PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
>>> p = PureWindowsPath('README')
>>> p.with_suffix('.txt')
PureWindowsPath('README.txt')
>>> p = PureWindowsPath('README.txt')
>>> p.with_suffix('')
PureWindowsPath('README')

Бетонні доріжки

Конкретні шляхи є підкласами класів чистих шляхів. На додаток до операцій, наданих останнім, вони також надають методи для виконання системних викликів об’єктів шляху. Є три способи створення конкретних шляхів:

class pathlib.Path(*pathsegments)

Підклас PurePath, цей клас представляє конкретні шляхи шляхів системи (інстанціювання створює або PosixPath, або WindowsPath):

>>> Path('setup.py')
PosixPath('setup.py')

pathsegments вказується подібно до PurePath.

class pathlib.PosixPath(*pathsegments)

Підклас Path і PurePosixPath, цей клас представляє конкретні шляхи до файлової системи не Windows:

>>> PosixPath('/etc')
PosixPath('/etc')

pathsegments вказується подібно до PurePath.

class pathlib.WindowsPath(*pathsegments)

Підклас Path і PureWindowsPath, цей клас представляє конкретні шляхи файлової системи Windows:

>>> WindowsPath('c:/Program Files/')
WindowsPath('c:/Program Files')

pathsegments вказується подібно до PurePath.

Ви можете створити лише екземпляр класу, який відповідає вашій системі (дозвол системних викликів за несумісними варіантами шляху може призвести до помилок або збоїв у вашій програмі):

>>> import os
>>> os.name
'posix'
>>> Path('setup.py')
PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
>>> WindowsPath('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 798, in __new__
    % (cls.__name__,))
NotImplementedError: cannot instantiate 'WindowsPath' on your system

методи

Конкретні шляхи надають наступні методи на додаток до методів чистих шляхів. Багато з цих методів можуть викликати OSError, якщо системний виклик не вдається (наприклад, через те, що шлях не існує).

Змінено в версії 3.8: exists(), is_dir(), is_file(), is_mount(), is_symlink(), is_block_device(), is_char_device(), is_fifo(), is_socket() тепер повертає False замість того, щоб викликати виключення для шляхів, які містять символи, які неможливо відобразити на рівні ОС.

classmethod Path.cwd()

Повертає новий об’єкт шляху, що представляє поточний каталог (як повертає os.getcwd()):

>>> Path.cwd()
PosixPath('/home/antoine/pathlib')

classmethod Path.home()

Повертає новий об’єкт шляху, що представляє домашній каталог користувача (як повертає os.path.expanduser() за допомогою конструкції ~). Якщо не вдається вирішити домашній каталог, виникає RuntimeError.

>>> Path.home()
PosixPath('/home/antoine')

Нове в версії 3.5.

Path.stat(*, follow_symlinks=True)

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

Цей метод зазвичай слідує за символічними посиланнями; щоб стати символічним посиланням, додайте аргумент follow_symlinks=False або використовуйте lstat().

>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554

Змінено в версії 3.10: Додано параметр follow_symlinks.

Path.chmod(mode, *, follow_symlinks=True)

Змініть режим файлу та дозволи, наприклад os.chmod().

Цей метод зазвичай слідує за символічними посиланнями. Деякі різновиди Unix підтримують зміну дозволів для самого символічного посилання; на цих платформах ви можете додати аргумент follow_symlinks=False або використовувати lchmod().

>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060

Змінено в версії 3.10: Додано параметр follow_symlinks.

Path.exists()

Whether the path points to an existing file or directory:

>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False

Примітка

If the path points to a symlink, exists() returns whether the symlink points to an existing file or directory.

Path.expanduser()

Повертає новий шлях із розширеними конструкціями ~ і ~user, як повертає os.path.expanduser(). Якщо не вдається вирішити домашній каталог, виникає RuntimeError.

>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')

Нове в версії 3.5.

Path.glob(pattern)

Помістіть заданий відносний шаблон у каталог, представлений цим шляхом, одержуючи всі відповідні файли (будь-якого типу):

>>> sorted(Path('.').glob('*.py'))
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
>>> sorted(Path('.').glob('*/*.py'))
[PosixPath('docs/conf.py')]

Шаблони такі ж, як і для fnmatch, з додаванням «**», що означає «цей каталог і всі підкаталоги, рекурсивно». Іншими словами, це дозволяє рекурсивне глоббування:

>>> sorted(Path('.').glob('**/*.py'))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]

Примітка

Використання шаблону «**» у великих деревах каталогів може зайняти надто багато часу.

Викликає подію аудиту pathlib.Path.glob з аргументами self, pattern.

Змінено в версії 3.11: Return only directories if pattern ends with a pathname components separator (sep or altsep).

Path.group()

Повернути назву групи, якій належить файл. KeyError виникає, якщо gid файлу не знайдено в системній базі даних.

Path.is_dir()

Повертає True, якщо шлях вказує на каталог (або символічне посилання, що вказує на каталог), False, якщо він вказує на інший тип файлу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_file()

Повертає True, якщо шлях вказує на звичайний файл (або символічне посилання, що вказує на звичайний файл), False, якщо він вказує на файл іншого типу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_mount()

Return True if the 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. Not implemented on Windows.

Нове в версії 3.7.

Path.is_symlink()

Повертає True, якщо шлях вказує на символічне посилання, False інакше.

False також повертається, якщо шлях не існує; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_socket()

Повертає True, якщо шлях вказує на сокет Unix (або символічне посилання, що вказує на сокет Unix), False, якщо він вказує на інший тип файлу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_fifo()

Повертає True, якщо шлях вказує на FIFO (або символічне посилання, що вказує на FIFO), False, якщо він вказує на інший тип файлу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_block_device()

Повертає True, якщо шлях вказує на блоковий пристрій (або символічне посилання, що вказує на блоковий пристрій), False, якщо він вказує на інший тип файлу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.is_char_device()

Повертає True, якщо шлях вказує на символьний пристрій (або символічне посилання, що вказує на символьний пристрій), False, якщо він вказує на інший тип файлу.

False також повертається, якщо шлях не існує або це несправне символічне посилання; інші помилки (наприклад, помилки дозволу) поширюються.

Path.iterdir()

Коли шлях вказує на каталог, видає об’єкти шляху вмісту каталогу:

>>> p = Path('docs')
>>> for child in p.iterdir(): child
...
PosixPath('docs/conf.py')
PosixPath('docs/_templates')
PosixPath('docs/make.bat')
PosixPath('docs/index.rst')
PosixPath('docs/_build')
PosixPath('docs/_static')
PosixPath('docs/Makefile')

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

Path.lchmod(mode)

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

Path.lstat()

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

Path.mkdir(mode=0o777, parents=False, exist_ok=False)

Створіть новий каталог за вказаним шляхом. Якщо задано mode, воно поєднується зі значенням umask процесу для визначення режиму файлу та позначок доступу. Якщо шлях уже існує, виникає FileExistsError.

Якщо parents має значення true, будь-які відсутні батьки цього шляху створюються за потреби; вони створюються з дозволами за замовчуванням без урахування mode (імітація команди POSIX mkdir -p).

Якщо parents має значення false (за замовчуванням), відсутній батьківський елемент викликає FileNotFoundError.

Якщо exist_ok має значення false (за замовчуванням), FileExistsError викликається, якщо цільовий каталог уже існує.

If exist_ok is true, FileExistsError will not be raised unless the given path already exists in the file system and is not a directory (same behavior as the POSIX mkdir -p command).

Змінено в версії 3.5: Додано параметр exist_ok.

Path.open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)

Відкрийте файл, на який вказує шлях, як це робить вбудована функція open():

>>> p = Path('setup.py')
>>> with p.open() as f:
...     f.readline()
...
'#!/usr/bin/env python3\n'

Path.owner()

Повернути ім’я користувача, якому належить файл. KeyError виникає, якщо uid файлу не знайдено в системній базі даних.

Path.read_bytes()

Повертає двійковий вміст зазначеного файлу як об’єкт bytes:

>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'

Нове в версії 3.5.

Path.read_text(encoding=None, errors=None)

Повертає декодований вміст вказаного файлу як рядок:

>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'

Файл відкривається, а потім закривається. Необов’язкові параметри мають те саме значення, що й у open().

Нове в версії 3.5.

Path.readlink()

Повертає шлях, на який вказує символічне посилання (як повертає os.readlink()):

>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')

Нове в версії 3.9.

Path.rename(target)

Перейменуйте цей файл або каталог на задану ціль і поверніть новий екземпляр шляху, що вказує на ціль. В Unix, якщо target існує і є файлом, його буде замінено мовчки, якщо користувач має дозвіл. У Windows, якщо ціль існує, буде викликано FileExistsError. target може бути або рядком, або іншим об’єктом шляху:

>>> p = Path('foo')
>>> p.open('w').write('some text')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'some text'

Цільовий шлях може бути абсолютним або відносним. Відносні шляхи інтерпретуються відносно поточного робочого каталогу, а не каталогу об’єкта Path.

It is implemented in terms of os.rename() and gives the same guarantees.

Змінено в версії 3.8: Додано значення, що повертається, повертає новий екземпляр Path.

Path.replace(target)

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

Цільовий шлях може бути абсолютним або відносним. Відносні шляхи інтерпретуються відносно поточного робочого каталогу, а не каталогу об’єкта Path.

Змінено в версії 3.8: Додано значення, що повертається, повертає новий екземпляр Path.

Path.absolute()

Make the path absolute, without normalization or resolving symlinks. Returns a new path object:

>>> p = Path('tests')
>>> p
PosixPath('tests')
>>> p.absolute()
PosixPath('/home/antoine/pathlib/tests')

Path.resolve(strict=False)

Зробіть шлях абсолютним, дозволяючи будь-які символічні посилання. Повертається новий об’єкт шляху:

>>> p = Path()
>>> p
PosixPath('.')
>>> p.resolve()
PosixPath('/home/antoine/pathlib')

Компоненти «..» також видаляються (це єдиний спосіб зробити це):

>>> p = Path('docs/../setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')

Якщо шлях не існує і strict має значення True, виникає FileNotFoundError. Якщо strict має значення False, шлях розв’язується, наскільки це можливо, і будь-який залишок додається без перевірки його існування. Якщо на шляху вирішення зустрічається нескінченний цикл, виникає RuntimeError.

Нове в версії 3.6: The strict argument (pre-3.6 behavior is strict).

Path.rglob(pattern)

This is like calling Path.glob() with «**/» added in front of the given relative pattern:

>>> sorted(Path().rglob("*.py"))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]

Викликає подію аудиту pathlib.Path.rglob з аргументами self, pattern.

Змінено в версії 3.11: Return only directories if pattern ends with a pathname components separator (sep or altsep).

Path.rmdir()

Видаліть цей каталог. Каталог має бути порожнім.

Path.samefile(other_path)

Повертає, чи цей шлях вказує на той самий файл, що й other_path, який може бути об’єктом Path або рядком. Семантика подібна до os.path.samefile() і os.path.samestat().

OSError може виникнути, якщо з певної причини неможливо отримати доступ до будь-якого файлу.

>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True

Нове в версії 3.5.

Path.symlink_to(target, target_is_directory=False)

Make this path a symbolic link pointing to target.

У Windows символічне посилання представляє або файл, або каталог і не перетворюється на ціль динамічно. Якщо ціль присутня, буде створено відповідний тип символічного посилання. В іншому випадку символічне посилання буде створено як каталог, якщо target_is_directory має значення True, або символічне посилання на файл (за замовчуванням), інакше. На платформах, відмінних від Windows, target_is_directory ігнорується.

>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
>>> p.stat().st_size
956
>>> p.lstat().st_size
8

Примітка

Порядок аргументів (посилання, ціль) є зворотним порядку os.symlink().

Path.hardlink_to(target)

Зробіть цей шлях жорстким посиланням на той самий файл, що й target.

Примітка

Порядок аргументів (посилання, ціль) є зворотним порядку os.link().

Нове в версії 3.10.

Path.link_to(target)

Make target a hard link to this path.

Попередження

This function does not make this path a hard link to target, despite the implication of the function and argument names. The argument order (target, link) is the reverse of Path.symlink_to() and Path.hardlink_to(), but matches that of os.link().

Нове в версії 3.8.

Застаріло починаючи з версії 3.10: This method is deprecated in favor of Path.hardlink_to(), as the argument order of Path.link_to() does not match that of Path.symlink_to().

Path.touch(mode=0o666, exist_ok=True)

Створіть файл за вказаним шляхом. Якщо задано mode, воно поєднується зі значенням umask процесу для визначення режиму файлу та позначок доступу. Якщо файл уже існує, функція виконується успішно, якщо exist_ok має значення true (і час його модифікації оновлюється до поточного часу), інакше виникає FileExistsError.

Path.unlink(missing_ok=False)

Видаліть цей файл або символічне посилання. Якщо шлях вказує на каталог, замість цього використовуйте Path.rmdir().

Якщо missing_ok має значення false (за замовчуванням), FileNotFoundError викликається, якщо шлях не існує.

Якщо missing_ok має значення true, винятки FileNotFoundError ігноруватимуться (така ж поведінка, що й команда POSIX rm -f).

Змінено в версії 3.8: Додано параметр missing_ok.

Path.write_bytes(data)

Відкрийте вказаний файл у байтовому режимі, запишіть у нього data та закрийте файл:

>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'

Існуючий файл із такою ж назвою буде перезаписано.

Нове в версії 3.5.

Path.write_text(data, encoding=None, errors=None, newline=None)

Відкрийте вказаний файл у текстовому режимі, запишіть у нього data та закрийте файл:

>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'

Існуючий файл із такою ж назвою буде перезаписано. Необов’язкові параметри мають те саме значення, що й у open().

Нове в версії 3.5.

Змінено в версії 3.10: Додано параметр новий рядок.

Відповідність інструментам в модулі os

Нижче наведено таблицю, що відображає різні функції os на їхні відповідні еквіваленти PurePath/Path.

Примітка

Not all pairs of functions/methods below are equivalent. Some of them, despite having some overlapping use-cases, have different semantics. They include os.path.abspath() and Path.absolute(), os.path.relpath() and PurePath.relative_to().

os і os.path	pathlib
os.path.abspath()	Path.absolute() [1]
os.path.realpath()	Path.resolve()
os.chmod()	Path.chmod()
os.mkdir()	Шлях.mkdir()
os.makedirs()	Шлях.mkdir()
os.rename()	Path.rename()
os.replace()	Path.replace()
os.rmdir()	Шлях.rmdir()
os.remove(), os.unlink()	Path.unlink()
os.getcwd()	Path.cwd()
os.path.exists()	Path.exists()
os.path.expanduser()	Path.expanduser() і Path.home()
os.listdir()	Path.iterdir()
os.path.isdir()	Path.is_dir()
os.path.isfile()	Шлях.є_файлом()
os.path.islink()	Path.is_symlink()
os.link()	Шлях.hardlink_to()
os.symlink()	Шлях.симпосилання_до()
os.readlink()	Path.readlink()
os.path.relpath()	PurePath.relative_to() [2]
os.stat()	Path.stat(), Path.owner(), Path.group()
os.path.isabs()	PurePath.is_absolute()
os.path.join()	PurePath.joinpath()
os.path.basename()	PurePath.name
os.path.dirname()	PurePath.parent
os.path.samefile()	Path.samefile()
os.path.splitext()	PurePath.stem and PurePath.suffix

Виноски

[1]

os.path.abspath() normalizes the resulting path, which may change its meaning in the presence of symlinks, while Path.absolute() does not.

[2]

PurePath.relative_to() вимагає, щоб self був підшляхом аргументу, але os.path.relpath() ні.