关键词:相对路径 | 绝对路径 | os.path | __file__ | 当前工作目录 | os.getcwd
本文研究了访问上层目录中文件的三种方法,并分析了各自的优缺点以及使用的函数特性。比较的结论是方法2(基于os.path)为三者中最佳。更新:最近发现python内还有一个pathlib似乎更好用,之后值得一试。另外如果类似需求大量存在,可以学习使用__init__.py
将工程打包。
问题情景
需求:在a.py
文件中访问上级目录中的文件b.txt
,并且保证c.py
也能正常工作。
目录结构:
top
├── bottom
│ ├── a.py
│ └── c.py
└── b.txt
b.txt:
123
c.py:
import a
方法1:相对路径
a.py:
# 方法1
path = '../b.txt'
print('path:', path)
with open(path) as f:
print(f.read())
测试:
- 在bottom目录内
$ python a.py
path: ../b.txt
123
$ python c.py
path: ../b.txt
123
a.py
和c.py
均正常打印出b.txt的内容,说明文件访问成功。
- 在top目录内
$ python bottom/a.py
path: ../b.txt
Traceback (most recent call last):
File "bottom/a.py", line 13, in <module>
with open(path) as f:
FileNotFoundError: [Errno 2] No such file or directory: '../b.txt'
$ python bottom/c.py
path: ../b.txt
Traceback (most recent call last):
File "bottom/c.py", line 1, in <module>
import a
File "/home/simonzhao/top/bottom/a.py", line 13, in <module>
with open(path) as f:
FileNotFoundError: [Errno 2] No such file or directory: '../b.txt'
a.py
和c.py
均报错找不到文件,因为此时相对路径'../b.txt'指向的并不是bottom
的上层top
,而是top
目录的上层simonzhao
,其中不存在b.txt
文件。
对于一个实际的python工程而言,同一文件可能有多种运行场景,比如测试场景和生产场景。测试场景,如使用if __name__ == '__main__'
再运行单个py文件,与生产场景下整个工程运行时调用这个py文件,程序的起始点(入口路径或者说是当前工作目录)很可能是不同的,而单纯的相对路径依赖于当前工作目录路径,因此出现单个测试没问题,生产环境中却报错的情况。
方法评价:
- 优点:简单易用
- 缺点:由于相对路径依赖于入口路径,该方法在一些情况下会报错
方法2:绝对路径
先找到a.py
所在目录的绝对路径,然后生成b.py
的绝对路径。
a.py:
from os.path import dirname, abspath
# 方法2
path = dirname(dirname(abspath(__file__))) + '/b.txt'
print('path:', path)
with open(path) as f:
print(f.read())
测试:
- 在bottom目录内
$ python a.py
path: /home/simonzhao/top/b.txt
123
$ python c.py
path: /home/simonzhao/top/b.txt
123
- 在top目录内
$ python bottom/a.py
path: /home/simonzhao/top/b.txt
123
$ python bottom/c.py
path: /home/simonzhao/top/b.txt
123
可以看到四种情况下生成的path均为b的绝对路径,且均正常输出123。
方法评价:
- 优点:由于使用绝对路径定位文件,一般情况下可以保证程序测试/运行时的正确性,适于实际工程
- 缺点:写法复杂
解释一下方法2用到的东西:
-
__file__
: 模块被load时,其文件路径名(the pathname of the file from which the module was loaded, if it was loaded from a file) -
os.path.abspath(path)
: 返回path
所在的目录绝对路径 -
os.path.dirname(path)
: 单纯使用split()
方法,以分隔符为依据,将路径切为dirname
和basename
两部分,返回dirname
部分。可以想到,该方法可以嵌套使用,返回更上层目录的路径;此外,如果path
里不包含分隔符,如test.py
,该方法将返回空字符串''。
方法3:绝对路径+相对路径
a.py:
from os.path import dirname, abspath
# 方法3
path = dirname(abspath(__file__)) + '/../b.txt'
print('path:', path)
with open(path) as f:
print(f.read())
测试:
- 在bottom目录内
$ python a.py
path: /home/simonzhao/top/bottom/../b.txt
123
$ python c.py
path: /home/simonzhao/top/bottom/../b.txt
123
- 在top目录内
$ python bottom/a.py
path: /home/simonzhao/top/bottom/../b.txt
123
$ python bottom/c.py
path: /home/simonzhao/top/bottom/../b.txt
123
可以看到四种情况下生成的path相同,且均正常输出123。方法3可看作2的变种,少使用了一层dirname,而在后面部分增加了'/..',因为路径字符串的最前端已确定为绝对路径,所以接在其后的'..'虽然是相对路径但不依赖于当前工作目录路径,指向了该绝对路径的相对上一层top
,所以能达成和方法2一样的效果。
方法评价:
- 优点:同方法2
- 缺点:同方法2,且生成的路径不如2直白
更多实验
为加深理解,我们来进行更多实验。加入实验文件test.py
后工程的目录结构:
top
├── bottom
│ ├── a.py
│ ├── c.py
│ └── test.py
└── b.txt
test.py:
from os.path import dirname, abspath
import os
print(__file__)
print('current working directory:', os.getcwd()) # 打印当前工作目录
print(dirname(__file__))
print(abspath(__file__))
print(dirname(abspath(__file__)))
print(dirname(dirname(abspath(__file__))))
在不同目录下进行测试:
A. Linux terminal, bottom目录内(注意结果第三行输出了空字符串)
$ python test.py
__file__: test.py
current working directory: /home/simonzhao/top/bottom
/home/simonzhao/top/bottom/test.py
/home/simonzhao/top/bottom
/home/simonzhao/top
B. Linux terminal, top目录内(注意结果前两行与A中的区别,说明__file__
也是依赖于程序入口路径的,但方法2和3得到的结果没有变化)
$ python bottom/test.py #
__file__: bottom/test.py
current working directory: /home/simonzhao/top
bottom
/home/simonzhao/top/bottom/test.py
/home/simonzhao/top/bottom
/home/simonzhao/top
需注意以上测试结果都是在Linux下产生,在Windows的CMD和Powershell(特别是后者)中并非完全相同,有需要的童鞋可以测测看。