我们的主应用程序具有一些用户可以启用的额外功能。这些功能在他们自己的目录中。这些功能可能需要额外的依赖项。我正在考虑将那些放在requires.txt
文件中。在运行时,如果功能中断,我们希望让人们知道。我目前正在考虑这样的事情:
def checkfeature(feature):
everything_okay = True
f = pkg_resources.resource_stream(feature, "requires.txt")
with f:
for r in pkg_resources.parse_requirements(f):
if pkg_resources.working_set.find(r) is None:
print "%r not found, please install, otherwise this feature does not work" % (r,)
everything_okay = False
return everything_okay
这是正确的,pythonic的做事方式吗?这有意义吗?
小更新:
为什么如此复杂,而不仅仅是try: import ... except ImportError: ...
在一个答案中建议:
pkg_resources
。所以这就是我上面的想法使用pkg_resources。can_we_unit_test_this_plugin(plugin)
功能可以让事情变得更轻松。第二次更新:extra_require
中的setup.py
呢?
setup.py
直接从上面提到的extra_require
加载requires.txt
个别子目录中的{{1}}。但这真的是下一步。答案 0 :(得分:4)
通常,您只是尝试导入依赖项,并优雅地处理ImportError
异常:
try:
import dependency
except ImportError:
# dependency missing, issue a warning
import warnings
warnings.warn('dependency not found, please install to enable xyz feature')
您可以在基于setuptools的extras_require
脚本的setup.py
条目中列出此类依赖项。 pip
,easy_install
和zc.buildout
都可以处理安装此类附加内容。请参阅Declaring “Extras” (optional features with their own dependencies)。
如果您有这些条目,可以使用extras_require
条目列出最低版本要求。是的,用户可能已经安装了较旧版本的依赖项;我只是清楚地记录要求。真的,测试功能,而不是版本。如果您需要更新的版本,因为添加了某种API方法?测试该方法而不是版本。
但是,听起来好像您可能希望将插件打包为单独的包,然后在extras_require
中列出那些。我使用entry points来注册和枚举这样的插件。这样你不需要测试包的导入或,你只需枚举已注册的入口点。每个插件都列出了自己的依赖项,并拥有自己的单元测试。