python:如何在运行时检查额外要求?

Elr*_*ond 3 python pkg-resources

我们的主应用程序有一些额外的功能,用户可以启用。这些功能在它们自己的目录中。这些功能可能需要额外的依赖项。我正在考虑将它们放在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
Run Code Online (Sandbox Code Playgroud)

这是正确的,pythonic 的做事方式吗?这有意义吗?

小更新:为什么如此复杂,而不是try: import ... except ImportError: ...像一个答案中所建议的那样:

  1. 我们的插件可能有一堆依赖项。创建如下所示的实际代码非常冗长。
  2. 某些插件可能需要特定版本的包。需要特定包装测试或pkg_resources无论如何使用的测试。所以这就是我上面的想法使用 pkg_resources 的原因。
  3. 我们想为可以运行的插件运行单元测试。在单元测试中处理 ImportError 并不好。拥有一个can_we_unit_test_this_plugin(plugin)功能使事情变得更容易。

第二次更新:extra_requireinsetup.py呢?

  1. 人们经常错过安装那些。好吧,糟糕的借口。
  2. 我的愿景是,从上面提到的各个功能的各个子目录中直接setup.py加载。但这确实是下一步。extra_requirerequires.txt

Mar*_*ers 6

通常,您只需尝试导入依赖项,并ImportError优雅地处理异常:

try:
    import dependency
except ImportError:
    # dependency missing, issue a warning
    import warnings
    warnings.warn('dependency not found, please install to enable xyz feature')
Run Code Online (Sandbox Code Playgroud)

您可以在extras_require基于 setuptools 的setup.py脚本的条目中列出此类依赖项。pip,easy_install并且zc.buildout所有人都可以处理安装此类附加功能。请参阅声明“Extras”(具有自己的依赖项的可选功能)。

extras_require如果您有这些要求,您可以使用该条目列出最低版本要求。是的,用户可能已经安装了旧版本的依赖项;我只是清楚地记录了要求。真的,测试功能,而不是版本。如果您因为添加了某个 API 方法而需要更新版本?测试该方法而不是版本。

但是,它听起来好像你可能要打包的插件作为独立的软件包,而不是,然后列出那些在extras_require。我会使用入口点来注册和枚举这样的插件。你就这样不需要检验的进口或用于包装,你只是枚举注册入口点来代替。每个插件都列出了自己的依赖项并拥有自己的单元测试。