无法在python模块创建的pip包中使用jinja2模板

时间:2016-10-06 04:32:02

标签: python python-2.7 pip jinja2 setuptools

我有一个具有以下目录结构的python项目

foo
  |--MANIFEST.in
  |--requirements.txt
  |--setup.py
  |--foo.py
  |--templates/
     |--bar.tmpl

其中setup.py是一个python脚本。以前,我使用安装脚本将脚本符号链接到我的用户的私有bin(并成功使用它),但决定将其打包(第一次这样做)。我能够使用项目根目录中的$ pip install .在virutalenv中成功安装软件包,并且我能够执行大部分脚本,直到生成jinja2的模板。似乎templates目录未与包的其余部分一起安装,或者我的脚本没有正确找到templates目录的路径。

摘录自foo.py

from jinja2 import Environment, ModuleLoader

def generate_readme(template_file):
    template_env = Environment(loader=PackageLoader('foo','templates'))
    template = template_env.get_template(template_file)        
    template_vars = {"title": get_title()}
    output = template.render(template_vars)
    return output

注意'bar.tmpl'作为template_file传递给此函数

摘录自setup.py

from setuptools import setup

setup(name='foo',                                                         
      py_modules=['foo'],
      entry_points={'console_scripts': ['foo = foo:foo']}          
      include_package_data=True,
      zip_safe=False)

MANIFEST.in的内容:

include templates/*

相关回溯:

  File "/home/username/.virtualenvs/foo/local/lib/python2.7/site-packages/foo.py", line 30, in generate_readme
template = template_env.get_template(template_file)
  File "/home/username/.virtualenvs/foo/local/lib/python2.7/site-packages/jinja2/environment.py", line 812, in get_template
return self._load_template(name, self.make_globals(globals))
  File "/home/username/.virtualenvs/foo/local/lib/python2.7/site-packages/jinja2/environment.py", line 774, in _load_template
cache_key = self.loader.get_source(self, name)[1]
  File "/home/username/.virtualenvs/foo/local/lib/python2.7/site-packages/jinja2/loaders.py", line 235, in get_source
  raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: bar.tmpl

我花了几个小时谷歌搜索,阅读类似的stackoverflow线程,阅读jinja和setuptools文档,并阅读类似的代码。我测试的所有内容都会导致相同的错误消息,而且我有点不知所措。非常感谢任何帮助。

1 个答案:

答案 0 :(得分:4)

MANIFEST.in告诉要在源代码分发中包含哪些文件,即python setup.py sdist,但它不会直接影响安装的文件,因为pip install .只是调用setuptools而不是package_data有什么特别之处。

您需要将文件包含在setup.py文件中,作为包数据或附加文件。

有关详细信息,请参阅https://docs.python.org/2/distutils/setupscript.html,请注意页面上的data_filespackage_data