管理 Python 项目中的资源

Question

我有一个 Python 项目，其中使用了许多非代码文件。目前这些都是图像，但将来我可能会使用其他类型的文件。存储和引用这些文件的好方案是什么？

我考虑在主目录中创建一个文件夹“resources”，但是有一个问题；一些图像是在我的项目的子包中使用的。以这种方式存储这些图像会导致耦合，这是一个缺点。

另外，我需要一种独立于当前目录的访问这些文件的方法。

Answer 1

您可能需要使用 setuptools 附带的 pkg_resources 库。

例如，我制作了一个快速的小包 "proj" 来说明我将使用的资源组织方案：

proj/setup.py
proj/proj/__init__.py
proj/proj/code.py
proj/proj/resources/__init__.py
proj/proj/resources/images/__init__.py
proj/proj/resources/images/pic1.png
proj/proj/resources/images/pic2.png

请注意我如何将所有资源保存在单独的子包中。

"code.py" 显示了如何使用 pkg_resources 来引用资源对象：

from pkg_resources import resource_string, resource_listdir

# Itemize data files under proj/resources/images:
print resource_listdir('proj.resources.images', '')
# Get the data file bytes:
print resource_string('proj.resources.images', 'pic2.png').encode('base64')

如果运行它，您会得到：

['__init__.py', '__init__.pyc', 'pic1.png', 'pic2.png']
iVBORw0KGgoAAAANSUhE ...

如果需要将资源视为文件对象，使用resource_stream()。

访问资源的代码可能位于项目子包结构中的任何位置，在本例中，它只需要通过全名引用包含图像的子包：proj.resources.images。

这是“setup.py”：

#!/usr/bin/env python

from setuptools import setup, find_packages

setup(name='proj',
      packages=find_packages(),
      package_data={'': ['*.png']})

警告：
要“本地”测试，即不首先安装软件包，您必须从包含 setup.py 的目录中调用测试脚本。如果您与 code.py 位于同一目录中，Python 将不知道 proj 包。因此像 proj.resources 这样的事情将无法解决。

Answer 2

执行此操作的新方法是使用 importlib。对于早于 3.7 的 Python 版本，您可以向 importlib_resources 添加依赖项，并执行类似的操作：

from importlib_resources import files


def get_resource(module: str, name: str) -> str:
    """Load a textual resource file."""
    return files(module).joinpath(name).read_text(encoding="utf-8")

如果您的资源位于 foo/resources 子模块内，那么您将使用 get_resource 像这样

resource_text = get_resource('foo.resources', 'myresource')

Answer 3

您始终可以在每个需要它的子包中拥有一个单独的“资源”文件夹，并使用 os.path 函数从子包的 __file__ 值中获取这些文件夹。为了说明我的意思，我在三个位置创建了以下 __init__.py 文件：

c:\temp\topp        (top-level package)
c:\temp\topp\sub1   (subpackage 1)
c:\temp\topp\sub2   (subpackage 2)

这是 __init__.py 文件：

import os.path
resource_path = os.path.join(os.path.split(__file__)[0], "resources")
print resource_path

在 c:\temp\work 中，我创建了一个app，topapp.py，如下：

import topp
import topp.sub1
import topp.sub2

这代表使用 topp 包和子包的应用程序。然后我运行它：

C:\temp\work>topapp
Traceback (most recent call last):
  File "C:\temp\work\topapp.py", line 1, in 
    import topp
ImportError: No module named topp

正如预期的那样。我们设置 PYTHONPATH 来模拟将我们的包放在路径上：

C:\temp\work>set PYTHONPATH=c:\temp

C:\temp\work>topapp
c:\temp\topp\resources
c:\temp\topp\sub1\resources
c:\temp\topp\sub2\resources

如您所见，资源路径正确解析为路径上实际（子）包的位置。

更新： 这里是相关的 py2exe 文档。

Answer 4

@ pycon2009，有一个关于 distutils 和 setuptools 的演示。您可以在此处找到所有视频

Python 中的鸡蛋和构建部署 - 第 1 部分

Python 中的鸡蛋和构建部署 - 第 2 部分

Python 中的鸡蛋和构建部署 - 第 3 部分

在这些视频中，他们描述了如何在包中包含静态资源。我相信它在第 2 部分中。

使用 setuptools，您可以定义依赖项，这将允许您有 2 个包使用第 3 个包中的资源。

Setuptools 还为您提供了访问这些资源的标准方法，并允许您使用包内的相对路径，这样就无需担心包的安装位置。