在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”类，允许使用常规目录和压缩的资源目录。另一种可能是在使用资源之前将其提取到常规目录，但这似乎违反了资源系统的原则

Answer 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)