os.path
--- 常用路径操作
源代码: Lib/posixpath.py (用于 POSIX) 和 Lib/ntpath.py (用于 Windows)。
此模块实现了一些有用的路径名称相关函数。 要读取或写入文件请参见 open()
,对于访问文件系统请参阅 os
模块。 传给 path 形参的可以是字符串、字节串或者任何实现了 os.PathLike
协议的对象。
Unlike a Unix shell, Python does not do any automatic path expansions. Functions such as expanduser()
and expandvars()
can be invoked explicitly when an application desires shell-like path expansion. (See also the glob
module.)
参见
pathlib
模块提供高级路径对象。
备注
所有这些函数都仅接受字节或字符串对象作为其参数。如果返回路径或文件名,则结果是相同类型的对象。
备注
由于不同的操作系统具有不同的路径名称约定,因此标准库中有此模块的几个版本。os.path
模块始终是适合 Python 运行的操作系统的路径模块,因此可用于本地路径。但是,如果操作的路径 总是 以一种不同的格式显示,那么也可以分别导入和使用各个模块。它们都具有相同的接口:
-
posixpath
用于Unix 样式的路径 -
ntpath
用于 Windows 路径
在 3.8 版更改: exists()
、lexists()
、isdir()
、isfile()
、islink()
和 ismount()
现在遇到系统层面上不可表示的字符或字节的路径时,会返回 False
,而不是抛出异常。
- os.path.abspath(path)
-
返回路径 path 的绝对路径(标准化的)。在大多数平台上,这等同于用
normpath(join(os.getcwd(), path))
的方式调用normpath()
函数。在 3.6 版更改: 接受一个 path-like object。
- os.path.basename(path)
-
返回路径 path 的基本名称。这是将 path 传入函数
split()
之后,返回的一对值中的第二个元素。请注意,此函数的结果与Unix basename 程序不同。basename 在'/foo/bar/'
上返回'bar'
,而basename()
函数返回一个空字符串 (''
)。在 3.6 版更改: 接受一个 path-like object。
- os.path.commonpath(paths)
-
接受包含多个路径的序列 paths,返回 paths 的最长公共子路径。如果 paths 同时包含绝对路径和相对路径,或 paths 在不同的驱动器上,或 paths 为空,则抛出
ValueError
异常。与commonprefix()
不同,本方法返回有效路径。可用性: Unix, Windows。
3.5 新版功能.
在 3.6 版更改: 接受一个 类路径对象 序列。
- os.path.commonprefix(list)
-
接受包含多个路径的 列表,返回所有路径的最长公共前缀(逐字符比较)。如果 列表 为空,则返回空字符串 (
''
)。备注
此函数是逐字符比较,因此可能返回无效路径。要获取有效路径,参见
>>>commonpath()
。>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib']) '/usr/l' >>> os.path.commonpath(['/usr/lib', '/usr/local/lib']) '/usr'
在 3.6 版更改: 接受一个 path-like object。
- os.path.dirname(path)
-
返回路径 path 的目录名称。这是将 path 传入函数
split()
之后,返回的一对值中的第一个元素。在 3.6 版更改: 接受一个 path-like object。
- os.path.exists(path)
-
如果 path 指向一个已存在的路径或已打开的文件描述符,返回
True
。对于失效的符号链接,返回False
。在某些平台上,如果使用os.stat()
查询到目标文件没有执行权限,即使 path 确实存在,本函数也可能返回False
。在 3.3 版更改: path 现在可以是一个整数:如果该整数是一个已打开的文件描述符,返回
True
,否则返回False
。在 3.6 版更改: 接受一个 path-like object。
- os.path.lexists(path)
-
如果 path 指向一个已存在的路径,返回
True
。对于失效的符号链接,也返回True
。在缺失os.lstat()
的平台上等同于exists()
。在 3.6 版更改: 接受一个 path-like object。
- os.path.expanduser(path)
-
在 Unix 和 Windows 上,将参数中开头部分的
~
或~user
替换为当前 用户 的家目录并返回。在 Unix 上,开头的
~
会被环境变量HOME
代替,如果变量未设置,则通过内置模块pwd
在 password 目录中查找当前用户的主目录。以~user
开头则直接在 password 目录中查找。在 Windows 上,如果
USERPROFILE
已设置将会被使用,否则HOMEPATH
和HOMEDRIVE
将被组合起来使用。 初始的~user
会通过检查当前用户的家目录中匹配USERNAME
的最后一部分目录名并执行替换来处理。如果展开路径失败,或者路径不是以波浪号开头,则路径将保持不变。
在 3.6 版更改: 接受一个 path-like object。
在 3.8 版更改: Windows 不再使用
HOME
。
- os.path.expandvars(path)
-
输入带有环境变量的路径作为参数,返回展开变量以后的路径。
$name
或${name}
形式的子字符串被环境变量 name 的值替换。格式错误的变量名称和对不存在变量的引用保持不变。在 Windows 上,除了
$name
和${name}
外,还可以展开%name%
。在 3.6 版更改: 接受一个 path-like object。
- os.path.getmtime(path)
-
返回 path 的最后修改时间。返回值是一个浮点数,为纪元秒数(参见
time
模块)。如果该文件不存在或不可访问,则抛出OSError
异常。在 3.6 版更改: 接受一个 path-like object。
- os.path.getctime(path)
-
返回 path 在系统中的 ctime,在有些系统(比如 Unix)上,它是元数据的最后修改时间,其他系统(比如 Windows)上,它是 path 的创建时间。返回值是一个数,为纪元秒数(参见
time
模块)。如果该文件不存在或不可访问,则抛出OSError
异常。在 3.6 版更改: 接受一个 path-like object。
- os.path.getsize(path)
-
返回 path 的大小,以字节为单位。如果该文件不存在或不可访问,则抛出
OSError
异常。在 3.6 版更改: 接受一个 path-like object。
- os.path.isabs(path)
-
如果 path 是一个绝对路径,则返回
True
。在 Unix 上,它就是以斜杠开头,而在 Windows 上,它可以是去掉驱动器号后以斜杠(或反斜杠)开头。在 3.6 版更改: 接受一个 path-like object。
- os.path.isfile(path)
-
如果 path 是
现有的
常规文件,则返回True
。本方法会跟踪符号链接,因此,对于同一路径,islink()
和isfile()
都可能为True
。在 3.6 版更改: 接受一个 path-like object。
- os.path.isdir(path)
-
如果 path 是
现有的
目录,则返回True
。本方法会跟踪符号链接,因此,对于同一路径,islink()
和isdir()
都可能为True
。在 3.6 版更改: 接受一个 path-like object。
- os.path.islink(path)
-
如果 path 指向的
现有
目录条目是一个符号链接,则返回True
。如果 Python 运行时不支持符号链接,则总是返回False
。在 3.6 版更改: 接受一个 path-like object。
- os.path.ismount(path)
-
如果路径 path 是 挂载点 (文件系统中挂载其他文件系统的点),则返回
True
。在 POSIX 上,该函数检查 path 的父目录path/..
是否在与 path 不同的设备上,或者path/..
和 path 是否指向同一设备上的同一 inode(这一检测挂载点的方法适用于所有 Unix 和 POSIX 变体)。本方法不能可靠地检测同一文件系统上的绑定挂载 (bind mount)。在 Windows 上,盘符和共享 UNC 始终是挂载点,对于任何其他路径,将调用GetVolumePathName
来查看它是否与输入的路径不同。3.4 新版功能: 支持在 Windows 上检测非根挂载点。
在 3.6 版更改: 接受一个 path-like object。
- os.path.join(path, *paths)
-
Join one or more path segments intelligently. The return value is the concatenation of path and all members of *paths, with exactly one directory separator following each non-empty part, except the last. That is, the result will only end in a separator if the last part is either empty or ends in a separator. If a segment is an absolute path (which on Windows requires both a drive and a root), then all previous segments are ignored and joining continues from the absolute path segment.
On Windows, the drive is not reset when a rooted path segment (e.g.,
r'\foo'
) is encountered. If a segment is on a different drive or is an absolute path, all previous segments are ignored and the drive is reset. Note that since there is a current directory for each drive,os.path.join("c:", "foo")
represents a path relative to the current directory on driveC:
(c:foo
), notc:\foo
.在 3.6 版更改: 接受一个 类路径对象 用于 path 和 paths 。
- os.path.normcase(path)
-
规范路径的大小写。在 Windows 上,将路径中的所有字符都转换为小写,并将正斜杠转换为反斜杠。在其他操作系统上返回原路径。
在 3.6 版更改: 接受一个 path-like object。
- os.path.normpath(path)
-
通过折叠多余的分隔符和对上级目录的引用来标准化路径名,所以
A//B
、A/B/
、A/./B
和A/foo/../B
都会转换成A/B
。这个字符串操作可能会改变带有符号链接的路径的含义。在 Windows 上,本方法将正斜杠转换为反斜杠。要规范大小写,请使用normcase()
。备注
On POSIX systems, in accordance with IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution, if a pathname begins with exactly two slashes, the first component following the leading characters may be interpreted in an implementation-defined manner, although more than two leading characters shall be treated as a single character.
在 3.6 版更改: 接受一个 path-like object。
- os.path.realpath(path, *, strict=False)
-
返回指定文件的规范路径,消除路径中存在的任何符号链接(如果操作系统支持)。
如果一个路径不存在或是遇到了符号链接循环,并且 strict 为
True
,则会引发OSError
。 如果 strict 为False
,则会尽可能地解析路径并添加结果而不检查路径是否存在。备注
这个函数会模拟操作系统生成规范路径的过程,Windows 与 UNIX 的这个过程在处理链接和后续路径组成部分的交互方式上有所差异。
操作系统 API 会根据需要来规范化路径,因此通常不需要调用此函数。
在 3.6 版更改: 接受一个 path-like object。
在 3.8 版更改: 在 Windows 上现在可以正确解析符号链接和交接点 (junction point)。
在 3.10 版更改: 增加了 strict 形参。
- os.path.relpath(path, start=os.curdir)
-
返回从当前目录或可选的 start 目录至 path 的相对文件路径。 这只是一个路径计算:不会访问文件系统来确认 path 或 start 是否存在或其性质。 在 Windows 上,当 path 和 start 位于不同驱动器时将引发
ValueError
。start defaults to
os.curdir
.可用性: Unix, Windows。
在 3.6 版更改: 接受一个 path-like object。
- os.path.samefile(path1, path2)
-
如果两个路径都指向相同的文件或目录,则返回
True
。这由设备号和 inode 号确定,在任一路径上调用os.stat()
失败则抛出异常。可用性: Unix, Windows。
在 3.2 版更改: 添加了对 Windows 的支持。
在 3.4 版更改: Windows现在使用与其他所有平台相同的实现。
在 3.6 版更改: 接受一个 path-like object。
- os.path.sameopenfile(fp1, fp2)
-
如果文件描述符 fp1 和 fp2 指向相同文件,则返回
True
。可用性: Unix, Windows。
在 3.2 版更改: 添加了对 Windows 的支持。
在 3.6 版更改: 接受一个 path-like object。
- os.path.samestat(stat1, stat2)
-
如果 stat 元组 stat1 和 stat2 指向相同文件,则返回
True
。这些 stat 元组可能是由os.fstat()
、os.lstat()
或os.stat()
返回的。本函数实现了samefile()
和sameopenfile()
底层所使用的比较过程。可用性: Unix, Windows。
在 3.4 版更改: 添加了对 Windows 的支持。
在 3.6 版更改: 接受一个 path-like object。
- os.path.split(path)
-
将路径 path 拆分为一对,即
(head, tail)
,其中,tail 是路径的最后一部分,而 head 里是除最后部分外的所有内容。tail 部分不会包含斜杠,如果 path 以斜杠结尾,则 tail 将为空。如果 path 中没有斜杠,head 将为空。如果 path 为空,则 head 和 tail 均为空。head 末尾的斜杠会被去掉,除非它是根目录(即它仅包含一个或多个斜杠)。在所有情况下,join(head, tail)
指向的位置都与 path 相同(但字符串可能不同)。另请参见函数dirname()
和basename()
。在 3.6 版更改: 接受一个 path-like object。
- os.path.splitdrive(path)
-
将路径 path 拆分为一对,即
(drive, tail)
,其中 drive 是挂载点或空字符串。在没有驱动器概念的系统上,drive 将始终为空字符串。在所有情况下,drive + tail
都与 path 相同。在 Windows 上,本方法将路径拆分为驱动器/UNC 根节点和相对路径。
如果路径 path 包含盘符,则 drive 将包含冒号之前的所有内容包括冒号本身:
>>>>>> splitdrive("c:/dir") ("c:", "/dir")
如果路径 path 包含 UNC 路径,则 drive 将包含主机名和 share,直至第四个分隔符但不包括该分隔符:
>>>>>> splitdrive("//host/computer/dir") ("//host/computer", "/dir")
在 3.6 版更改: 接受一个 path-like object。
- os.path.splitext(path)
-
将路径名称 path 拆分为
(root, ext)
对使得root + ext == path
,并且扩展名 ext 为空或以句点打头并最多只包含一个句点。如果路径 path 不包含扩展名,则 ext 将为
>>>''
:>>> splitext('bar') ('bar', '')
如果路径 path 包含扩展名,则 ext 将被设为该扩展名,包括打头的句点。 请注意在其之前的句点将被忽略:
>>>>>> splitext('foo.bar.exe') ('foo.bar', '.exe') >>> splitext('/foo/bar.exe') ('/foo/bar', '.exe')
path 中最后一部分如果以点号开头则会被视为 root 的一部分:
>>>>>> splitext('.cshrc') ('.cshrc', '') >>> splitext('/foo/....jpg') ('/foo/....jpg', '')
在 3.6 版更改: 接受一个 path-like object。
- os.path.supports_unicode_filenames
-
如果(在文件系统限制下)允许将任意 Unicode 字符串用作文件名,则为
True
。