11.1. 路径库 — 面向对象的文件系统路径

3.4 版中的新功能。

源代码： :source:`Lib/pathlib.py`

该模块提供表示文件系统路径的类，其语义适用于不同的操作系统。路径类分为纯路径和具体路径，它们提供没有 I/O 的纯计算操作，和具体路径，它们继承自纯路径但也提供 I/O 操作。

class=align-center|../_images/pathlib-inheritance.png 如果您以前从未使用过这个模块或者只是不确定哪个类适合您的任务，Path 很可能是您所需要的。它为代码运行的平台实例化具体路径。

纯路径在某些特殊情况下很有用；例如：

如果您想在 Unix 机器上操作 Windows 路径（反之亦然）。在 Unix 上运行时不能实例化 WindowsPath，但可以实例化 PureWindowsPath。
您想确保您的代码只操作路径而不实际访问操作系统。在这种情况下，实例化其中一个纯类可能会很有用，因为它们根本没有任何操作系统访问操作。

也可以看看

PEP 428：pathlib 模块——面向对象的文件系统路径。

也可以看看

对于字符串的低级路径操作，您还可以使用 os.path 模块。

11.1.1. 基本使用

导入主类：

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

11.1.2. 纯路径

纯路径对象提供不实际访问文件系统的路径处理操作。可以通过三种方式访问这些类，我们也称之为 flavours：

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')，如果 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 类似。

无论您在哪个系统上运行，您都可以实例化所有这些类，因为它们不提供任何执行系统调用的操作。

11.1.2.1. 一般属性

路径是不可变的和可散列的。相同风味的路径具有可比性和可排序性。这些属性尊重风味的 case-folding 语义：

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

11.1.2.2. 运营商

斜线运算符有助于创建子路径，类似于 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 形式是文件系统路径的规范表示。

11.1.2.3. 访问单个部件

要访问路径的各个“部分”（组件），请使用以下属性：

PurePath.parts

一个元组，可以访问路径的各种组件：

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

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

（注意驱动器和本地根是如何重新组合成一个部分的）

11.1.2.4. 方法和属性

纯路径提供以下方法和属性：

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

提供对路径逻辑祖先的访问的不可变序列：

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

您不能越过锚点或空路径：

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

将此路径与提供的 glob 样式模式匹配。匹配成功返回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

与其他方法一样，观察到区分大小写：

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

返回更改了名称的新路径。如果原始路径没有名称，则会引发 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)

返回一个改变了后缀的新路径。如果原始路径没有后缀，则会附加新的后缀。如果后缀为空字符串，则删除原始后缀：

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

返回有关此路径的信息（类似于 os.stat()）。每次调用此方法时都会查找结果。

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

在此路径表示的目录中对给定的 pattern 进行全局搜索，生成所有匹配的文件（任何类型）：

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