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

mgdq6dx1  于 2023-10-21  发布在  Python
关注(0)|答案(2)|浏览(212)

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

i2byvkas

i2byvkas1#

pkg_resources软件包可以做到这一点。正如文档的资源提取部分所提到的,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)
rseugnpd

rseugnpd2#

在Python 3.12+中,来自Python自己的标准库的importlib.resources可以通过其filesas_file方法从包资源中访问整个目录:

from importlib import resources

traversable = resources.files("package.resources")
with resources.as_file(traversable) as path:
    for file in path.glob("*"):
        print(file)

请注意,该目录只能在with块中访问,因为如果必须将其提取到临时文件中(如果软件包以存档的形式安装,则必须这样做),则一旦as_file返回的上下文管理器退出,它将被清理。
这种方法通常应该优于涉及pkg_resources的方法,因为importlib.resourcesthe latter's own documentation acknowledges的正式(更高性能)继承者。它避免了对pkg_resources的依赖。

相关问题