from pathlib import Path
1. Path.
cwd
()返回一个新的表示当前目录的路径对象(和 os.getcwd()
返回的相同):
>>> Path.cwd()
PosixPath('/home/.../pathlib')
2. Path.
home
()返回一个表示当前用户家目录的新路径对象(和 os.path.expanduser()
构造含 ~
路径返回的相同):
>>> Path.home()
PosixPath('/home/...')
3.Path.
stat
()返回一个 os.stat_result
对象,其中包含有关此路径的信息,例如 os.stat()
。 结果会在每次调用此方法时重新搜索。
>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554
4.Path.
chmod
(mode)改变文件的模式和权限,和 os.chmod()
一样:
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
5.Path.
exists
()此路径是否指向一个已存在的文件或目录:
>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False
如果路径指向一个符号链接, exists()
返回此符号链接是否指向存在的文件或目录。
6.Path.expanduser
()返回展开了包含 ~
和 ~user
的构造,就和 os.path.expanduser()
一样:
>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')
7.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')]
注解
在一个较大的目录树中使用 "**
" 模式可能会消耗非常多的时间。
引发一个 审计事件 pathlib.Path.glob
附带参数 self
, pattern
。
8.Path.
group
()返回拥有此文件的用户组。如果文件的 GID 无法在系统数据库中找到,将抛出 KeyError
。
9.Path.
is_dir
()如果路径指向一个目录(或者一个指向目录的符号链接)则返回 True
,如果指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
10.Path.
is_file
()如果路径指向一个正常的文件(或者一个指向正常文件的符号链接)则返回 True
,如果指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
11.Path.
is_mount
()如果路径是一个 挂载点 path/..
是否处于一个和 path 不同的设备中,或者 file:path/.. 和 path 是否指向相同设备的相同 i-node —— 这能检测所有 Unix 以及 POSIX 变种上的挂载点。 Windows 上未实现。
3.7 新版功能.
12.Path.
is_symlink
()如果路径指向符号链接则返回 True
, 否则 False
。
如果路径不存在也返回 False
;其他错误(例如权限错误)被传播。
13.Path.
is_socket
()如果路径指向一个 Unix socket 文件(或者指向 Unix socket 文件的符号链接)则返回 True
,如果指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
14.Path.
is_fifo
()如果路径指向一个先进先出存储(或者指向先进先出存储的符号链接)则返回 True
,指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
15.Path.
is_block_device
()如果文件指向一个块设备(或者指向块设备的符号链接)则返回 True
,指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
16.Path.
is_char_device
()如果路径指向一个字符设备(或指向字符设备的符号链接)则返回 True
,指向其他类型的文件则返回 False
。
当路径不存在或者是一个破损的符号链接时也会返回 False
;其他错误(例如权限错误)被传播。
17.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')
子条目会以任意顺序生成,并且不包括特殊条目 '.'
和 '..'
。 如果有文件在迭代器创建之后在目录中被移除或添加,是否要包括该文件对应的路径对象并没有规定。
18.Path.
lchmod
(mode)就像 Path.chmod()
但是如果路径指向符号链接则是修改符号链接的模式,而不是修改符号链接的目标。
19.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
。
如果 exist_ok 为 true, 则 FileExistsError
异常将被忽略(和 POSIX mkdir -p
命令行为相同),但是只有在最后一个路径组件不是现存的非目录文件时才生效。
在 3.5 版更改: exist_ok 形参被加入。
20.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'
21.Path.
owner
()返回拥有此文件的用户名。如果文件的 UID 无法在系统数据库中找到,则抛出 KeyError
。
22.Path.
read_bytes
()以字节对象的形式返回路径指向的文件的二进制内容:
>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'
22.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()
一样的可选形参。
23.Path.
readlink
()返回符号链接所指向的路径(即 os.readlink()
的返回值):
>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')
24.Path.
rename
(target)将文件或目录重命名为给定的 target,并返回一个新的指向 target 的 Path 实例。 在 Unix 上,如果 target 存在且为一个文件,如果用户有足够权限,则它将被静默地替换。 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 对象的目录。
在 3.8 版更改: 添加了返回值,返回新的 Path 实例。
25.Path.
replace
(target)将文件名目录重命名为给定的 target,并返回一个新的指向 target 的 Path 实例。 如果 target 指向一个现有文件或目录,则它将被无条件地替换。
目标路径可能为绝对或相对路径。 相对路径将被解释为相对于当前工作目录,而 不是 相对于 Path 对象的目录。
在 3.8 版更改: 添加了返回值,返回新的 Path 实例。
26.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 新版功能: 加入*strict* 参数(3.6之前的版本相当于strict值为True)
27.Path.
rglob
(pattern)这就像调用 Path.glob`时在给定的相对 *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
。
28.Path.
rmdir
()移除此目录。此目录必须为空的。
29.Path.
samefile
(other_path)返回此目录是否指向与可能是字符串或者另一个路径对象的 other_path 相同的文件。语义类似于 os.path.samefile()
与 os.path.samestat()
。
如果两者都以同一原因无法访问,则抛出 OSError
。
>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True
3.5 新版功能.
30.Path.
symlink_to
(target, target_is_directory=False)将此路径创建为指向 target 的符号链接。在 Windows 下,如果链接的目标是一个目录则 target_is_directory 必须为 true (默认为 False
)。在 POSIX 下, 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
注解
参数的顺序(link, target) 和 os.symlink()
是相反的。
31.Path.
link_to
(target)创建硬链接 target 指向此路径。
警告
此函数不是将此路径设为指向 target 的硬链接,这与函数和参数名的本义不同。 参数顺序 (target, link) 与 Path.symlink_to()
相反,而与 os.link()
一致。
3.8 新版功能.
32.Path.
touch
(mode=0o666, exist_ok=True)将给定的路径创建为文件。如果给出了 mode 它将与当前进程的 umask
值合并以确定文件的模式和访问标志。如果文件已经存在,则当 exist_ok 为 true 则函数仍会成功(并且将它的修改事件更新为当前事件),否则抛出 FileExistsError
。
Path.
unlink
(missing_ok=False)
移除此文件或符号链接。如果路径指向目录,则用 Path.rmdir()
代替。
如果 missing_ok 为假值(默认),则如果路径不存在将会引发 FileNotFoundError
。
如果 missing_ok 为真值,则 FileNotFoundError
异常将被忽略(和 POSIX rm -f
命令的行为相同)。
在 3.8 版更改: 增加了 missing_ok 形参。
33.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 新版功能.
34.Path.
write_text
(data, encoding=None, errors=None)将文件以文本模式打开,写入 data 并关闭:
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
同名的现有文件会被覆盖。 可选形参的含义与open()的相同。
参考:https://docs.python.org/3/library/pathlib.html#methods 官网