pathlab 模块

本文链接：https://www.jianshu.com/p/2ced43c205dd
作者: 西瓜甜

在 python3.4 之前，你是否这样判断一个完全路径是否是文件

os.path.isfile(os.path.join(os.path.expanduser('~'), 'shark.txt'))

在本教程中，您将了解如何使用文件路径 - 目录和文件的名称 - 在Python中。您将学习读取和写入文件，操作路径和底层文件系统的新方法，以及查看如何列出文件和迭代它们的一些示例。使用该pathlib模块，可以使用优雅，可读和Pythonic代码重写上述示例，如：

import pathlib
(pathlib.Path.home() / 'realpython.txt').is_file()

文件的路径成为了一个对象。

Python文件路径处理的问题

由于许多不同的原因，处理文件和与文件系统交互很重要。最简单的情况可能只涉及读取或写入文件，但有时候会有更复杂的任务。也许您需要列出给定类型的目录中的所有文件，查找给定文件的父目录，或创建一个尚不存在的唯一文件名。

传统上，Python使用常规文本字符串表示文件路径。在os.path标准库的支持下，这已经足够了，虽然有点麻烦（如前面提到的例子）。然而，由于路径不是字符串，重要的功能是遍布在标准库中的，包括像os，glob和shutil等库。以下示例仅需要三个import语句来将所有文本文件移动到存档目录：

import glob
import os
import shutil

for file_name in glob.glob('*.txt'):
    new_path = os.path.join('archive', file_name)
    shutil.move(file_name, new_path)

对于由字符串表示的路径，使用常规字符串方法是可能的，但通常是个坏主意。例如，您应该使用os.path.join（），它使用操作系统上正确的路径分隔符连接路径，而不是像常规字符串那样连接两个路径。回想一下，Windows使用\，而Mac和Linux使用/作为分隔符。这种差异可能导致难以发现的错误，例如我们在介绍中仅用于Windows路径的第一个示例。

pathlib模块是在Python 3.4（PEP 428）中引入的，用于解决这些挑战。它在一个地方收集必要的功能，并通过易于使用的Path对象上的方法和属性使其可用。

早期，其他软件包仍然使用字符串作为文件路径，但是从Python 3.6开始，整个标准库都支持pathlib模块，部分原因是添加了文件系统路径协议。

让我们看看pathlib在实践中的运作方式。

创建路径

你真正需要知道的是pathlib.Path类。 创建路径有几种不同的方法。 首先，有 .cwd()（当前工作目录）和 .home()（您的用户的主目录）等类方法：

In [10]: import pathlib

In [11]: pathlib.Path.cwd()
Out[11]: PosixPath('/Users/yanshunjun')

注意：在本教程中，我们将假设已导入pathlib，而不会如上所述显示的让你看到导入的 pathlib的语句 。 由于您将主要使用Path类，您也可以 from pathlib import Path, 之后使用 Path 调用他的其他方法。

也可以从其字符串表示中显式创建路径：

>>> pathlib.Path(r'C:\Users\yanshunjun\sharkyun\file.txt')
WindowsPath('C:/Users/yanshunjun/sharkyun/file.txt')
# 这是一个 Windows 风格的路径,可以在 Windows 平台上看到这个效果

处理Windows路径的一个小提示：在Windows上，路径分隔符是反斜杠，\。 但是，在许多上下文中，反斜杠也用作转义字符，以表示不可打印的字符。 为避免出现问题，请使用原始字符串文字来表示Windows路径。 这些是字符串文字，其前面有一个r。 在原始字符串文字中，\ 表示字面反斜杠：r'C:\Users'。

构造路径的第三种方法是使用特殊运算符/连接路径的各个部分。 正斜杠运算符独立于平台上的实际路径分隔符使用：

>>> pathlib.Path.home() / 'python' / 'scripts' / 'test.py'
PosixPath('/Users/yanshunjun/python/scripts/test.py')

只要至少有一个Path对象，/就可以连接多个路径或路径和字符串的混合（如上所述）。 如果您不喜欢特殊/符号，则可以使用.joinpath（）方法执行相同的操作：

>>> pathlib.Path.home().joinpath('python', 'scripts', 'test.py')
PosixPath('/Users/yanshunjun/python/scripts/test.py')

请注意，在前面的示例中，pathlib.Path由WindowsPath或PosixPath表示。 表示路径的实际对象取决于底层操作系统。 （即，WindowsPath示例在Windows上运行，而PosixPath示例已在Mac或Linux上运行。）有关详细信息，请参阅操作系统差异部分。有关详细信息，请参阅操作系统差异部分。

读写文件

传统上，在Python中读取或写入文件的方法是使用内置open()函数。这仍然是正确的，因为该open()函数可以直接使用Path对象。以下示例查找Markdown文件中的所有的标题，并打印它们：

path = pathlib.Path.cwd() / 'test.md'
with open(path, mode='r') as fid:
    headers = [line.strip() for line in fid if line.startswith('#')]
print('\n'.join(headers))

一个等价的替代方法是在Path对象上调用 .open()：

path = pathlib.Path.cwd() / 'test.md'
with path.open(mode='r') as fid:
    ...

实际上，Path.open() 在后台调用内置的 open() 。 您使用哪个选项主要是品味问题。

对于简单的文件读取和写入，pathlib 库中有几种便捷方法：

.read_text()：在文本模式下打开路径并将内容作为字符串返回。
.read_bytes()：以二进制/字节模式打开路径并将内容作为字节串返回。
.write_text()：打开路径并向其写入字符串数据。
.write_bytes()：以二进制/字节模式打开路径并向其写入数据。
这些方法中的每一个都处理文件的打开和关闭，使得它们使用起来很简单，例如：

>>> path = pathlib.Path.cwd() / 'test.md'
>>> path.read_text()
<the contents of the test.md-file>

路径也可以指定为简单文件名，在这种情况下，它们是相对于当前工作目录进行解释的。以下示例与前一个示例等效：

>>> pathlib.Path('test.md').read_text()
<the contents of the test.md-file>

该.resolve()方法将找会到完整路径。
下面，我们确认当前工作目录用于简单文件名：

>>> path = pathlib.Path('test.md')
>>> path.resolve()
PosixPath('/Users/yanshunjun/test.md')
>>> path.resolve().parent == pathlib.Path.cwd()
True

请注意，比较路径时，将比较它们的表示形式。 在上面的示例中，path.parent不等于pathlib.Path.cwd()，因为path.parent由 '.' 表示。 而pathlib.Path.cwd（）由'/Users/yanshunjun/test.md'表示。

挑选路径的组成部分

路径的不同部分可方便地作为属性使用。 基本的例子包括：

.name：没有任何目录的文件名
.parent：包含该文件的目录，如果path是目录，则为父目录
.stem：没有后缀的文件名
.suffix：文件扩展名
.anchor：目录前路径的一部分
以下是这些属性的实际应用：

>>> path = pathlib.Path('/Users/yanshunjun/test.md')
>>> path
PosixPath('/Users/yanshunjun/test.md')
>>> path.name
'test.md'
>>> path.stem
'test'
>>> path.suffix
'.md'
>>> path.parent
PosixPath('/Users/yanshunjun')
>>> path.parent.parent
PosixPath('/Users')
>>> path.anchor
'/'

请注意，.parent 返回一个新Path对象，而其他属性返回字符串。这意味着，例如，.parent 可以像上一个示例中那样链接，或者甚至与/ 创建全新路径相结合：

>>> path.parent.parent / ('new' + path.suffix)
PosixPath('/Users/new.md')

优秀的Pathlib Cheatsheet提供了这些以及其他属性和方法的直观表示。

移动和删除文件

通过pathlib，您还可以访问基本的文件系统级操作，如移动，更新甚至删除文件。 在大多数情况下，这些方法在信息或文件丢失之前不会发出警告或等待确认。 使用这些方法时要小心。

要移动文件，请使用.replace()。 请注意，如果目标已存在，.replace() 将覆盖它。 不幸的是，pathlib 没有明确支持安全移动文件。 为避免可能覆盖目标路径，最简单的方法是在替换之前测试目标是否存在：：

if not destination.exists():
    source.replace(destination)

然而，这确实为可能的竞争条件敞开了大门。 另一个进程可能会在执行if 语句和 .replace() 方法之间的目标路径上添加文件。 如果这是一个问题，更安全的方法是打开独占创建的目标路径并显式复制源数据：

with destination.open(mode='xb') as fid:
    fid.write(source.read_bytes())

如果目标已存在，上面的代码将引发FileExistsError。 从技术上讲，这会复制一个文件。 要执行移动，只需在复制完成后删除源（请参阅下文）。 确保没有引起异常。

重命名文件时，有用的方法可能是 .with_name() 和.with_suffix()。 它们都返回原始路径，但分别替换名称或后缀。

例如：

>>> path
PosixPath('/home/gahjelle/realpython/test001.txt')
>>> path.with_suffix('.py')
PosixPath('/home/gahjelle/realpython/test001.py')
>>> path.replace(path.with_suffix('.py'))

可以分别使用 .rmdir() 和.unlink() 删除目录和文件。（再次提示，小心！）

实用的例子 - 计算文件

列出许多文件有几种不同的方法。 最简单的是 .iterdir() 方法，它迭代给定目录中的所有文件。 以下示例将 .iterdir() 与collections.Counter类组合在一起，以计算当前目录中每种文件类型的文件数：

>>> import collections
>>> collections.Counter(p.suffix for p in pathlib.Path.cwd().iterdir())
Counter({'.md': 2, '.txt': 4, '.pdf': 2, '.py': 1})

可以使用方法.glob()和.rglob()（递归glob）创建更灵活的文件列表。例如，pathlib.Path.cwd().glob('*.txt') 返回.txt当前目录中带有后缀的所有文件。以下仅计算从以下p 开始的文件类型。

>>> import collections
>>> collections.Counter(p.suffix for p in pathlib.Path.cwd().glob('*.p*'))
Counter({'.pdf': 2, '.py': 1})

结论
自Python 3.4以来，pathlib已经可以在标准库中使用。使用pathlib，文件路径可以由适当的Path对象表示，而不是像以前一样由纯字符串表示。这些对象使代码处理文件路径：

更容易阅读，特别是因为/用于将路径连接在一起
更强大，直接在对象上提供大多数必要的方法和属性
在操作系统中更加一致，因为不同系统的特性被Path对象隐藏