在 Python 包中将目录资源作为常规目录处理的可移植方式

Question

我正在编写一个必须使用外部资源的 Python 程序包。用户可以选择使用自己的资源版本，或者只是坚持使用默认版本，嵌入包中。现在，我想以与外部提供的资源类似的方式处理包资源，我可以使用文件系统功能访问这些资源。在 Python 中是否有标准的方法来做到这一点？

更准确地说，我的项目的组织结构大致如下：

package/
├── __init__.py
├── src.py
└── resources
    ├── __init__.py
    └── lib
        ├── dir1
        |   ├── dir1
        │   ├── file1
        │   └── ...
        └── dir2
            ├── file1
            └── ...

主要的嵌入式资源是lib，这是一个包含任意数量的嵌套目录和文件的目录。用户可以使用 script（应使用 package/resources/lib）或 script ./path/to/resource（应使用目录 ./path/to/resource）调用脚本。

这个问题是因为我强烈依赖资源的目录结构来完全解析它。特别是，我现在正在使用 pathlib.Path.glob 处理资源目录中的文件。虽然我们可以使用 pkg_resources.resource_stream 来处理嵌入式资源文件，但我还没有找到一种方法来类似地处理资源目录和常规目录。

是否有 API 允许这样做？我正在寻找的主要功能是能够列出目录下的所有文件，无论是在嵌入式资源中还是在文件系统中。

由于打包的资源可能被压缩，我认为我应该使用不同于 pathlib 的东西，它可以提供一个“Directory”class 允许使用常规目录以及压缩资源目录。另一种可能是先把资源解压到一个普通的目录下再使用，不过好像有违资源系统的原则。

Answer 1

pkg_resources 包可以做到这一点。如文档的 Resource Extraction 部分所述，resource_filename(package_or_requirement, resource_name) 允许访问真实文件系统中的资源。特别是，如果资源被压缩，它会将其提取到缓存目录和 returns 缓存路径。

因此，列出 resources.lib 目录中的文件可以通过以下方式完成，例如：

path = pkg_resources.resource_filename("package.resources", "lib")
for file in Path(path).glob("*"):
    print(file)

在 Python 包中将目录资源作为常规目录处理的可移植方式

Portable way to handle directory resources as regular directories in Python package

python

pkg-resources

package

python-3.x