Python pkg_resources 和包中的文件访问

Question

我正在构建我的第一个 python 包（然后我使用 pip 安装）并且我需要使用一些非 python 文件。在these answers中说明我应该使用pkg_resources函数。但我想不出一个有效的例子。假设我有这个项目结构：

package_name/
----data/
--------image.png
----package_name/
--------__init__.py
--------file.py  
----setup.py
----MANIFEST.in
----conf.yml

现在我想从 file.py 访问 conf.yml 和 image.png。我应该如何进行：

• file.py ?
• setup.py ?
• MANIFEST.in ?

Answer 1

访问这些文件的最简单方法是将其包含在 MANIFEST.in

中

global-include *.png
global-include *.yml

MANIFEST.in 只会将文件用于源代码分发，而 setup.py 将包含用于 binary/wheel 分发的文件，所以为了安全起见，在你的 setup.py 中

include_package_data = True,
package_data = {
'' : ['*.png'],
'' : ['*.yml'],
}

然后你可以从file.py

中像这样引用特定文件

from pkg_resources import resource_string


 def foo():
     pngfile = resource_string(__name__, 'data/image.png')
     ymlfile = resource_string(__name__, 'conf.yml')

注意我是如何为 png 文件指定目录的。

此解决方案也不考虑您可能想要排除的具有相同扩展名的文件，但可以通过排除或指定文件名而不是使用星号轻松处理这些文件。

我知道有些问题很容易被认为是重复的，但我也很难找到一个可行的例子，在苦苦思索了一段时间之后，我设法找到了一些可以工作的东西，就是这样。