Question

我正在github上写一个软件。它基本上是一个带有一些额外功能的托盘图标。我想提供一段工作代码而不必让用户安装本质上依赖于可选功能的东西，我实际上并不想导入我不会使用的东西所以我认为这样的代码将是“好的解决方案“：

---- IN LOADING FUNCTION ----
features = []

for path in sys.path:
       if os.path.exists(os.path.join(path, 'pynotify')):
              features.append('pynotify')
       if os.path.exists(os.path.join(path, 'gnomekeyring.so')):
              features.append('gnome-keyring')

#user dialog to ask for stuff
#notifications available, do you want them enabled?
dlg = ConfigDialog(features)

if not dlg.get_notifications():
    features.remove('pynotify')


service_start(features ...)

---- SOMEWHERE ELSE ------

def service_start(features, other_config):

        if 'pynotify' in features:
               import pynotify
               #use pynotify...

但是有一些问题。如果用户格式化他的机器并安装最新版本的操作系统并重新部署此应用程序，则功能会在没有警告的情况下突然消失。解决方案是在配置窗口中显示：

if 'pynotify' in features:
    #gtk checkbox
else:
    #gtk label reading "Get pynotify and enjoy notification pop ups!"

但是，如果这是一个mac，我怎么知道我不是在寻找一个他们永远无法填充的依赖的疯狂追逐用户？

第二个问题是：

if os.path.exists(os.path.join(path, 'gnomekeyring.so')):

问题。我可以确定该文件在所有Linux发行版中总是被称为gnomekeyring.so吗？

其他人如何测试这些功能？基本的问题

try:
    import pynotify
except:
    pynotify = disabled

是代码是全局的，这些可能会被乱七八糟，即使用户不想要pynotify ....它仍然被加载。

那么人们认为解决这个问题的最佳方法是什么？

Answer 1

try:方法不需要是全局的 - 它可以在任何范围内使用，因此模块可以在运行时“延迟加载”。例如：

def foo():
    try:
        import external_module
    except ImportError:
        external_module = None 

    if external_module:
        external_module.some_whizzy_feature()
    else:
        print("You could be using a whizzy feature right now, if you had external_module.")

运行脚本时，不会尝试加载external_module。第一次调用foo()时，external_module（如果可用）已加载并插入到函数的本地范围中。随后调用foo()将external_module重新插入其范围，而无需重新加载模块。

一般来说，最好让Python处理导入逻辑 - 它已经做了一段时间了。： - ）

Answer 2

您可能需要查看imp module，它基本上是您在上面手动执行的操作。因此，您可以首先查找包含find_module()的模块，然后通过load_module()加载它，或者只需导入它（在检查配置后）。

顺便说一句，如果使用除了：我总是会添加特定的异常（这里是ImportError），以免意外地捕获无关的错误。

Answer 3

不确定这是否是一种好习惯，但是我创建了一个函数，该函数执行可选的导入（使用importlib）和错误处理：

def _optional_import(module: str, name: str = None, package: str = None):
    import importlib
    try:
        module = importlib.import_module(module)
        return module if name is None else getattr(module, name)
    except ImportError as e:
        if package is None:
            package = module
        msg = f"install the '{package}' package to make use of this feature"
        raise ValueError(msg) from e

如果没有可选模块，则用户至少会知道该怎么做。例如

# code ...

if file.endswith('.json'):
    from json import load
elif file.endswith('.yaml'):
    # equivalent to 'from yaml import safe_load as load'
    load = _optional_import('yaml', 'safe_load', package='pyyaml')

# code using load ...

这种方法的主要缺点是您的导入必须在线完成，而不是全部放在文件的顶部。因此，最好对此功能稍作修改（假设您要导入一个功能或类似功能）：

def _optional_import_(module: str, name: str = None, package: str = None):
    import importlib
    try:
        module = importlib.import_module(module)
        return module if name is None else getattr(module, name)
    except ImportError as e:
        if package is None:
            package = module
        msg = f"install the '{package}' package to make use of this feature"
        import_error = e

        def _failed_import(*args):
            raise ValueError(msg) from import_error

        return _failed_import

现在，您可以将导入与其余导入一起进行，并且仅当实际使用了导入失败的功能时才会引发错误。例如

from utils import _optional_import_  # let's assume we import the function
from json import load as json_load
yaml_load = _optional_import_('yaml', 'safe_load', package='pyyaml')

# unimportant code ...

with open('test.txt', 'r') as fp:
    result = yaml_load(fp)    # will raise a value error if import was not successful

PS：很抱歉回答迟了！

Answer 4

处理不同功能的不同依赖性问题的一种方法是将可选功能实现为插件。这样，用户可以控制在应用程序中激活哪些功能，但不负责自己跟踪依赖项。然后在每个插件安装时处理该任务。

什么是导入和提供可选功能的Python良好实践？

4 个答案: