Python 包的可选依赖管理：了解 `extras_require`

刚开始学 Python 的小张，热衷于编写自己的 Python 包并分享给大家。但在某天，他遇到了一个棘手的问题：如何为他的包管理不同的依赖？他不想让每个使用他包的用户都安装所有的依赖，只想根据使用情况来选择性地安装。在经过一番探索后，他终于找到了答案。本文将探讨 Python 包的 extras_require 功能，并解答与此相关的常见问题。

1. 什么是 extras_require？

在 setup.py 文件中，extras_require 允许开发者为他们的包定义可选的依赖。这意味着用户可以选择性地安装这些依赖，而不是在安装包时安装所有的依赖。

例如：

setup(
    ...
    extras_require={
        'dev': ['pytest', 'sphinx'],
        'gui': ['PyQt5']
    }
)

这样，用户在安装包时可以通过以下方式来选择性地安装 dev 或 gui 的依赖：

pip install your_package[dev]
pip install your_package[gui]

2. 安装 extras_require 是否会影响代码安装？

答案是：不会。当安装包时，包内的所有代码都会被复制到目标位置，不管是否安装了 extras_require 指定的依赖。这意味着，即使用户没有安装可选依赖，与这些可选依赖相关的代码仍然会被安装。

3. 主流做法是什么？

业内标杆，例如 requests 库，通常将可选的功能相关代码单独放在一个模块或包中，并在这些代码中通过 try/except 语句来检查是否已安装相关依赖。

例如，假设我们有一个与 PyQt5 相关的 gui 模块：

try:
    import PyQt5
except ImportError:
    raise ImportError("请安装 PyQt5 以使用 gui 模块")

这样，当用户尝试导入 gui 模块但没有安装 PyQt5 时，会收到一个清晰的错误消息，告知他们需要安装 PyQt5。

4. 安装 extras_require 和 install_requires 有什么区别？

install_requires 指定的是包的必要依赖，即用户在安装包时必须安装的依赖。而 extras_require 指定的是可选的依赖，用户可以选择性地安装。

例如，如果我们的包必须依赖 numpy，但只在某些功能中使用 matplotlib，那么可以这样定义：

setup(
    ...
    install_requires=['numpy'],
    extras_require={
        'plot': ['matplotlib']
    }
)

这样，用户在安装包时会自动安装 numpy，但只有当他们需要绘图功能时，才会选择性地安装 matplotlib。

5. 结论

对于 Python 包的开发者来说，了解和正确使用 extras_require 可以提供更加灵活和用户友好的安装选项。同时，结合 try/except 语句，可以确保代码的鲁棒性，并为用户提供清晰的错误消息。

未经允许不得转载：大神网 » Python 包的可选依赖管理：了解 `extras_require`