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

【问题标题】：Portable way to handle directory resources as regular directories in Python package将目录资源作为 Python 包中的常规目录处理的可移植方式
【发布时间】：2020-08-21 09:00:05
【问题描述】：

我正在编写一个必须使用外部资源的 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”类，允许使用常规目录以及压缩资源目录。另一种可能是在使用之前将资源提取到常规目录中，但这似乎违反了资源系统的原则。

【问题讨论】：

标签： python python-3.x package pkg-resources

【解决方案1】：

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

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

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

【讨论】：