Python os.path.relpath: 获得相对路径

Python 笔记

一、概述

Python中的os.path模块提供了许多用于处理文件路径的函数，而其中的os.path.relpath()用于获得相对路径。具体来说，os.path.relpath()用于返回从start到path的相对路径。

其中start是当前工作目录（或所给路径）与path的共同的父目录，如果start未给出，则使用当前工作目录作为起点。如果path和start相同，返回当前工作目录的名称（即'.'）。

二、函数签名

os.path.relpath(path[, start])

三、示例代码1

以下是一个使用os.path.relpath()函数的简单示例，目标路径为'/Users/Admin/test/test.py'，当前工作目录为'/Users/Admin'：

import os
path = '/Users/Admin/test/test.py'
print(os.path.relpath(path))  # 输出：'test/test.py'

在这个示例中，由于当前工作目录与目标路径的共同父目录为'/Users/Admin'，因此os.path.relpath()返回'test/test.py'。

四、示例代码2

下面的示例通过启动Python解释器来演示，其中脚本放在'd:/workspace/sample/'路径下，图像文件放在'd:/workspace/sample/images/'路径下：

python3 start.py

from os.path import relpath

if __name__ == '__main__':
    start_path = 'd:/workspace/sample/'
    target_path = 'd:/workspace/sample/images/test.jpg'
    relative_path = relpath(target_path, start_path)
    print(relative_path)

运行结果为：

images/test.jpg

这个示例中，start_path为'd:/workspace/sample/'，而target_path为'd:/workspace/sample/images/test.jpg'。因此，我们可以计算出相对路径为'images/test.jpg'。

五、示例代码3

下面的示例演示了如何使用相对路径来访问目标文件。

import os

# Get the current working directory
cwd = os.getcwd()

# Construct path name of input file
input_file = os.path.join(cwd, 'datafiles/input.txt')

# Construct path name of output file
output_dir = os.path.join(cwd, 'results')
output_file = os.path.join(output_dir, 'output.txt')

if not os.path.exists(output_dir):
    os.mkdir(output_dir)

with open(input_file, 'r') as fin, open(output_file, 'w') as fout:
    fout.write(fin.read())
    print('Finished writing the output file:', os.path.relpath(output_file))

在这个示例中，我们首先使用os.getcwd()函数获得当前工作目录，在输入和输出路径中使用os.path.join()函数构造路径名，使用os.path.exists()函数检查输出目录是否存在（如果不存在，使用os.mkdir()创建目录）。

最后，我们在文件处理完成时输出了完成消息，其中使用os.path.relpath()获得相对路径。

六、总结

os.path.relpath()是Python的一个非常有用的文件处理函数，用于计算任意两个路径之间的相对路径。这个函数将专门处理路径和文件名的分隔符，以及在处理不同操作系统的文件路径时的其他差异。

在使用os.path.relpath()函数时，需要知道起点路径和目标路径，通常，起点路径是当前工作目录，而目标路径则是需要进行处理的文件路径。