从python包资源中提取文件夹

Question

在我尝试分发的包的本地版本中，我有以下代码：

shutil.copytree(WWW_LOCATION, dir_path)

WWW_LOCATION 是我的 python 模块的子文件夹，其中包含一些静态文件和文件夹：

dv
  \dv
     mytool.py
     \www_folder
       \somefolders_and_files
  setup.py
  MANIFEST.in
  README.md
  LICENSE
  setup.cfg

在我的代码中，在执行之后，我需要将整个文件夹与一些动态生成的文件一起复制到用户指定的位置。这在本地效果很好，但我读到了通过 pypi 分发的内容，我必须小心，因为文件可能会被压缩。

这个答案解释了如何访问资源中的内容（=在 python 中读取它们），但是，一次只能访问一个文件。将文件夹内容复制到指定位置的安全方法是什么？

Answer 1

“更简单”的解决方案是zip_safe=False在您的软件包设置（setup.py或setup.cfg）中进行设置，以避免您的软件包被安装为压缩蛋。由于大多数安装都是使用 完成的pip，它从不创建压缩的 egg 安装，因此现在无论如何都很少遇到压缩包安装。

然后，您只需要担心有人手动将包压缩到 zip 文件中以添加到sys.path，您可以选择不支持这种用例。这是一种不同形式的压缩包；Eggs 是一个可安装项目（由 支持pkg_resources）的zip 文件，并将它们存储在 上列出的目录中sys.path。pkg_resources只能支持后者，不能支持前者。

如果您确实想支持压缩蛋，那么对于您的特定情况，使用pkg_resourcesAPI 进行资源提取会更容易，因为虽然它可能“较慢”，但它也支持完整的目录树。从resource_filename()文档：

如果命名资源是一个目录，则该目录（包括子目录）中的所有资源也将被提取。

我会这样使用它：

try:
    www_location = pkg_resources.resource_filename("dv", "www_folder")
    shutil.copytree(www_location, dir_path)
finally:
    pkg_resources.cleanup_resources()

直接添加到 zipfile 中的包中的资源sys.path无法通过pkg_resources. 为此，您需要更新的importlib.resources模块（或者它是backport），但此 API 不支持任意目录结构。该importlib.resources.path()功能documenation状态：

包是符合Package要求的名称或模块对象。resource是要在包中打开的资源的名称；它可能不包含路径分隔符，也可能没有子资源（即它不能是目录）。

（粗体强调我的）。

虽然您可以使用 查找包中的目录importlib.resources.contents()，但您实际上无法访问这些目录的内容，除非它们本身是 Python 包（因此其中有一个__init__.py文件）。该实施的传统，非压缩包这些功能还是会给予您在使用时将访问到该目录importlib.resources.path()，当包被包含在一个你不能做同样的.zip档案。

importlib.resources是一种更好的、面向未来的支持途径。为了支持这一点，您可以压缩源和轮分布中的www_folder资源树，然后使用该 zipfile 对象中的内容并将其提取到目标。with importlib.resources.path("dv", "www_folder.zip") as www_location: www_zip = zipfile.open(www_location)