os.path:Python操作和处理文件路径

发布时间 2023-09-28 14:17:07作者: 阿瑞娜

前言

os.path是平台独立的文件名管理库,使用该库能够很方便来处理多个平台上的文件。即使程序不打算在平台之间移值,也应当使用os.path库来完成可靠的文件名解析。

本篇博文将详细介绍os.path库的用法。

解析路径的基本用法

os.path中的第一组函数可以用来将表示文件名的字符串解析为文件名的各个组成部分。这些函数并不要求路径真正存在,它们只是单纯的处理字符串而已。

常用的解析函数如下:

import os

paths = ["D:/document/csdn/opencv/20/10.png",
         "D:/document/csdn/opencv/20/",
         "D:/document/csdn/opencv/20",
         "d:" + os.sep + "10" + os.extsep + "txt",
         os.pardir + os.sep + "10" + os.extsep + "txt",
         os.curdir + os.sep + "10" + os.extsep + "txt", ]

for path in paths:
    print(path)
    print(os.path.split(path))

运行之后,效果如下:

os.sep:路径分隔符,字符串“/”或者“\”

os.extsep:文件名后缀的字符串“.”(点)

os.pardir:目录上一级,字符串“…”(双点)

os.curdir:当前目录,字符串“.”(点)

os.path.split:分割路径为两部分元组,第2个元素为路径最后的部分,可能是文件名,可能是空。第2个元素是前面的路径不包括文件名。

dirname()与basename()

当然,我们还可以不使用os.path.split进行分割,直接使用dirname()与basename()函数返回这两部分,具体代码如下:

import os

paths = ["D:/document/csdn/opencv/20/10.png",
         "D:/document/csdn/opencv/20/",
         "D:/document/csdn/opencv/20",
         "d:" + os.sep + "10" + os.extsep + "txt",
         os.pardir + os.sep + "10" + os.extsep + "txt",
         os.curdir + os.sep + "10" + os.extsep + "txt", ]

for path in paths:
    print(path)
    print(os.path.dirname(path))
    print(os.path.basename(path))

运行之后,效果如下:

dirname():返回文件路径最后一个分隔符前的路径

basename():返回文件路径最后一个分隔符后面的内容

splitext()与commonprefix()

splitext()函数与split()类似,不过它会根据扩展名分隔符而不是目录分隔符来分解路径。一般我们用该方法与前面的basename()结合获取文件名。具体代码如下:

import os

path = "D:/document/csdn/opencv/20/10.png"
filename = os.path.basename(path)
print(os.path.splitext(filename))

这里,我们会得到文件名以及后缀。运行效果如下:

当然,这是在存在文件名的情况下,如果只是单纯的路径,我们会得到空字符串。而如果直接跳过basename(),我们会得到前面的路径加文件名。

至于commonprefix()函数,它是用于判断一堆路径是否具有统一的公共前缀,如果有返回公共前缀。具体代码如下:

import os

paths = ["D:/document/csdn/opencv/20/10.png",
         "D:/document/csdn/opencv/20/",
         "D:/document/csdn/opencv/20",]

for path in paths:
    print(path)
print("公共前缀")
print(os.path.commonprefix(paths))

运行之后,效果如下:

相信大家测试的时候,发现了一个差不多的函数:commonpath()。该函数的才是我们最长使用的,因为commonprefix()有缺陷,我们先来看一段代码:

import os

paths = ["D:/document/csdn/opencv/20/10.png",
         "D:/document/csdn/opencv/2011111",
         "D:/document/csdn/opencv/20",]

for path in paths:
    print(path)
print("公共前缀")
print(os.path.commonpath(paths))
print(os.path.commonprefix(paths))

运行之后,效果如下:

可以看到,commonpath()函数返回的是共同的路径前缀,而commonprefix()虽然返回的路径存在,但不是共同的路径前缀,因为2011111是一个文件,commonprefix()将其裁成(20,1111)了。

建立路径

Join()

在实际的项目中,我们除了进行路径的分解以外,我们还可能会从其他字符串建立路径。要将多个路径组成一个值,可以使用join()。具体代码如下所示:

import os

paths = [['one', 'two', 'thress'], ['/', 'tow', 'one', 'three'], ['/one', '/two', '/three']]

for path in paths:
    print(path)
    print(os.path.join(*path))

运行之后,效果如下:

需要注意的是,如果链接的参数有“/”开头,那么前面所有的参数将会被丢弃,如/three一样。

expanduser()

os.path还提供了直接主目录名拼接方法:expanduser()。它会将字符串“~”开头的路径转换为主目录路径。具体代码如下:

import os

paths = ['~Data','~Temp','~Hello']

for path in paths:
    print(path)
    print(os.path.expanduser(path))

运行之后,效果如下:

expandvars()

expandvars()函数会扩展路径中所有出现的shell环境变量。例如:

import os

os.environ['LYJ']="liyuanjing"
print(os.path.expandvars('/user/$LYJ'))

运行之后,效果如下:

格式化路径

在实际的路径拼接中,如果我们的字符串本身不规则,比如使用了两个或多个“/”,亦或者是其他字符,造成路径格式本身错误。那么,我们就需要对路径进行格式化处理,具体的格式化函数为:normpath()。

示例如下:

import os

paths = ['Data/../yello','Temp//liyuanjing','Hello/./world']

for path in paths:
    print('{}    :     {}'.format(path,os.path.normpath(path)))

运行之后,效果如下:

需要注意的是,在字符串路径中,发现…/会直接删除前面所有路径字符串。

绝对路径转换

在程序中,除了有上面这些相对路径之外,还会有绝对路径。那么,如果将所有相对路径转换为绝对路径呢?

我们先来看一段代码:

import os

os.chdir('C:/Users')
paths = ['../', 'Temp/liyuanjing', './world']

for path in paths:
    print('{}    :     {}'.format(path, os.path.abspath(path)))

运行之后,效果如下:

文件属性获取

在实际的文件处理中,我们可能还会获取各种文件的属性用于参考。比如获取文件的创建时间,访问时间,修改时间以及文件的大小(字节)等。

示例如下:

import os

path=r"E:\Project\python\base_demo\英文文档1.txt"

print(path)
print('文件创建时间:{}'.format(os.path.getctime(path)))
print('文件访问时间:{}'.format(os.path.getatime(path)))
print('文件修改时间:{}'.format(os.path.getmtime(path)))
print('文件大小:{}字节'.format(os.path.getsize(path)))

运行之后,效果如下:

判断文件

在程序中进行文件操作时,往往我们会进行容错判断,用于获取文件路径指的是一个文件还是一个目录,另外哪怕文件路径正确,我们还要判断文件是否确实存在,这些都是必不可少的步骤。

os.path给我们提供了很多测试文件的条件的函数,如下表所示:

函数名 意义
exists(path) 判断 path 对应的文件是否存在,如果存在,返回 True;反之,返回 False
lexists(path) 判断路径是否存在,如果存在,则返回 True;反之,返回 False
isabs(path) 判断是否为绝对路径
isfile(path) 判断路径是否为文件
isdir(path) 判断路径是否为目录
islink(path) 判断路径是否为链接文件(类似 Windows 系统中的快捷方式)
ismount(path) 判断路径是否为挂载点
sameopenfile(fp1, fp2) 判断 fp1 和 fp2 是否指向同一文件
relpath(path[, start]) 从 start 开始计算相对路径。
samefile(path1, path2) 判断目录或文件是否相同。
samestat(stat1, stat2) 判断 stat1 和 stat2 是否指向同一个文件。

测试代码如下:

import os

path = r"E:\Project\python\base_demo\英文文档1.txt"

print(path)
print('文件是否存在:{}'.format(os.path.exists(path)))
print('路径是否存在:{}'.format(os.path.lexists(path)))
print('是否为绝对路径:{}'.format(os.path.isabs(path)))
print('路径是否为文件:{}'.format(os.path.isfile(path)))
print('路径是否为目录:{}'.format(os.path.isdir(path)))
print('路径是否为链接文件:{}'.format(os.path.islink(path)))
print('路径是否为挂载点:{}'.format(os.path.ismount(path)))
print('是否指向同一文件:{}'.format(os.path.sameopenfile(os.open(path, os.O_RDONLY), os.open(path, os.O_RDONLY))))
print('path的真实路径:{}'.format(os.path.realpath(r'python\base_demo\英文文档1.txt')))
print('从 start 开始计算相对路径:{}'.format(os.path.relpath(path, 'python')))
print('判断目录或文件是否相同:{}'.format(os.path.samefile(path, path)))

运行之后,效果如下: