如何访问Python包中的静态文件？

从 Python 包内部读取静态文件

情况

想象一下您的 Python 包包含您想要从您的 Python 包中访问的模板文本文件程序。指定这些文件的路径时，有必要处理包结构。

TLDR：使用 importlib.resources (Python 3.9 )

如果不考虑向后兼容性（即，您使用 Python 3.9 或更高版本），利用 importlib.resources 模块。

from importlib import resources as impresources
from . import templates

inp_file = impresources.files(templates) / 'temp_file'
with inp_file.open("rt") as f:
    template = f.read()

传统方法：使用Setuptools中的pkg_resources

对于低于3.9的Python版本，请考虑使用setuptools中的pkg_resources模块

import pkg_resources

# Could be a dot-separated package/module name or a "Requirement"
resource_package = __name__
resource_path = '/'.join(('templates', 'temp_file'))  # Do not use os.path.join()
template = pkg_resources.resource_string(resource_package, resource_path)
# or for a file-like stream:
template = pkg_resources.resource_stream(resource_package, resource_path)

步骤：

1. 在包层次结构中找到您的模板：

   <your-package>
     +--<module-asking-for-the-file>
     +--templates/
          +--temp_file

2. 引用模板文件使用方法：

   • 选项 1（导入lib.resources）：

     from . import templates
     
     inp_file = impresources.files(templates) / 'temp_file'

   • 选项 2 (pkg_resources):

     resource_path = '/'.join(('templates', 'temp_file'))
     template = pkg_resources.resource_string(__name__, resource_path)

提示：

• 对于当前模块内的文件，请使用 package 作为 package 参数importlib.resources.
• importlib.resources.files 函数返回一个类似路径的对象，它允许基于上下文管理器的临时文件访问。
• 在 setup.py 中包含任何静态文件或MANIFEST 用于打包目的。
• 考虑在 setup.py 中设置 zip_safe=True 以启用 zipapp 分发。

以上是如何访问Python包中的静态文件？的详细内容。更多信息请关注PHP中文网其他相关文章！