python3從零學習-5.4.1、面向對象的文件系統路徑pathlib

源代碼 Lib/pathlib.py

該模塊提供表示文件系統路徑的類，其語義適用於不同的操作系統。路徑類被分爲提供純計算操作而沒有 I/O 的純路徑，以及從純路徑繼承而來但提供 I/O 操作的具體路徑。

如果你以前從未使用過此模塊或者不確定在項目中使用哪一個類是正確的，則 Path 總是你需要的。它在運行代碼的平臺上實例化爲一個具體路徑。

在一些用例中純路徑很有用，例如：

1.如果你想要在 Unix 設備上操作 Windows 路徑（或者相反）。你不應在 Unix 上實例化一個 WindowsPath，但是你可以實例化 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')

每一個 pathsegments 的元素可能是一個代表路徑片段的字符串，一個返回字符串的實現了 os.PathLike 接口的對象，或者另一個路徑對象:

>>>

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

PurePosixPath('foo/some/path/bar')

>>> PurePath(Path('foo'), Path('bar'))

PurePosixPath('foo/bar')

當 pathsegments 爲空的時候，假定爲當前目錄:

>>>

>>> PurePath()

PurePosixPath('.')

當給出一些絕對路徑，最後一位將被當作錨（模仿 os.path.join() 的行爲）:

>>>

>>> PurePath('/etc', '/usr', 'lib64')

PurePosixPath('/usr/lib64')

>>> PureWindowsPath('c:/Windows', 'd:bar')

PureWindowsPath('d:bar')

但是，在 Windows 路徑中，改變本地根目錄並不會丟棄之前盤符的設置:

>>>

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

PureWindowsPath('c:/Program Files')

假斜線和單獨的點都會被消除，但是雙點（‘..’）不會，以防改變符號鏈接的含義。

>>>

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

PurePosixPath('foo/bar')

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

PurePosixPath('foo/bar')

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

PurePosixPath('foo/../bar')

（如果你想讓 PurePosixPath('foo/../bar') 等同於 PurePosixPath('bar')，那麼 you are too young, too simple, sometimes naive! 如果 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 文件系統路徑:

>>>

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

PureWindowsPath('c:/Program Files')

pathsegments 參數的指定和 PurePath 相同。

無論你正運行什麼系統，你都可以實例化這些類，因爲它們提供的操作不做任何系統調用。

通用性質

路徑是不可變並可哈希的。相同風格的路徑可以排序與比較。這些性質尊重對應風格的大小寫轉換語義:

>>>

>>> 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'

運算符

斜槓 / 操作符有助於創建子路徑，就像 os.path.join() 一樣:

>>>

>>> p = PurePath('/etc')

>>> p

PurePosixPath('/etc')

>>> p / 'init.d' / 'apache2'

PurePosixPath('/etc/init.d/apache2')

>>> q = PurePath('bin')

>>> '/usr' / q

PurePosixPath('/usr/bin')

文件對象可用於任何接受 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 將原始文件系統路徑作爲字節對象給出，就像被 os.fsencode() 編碼一樣:

>>>

>>> bytes(p)

b'/etc'

註解只推薦在 Unix 下調用 bytes。在 Windows， unicode 形式是文件系統路徑的規範表示法。

訪問個別部分

爲了訪問路徑獨立的部分（組件），使用以下特徵屬性：

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

'\\'

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

An immutable sequence providing access to the logical ancestors of the path:

>>>

>>> 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:/')

PurePath.parent

此路徑的邏輯父路徑:

>>>

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

>>> p.parent

PurePosixPath('/a/b/c')

你不能超過一個 anchor 或空路徑:

>>>

>>> p = PurePosixPath('/')

>>> p.parent

PurePosixPath('/')

>>> p = PurePosixPath('.')

>>> p.parent

PurePosixPath('.')

註解這是一個單純的詞法操作，因此有以下行爲:

>>>

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

>>> p.parent

PurePosixPath('foo')

如果你想要向上移動任意文件系統路徑，推薦先使用 Path.resolve() 來解析符號鏈接以及消除 ".." 組件。

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()

將路徑表示爲 file URL。如果並非絕對路徑，拋出 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_reserved()

在 PureWindowsPath，如果路徑是被 Windows 保留的則返回 True，否則 False。在 PurePosixPath，總是返回 False。

PureWindowsPath('nul').is_reserved()

True

PurePosixPath('nul').is_reserved()

False

當保留路徑上的文件系統被調用，則可能出現玄學失敗或者意料之外的效應。

PurePath.joinpath(*other)

調用此方法等同於將每個 other 參數中的項目連接在一起:

>>>

>>> 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)

將此路徑與提供的通配符風格的模式匹配。如果匹配成功則返回 True，否則返回 False。

如果 pattern 是相對的，則路徑可以是相對路徑或絕對路徑，並且匹配是從右側完成的：

>>>

>>> 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

如果 pattern 是絕對的，則路徑必須是絕對的，並且路徑必須完全匹配:

>>>

>>> PurePath('/a.py').match('/*.py')

True

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

False

As with other methods, case-sensitivity is observed:

>>>

>>> PureWindowsPath('b.py').match('*.PY')

True

PurePath.relative_to(*other)

計算此路徑相對 other 表示路徑的版本。如果不可計算，則拋出 ValueError:

>>>

>>> 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' does not start with '/usr'

PurePath.with_name(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_suffix(suffix)

返回一個新的路徑並修改 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')

11.1.3. 具體路徑

具體路徑是純路徑的子類。除了後者提供的操作之外，它們還提供了對路徑對象進行系統調用的方法。有三種方法可以實例化具體路徑:

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

11.1.3.1. 方法

除純路徑方法外，具體路徑還提供以下方法。如果系統調用失敗（例如因爲路徑不存在），其中許多方法都會引發 OSError：

classmethod Path.cwd()

返回一個新的表示當前目錄的路徑對象（和 os.getcwd() 返回的相同）:

>>>

>>> Path.cwd()

PosixPath('/home/antoine/pathlib')

classmethod Path.home()

返回一個表示當前用戶家目錄的新路徑對象（和 os.path.expanduser() 構造含 ~ 路徑返回的相同）:

>>>

>>> Path.home()

PosixPath('/home/antoine')

3.5 新版功能.

Path.stat()

Return information about this path (similarly to os.stat()). The result is looked up at each call to this method.

p = Path('setup.py')

p.stat().st_size

956

p.stat().st_mtime

1327883547.852554

Path.chmod(mode)

改變文件的模式和權限，和 os.chmod() 一樣:

>>>

>>> p = Path('setup.py')

>>> p.stat().st_mode

33277

>>> p.chmod(0o444)

>>> p.stat().st_mode

33060

Path.exists()

此路徑是否指向一個已存在的文件或目錄:

>>>

>>> Path('.').exists()

True

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

True

>>> Path('/etc').exists()

True

>>> Path('nonexistentfile').exists()

False

註解如果路徑指向一個符號鏈接， exists() 返回此符號鏈接是否指向存在的文件或目錄。

Path.expanduser()

返回展開了包含 ~ 和 ~user 的構造，就和 os.path.expanduser() 一樣:

>>>

>>> p = PosixPath('~/films/Monty Python')

>>> p.expanduser()

PosixPath('/home/eric/films/Monty Python')

3.5 新版功能.

Path.glob(pattern)

Glob the given pattern in the directory represented by this path, yielding all matching files (of any kind):

>>>

>>> sorted(Path('.').glob('*.py'))

[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]

>>> sorted(Path('.').glob('*/*.py'))

[PosixPath('docs/conf.py')]

“**” 模式表示 “此目錄以及所有子目錄，遞歸”。換句話說，它啓用遞歸通配:

>>>

>>> sorted(Path('.').glob('**/*.py'))

[PosixPath('build/lib/pathlib.py'),

PosixPath('docs/conf.py'),

PosixPath('pathlib.py'),

PosixPath('setup.py'),

PosixPath('test_pathlib.py')]

註解在一個較大的目錄樹中使用 “**” 模式可能會消耗非常多的時間。

Path.group()

返回擁有此文件的用戶組。如果文件的 GID 無法在系統數據庫中找到，將拋出 KeyError 。

Path.is_dir()

如果路徑指向一個目錄（或者一個指向目錄的符號鏈接）則返回 True，如果指向其他類型的文件則返回 False。