如何使用源代码中的 package_data 中的数据？

Question

在 setup.py 中，我指定了如下所示的 package_data：

packages=['hermes'],
package_dir={'hermes': 'hermes'},
package_data={'hermes': ['templates/*.tpl']},

我的目录结构大致如下

hermes/
 |
 | docs/
 | ...
 | hermes/
    | 
    | __init__.py
    | code.py
    | templates
        |
        | python.tpl
 |
 | README
 | setup.py

问题是我需要使用源代码中的 templates 目录中的文件，以便我可以编写 python 代码（该项目是一个解析器生成器） 。我似乎无法弄清楚如何从我的代码中正确包含和使用这些文件。有什么想法吗？

Answer 1

标准 pkgutil 模块的 get_data() 函数将计算数据相对于包的路径，并通过 Python 用于导入 Hermes 包的任何模块加载器检索数据：

import pkgutil
data = pkgutil.get_data('hermes', 'templates/python.tpl')

当然，在某些情况下，您可以使用以下命令读取数据 ：从 hermes.__file__ 计算出的路径，但如果您计划分发您的项目，请考虑它可能以不同的方式安装在最终用户的计算机上：作为纯文件，部署在压缩的 Egg 存档中，在后一种情况下，您的 hermes 模块将由 Python 使用 zipimporter 导入，从而阻止您执行正常的 open(path).read( )：

>>> import hermes
>>> hermes.__loader__
<zipimporter object "/home/pat/.cascade/virt/foo/lib/python2.6/site-packages/foo-0.0.0-py2.6.egg">

如果您愿意在 distribute 代码库上添加运行时依赖项，您可能需要考虑查看 pkg_resources 模块，它可以为您提供相同的结果，但增加了其他功能。

import pkg_resources
data = pkg_resources.resource_string('hermes', 'templates/python.tpl')