用 Python 读取资源文件？这个技巧保你涨姿势

关注“涛哥聊Python”

重磅干货，第一时间送达

我们知道，当你把一个资源文件和一个.py文件放在一起的时候，你可以直接在这个.py文件中，使用文件名读取它。例如：

with open('test.txt') as f:
    content = f.read()
print('文件中的内容为：', content)

运行效果如下图所示：

但请注意，这里我是直接运行的​​read.py​​​这个文件。如果资源文件是存放在一个包(package)里面，然后我们在外面调用这个包里面的​​.py​​文件会怎么样呢？我们试一试：

可以看到，现在Python 已经找不到这个文件了。这是因为，我们的入口程序在 ​​~/get_title​​​文件夹中，而​​test.txt​​​文件在​​~/get_title/util​​​文件夹中。因为我们运行的是​​main.py​​​，所以 Python 会在​​~/get_title​​​文件夹里面寻找​​test.txt​​，自然就找不到了。

如果是引用包里面的其他模块，可以使用相对路径。例如引用同一个包里面名叫​​sql_util.py​​​里面的​​conn​​​对象，我们可以直接写为​​from .sql_util import conn​​。但是资源文件不能使用相对路径来读取，如下图所示：

有一个笨办法，就是获取当前正在运行的这一行代码所在的文件夹，然后拼出资源文件的完整路径。修改 read.py 文件：

import os


def read_file():
    current_folder = os.path.dirname(__file__)
    resource_path = os.path.join(current_folder, 'test.txt')
    with open(resource_path) as f:
        content = f.read()
    print('文件中的内容为：', content)

运行效果如下图所示：

但这样写稍显麻烦。

如果你的 Python 版本不低于3.7，那么你可以使用​​importlib.resources​​来快速读取资源文件：

from importlib import resources
with resources.open_text('包名', '资源路径') as f:
    content = f.read()

运行效果如下图所示：

如果你读取的不是文本文件，那么你可以把​​resources.open_text​​​改成​​resources.open_binary​​，从而读取二进制文件。

但需要注意的是，资源文件必须放在包的根目录。这样才能正确读取。如果资源文件在包内部的子目录中，​​importlib.resources​​是不能直接读取的。

例如我们的包为​​util​​​，里面有一个文件夹叫做​​deep_folder​​​，资源文件​​test.txt​​​放在​​deep_folder​​​中，此时，我们如果要读取这个资源文件，就必须把在​​deep_folder​​​文件夹中创建一个​​__init__.py​​​，把它也变成一个包。然后修改​​read.py​​的代码：

from importlib import resources
from . import deep_folder




def read_file():
    with resources.open_text(deep_folder, 'test.txt') as f:
        content = f.read()
    print('文件中的内容为：', content)

把deep_folder作为一个 module 导入，然后把这个 module 作为resources.open_text的第一个参数。这样才能正确读取，如下图所示：

​

·················END·················

你好，我是Sitin涛哥，非著名程序员，项目经理，现在创业中。

在公众号和视频号「涛哥聊Python」分享我的升级打怪经验！