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

问题描述

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

解决方法

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)