os.path.relpath详解

一、简介

Python的os.path模块提供了很多用于处理文件路径的函数。其中，os.path.relpath()函数用于返回一个相对路径，该路径从start到path。这个函数主要在比较或者显示文件路径时很有用，比如两个相对路径之间的距离或者更改工作目录的相对距离。

二、语法

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

参数说明：

• path：要返回相对路径的路径
• start：表示从哪个路径开始计算，默认是当前工作目录

注意：在Windows系统中应该小心处理相对路径，因为在Windows系统中相对路径和Unix系统中的相对路径是不同的。

三、返回值

返回一个相对路径

四、示例代码

import os

# 获取当前工作目录
print(os.getcwd())

# 返回从相对路径 A 到 B 的相对路径
path = os.path.relpath("B", "A")
print(path)

# 返回从相对路径 ./A/B 到 ./A/C 的相对路径
path = os.path.relpath("C", "A/B")
print(path)

# 返回从相对路径 ../A/B 到 ./C 的相对路径
path = os.path.relpath("C", "../A/B")
print(path)

# 返回从相对路径 ./A/B/C 到 ./E 的相对路径
path = os.path.relpath("E", "A/B/C")
print(path)

五、应用场景

1、比较两个相对路径之间的距离

可以使用os.path.relpath()函数来计算两个相对路径之间的距离。例如，如果我们有一个文件夹的列表，我们可以使用os.path.relpath()函数来比较两个文件夹之间的距离。

import os

# 两个文件路径
path1 = "/home/myfolder/file1.txt"
path2 = "/home/otherfolder/file2.txt"

# 获取从path1到path2的相对路径
rel_path = os.path.relpath(path2, os.path.dirname(path1))

print(rel_path)

2、在改变工作目录时使用相对路径

如果我们需要在 Python 程序中更改工作目录，可以使用 os.chdir() 函数。但是，如果我们像更改工作目录一样使用文件路径，可能会遇到一些问题，因为在不同的操作系统上，文件路径的格式不同。此外，尽管在程序中使用绝对路径是安全的，但更改工作目录时使用相对路径可以使程序更加通用。

import os

# 获取当前工作目录
current_dir = os.getcwd()
print("当前工作目录: ", current_dir)

# 切换到上级路径
os.chdir("..")

# 更改相对路径，进入上级文件夹的子文件夹
os.chdir(os.path.join(current_dir, "example_folder"))

# 获取更改后的工作目录
new_dir = os.getcwd()
print("更改后的工作目录: ", new_dir)

3、生成文件的相对路径

在处理多个文件时，如果我们需要将文件移动到另一个文件夹，使用os.path.relpath()可以轻松地计算出相对路径。

import os

# 文件路径
file_path = "/home/myfolder/example.txt"

# 目标文件夹路径
destination_folder = "/home/otherfolder"

# 获取相对路径
rel_path = os.path.relpath(file_path, destination_folder)

print(rel_path)

六、小结

在Python中，os.path模块可以用来处理文件路径。os.path.relpath()函数可以返回从start到path的相对路径。在比较或者显示文件路径时，这个函数是很有用的。