通过pip/requirements.txt安装库时，如何让setup.py的opencv-python检查逻辑生效？

问题描述 #

我的库默认依赖opencv-python，少数场景下需要用到opencv-contrib-python，希望实现按需便捷安装。我在setup.py中添加了检查虚拟环境是否已安装opencv-python的逻辑，直接执行python setup.py install时正常，但通过pip或requirements.txt安装时完全失效。相关代码如下：

# Check if opencv-python is already installed
try:
    importlib.import_module("cv2")
    opencv_installed = True
    print("Version of opencv-python is already installed")
except ImportError:
    opencv_installed = False

if not opencv_installed:
    INSTALL_REQUIRES.append("opencv-python>=4.5.5.62, <5.0.0.0")

原因分析 #

pip安装时会先执行**轮子构建（wheel building）**流程，这个过程是在隔离的临时环境中进行的，和目标安装的虚拟环境完全独立。所以你在setup.py里的importlib检查，查的是构建环境的状态，不是用户实际要安装的环境，自然起不到预期作用。

解决方案 #

1. 用extras_require实现按需安装opencv-contrib-python #

这是Python包管理的标准做法，既符合pip规范，又能让用户灵活选择依赖：

from setuptools import setup

INSTALL_REQUIRES = [
    # 你的其他基础依赖
]

EXTRAS_REQUIRE = {
    "contrib": ["opencv-contrib-python>=4.5.5.62, <5.0.0.0"]
}

setup(
    name="your-library-name",
    install_requires=INSTALL_REQUIRES,
    extras_require=EXTRAS_REQUIRE,
    # 其他setup配置项
)

用户使用时：

• 默认安装（基础依赖+opencv-python）：pip install your-library-name
• 需要contrib功能时：pip install your-library-name[contrib]

2. 调整opencv-python的依赖逻辑 #

不要在setup.py里动态判断，直接把opencv-python加入INSTALL_REQUIRES：

INSTALL_REQUIRES = [
    # 其他依赖
    "opencv-python>=4.5.5.62, <5.0.0.0"
]

不用担心重复安装：如果用户已经装了opencv-contrib-python（它包含opencv-python的所有内容），pip会自动识别两者的兼容性，不会重复下载安装。

3. 若坚持动态检查（不推荐） #

如果一定要在用户安装环境中做检查，需要借助setuptools的安装钩子，比如重写install命令：

from setuptools import setup, Command
import importlib

class CustomInstall(Command):
    description = "Custom install command with opencv check"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        # 检查用户环境是否已装cv2
        try:
            importlib.import_module("cv2")
            print("opencv-python already installed, skipping")
        except ImportError:
            # 手动调用pip安装opencv-python
            from pip._internal import main as pip_main
            pip_main(["install", "opencv-python>=4.5.5.62, <5.0.0.0"])
        # 执行常规安装
        self.run_command("install_lib")

setup(
    name="your-library-name",
    cmdclass={"install": CustomInstall},
    # 其他配置
)

这种方法不推荐，因为依赖pip内部API，可能在不同pip版本中出现兼容性问题，也不符合包管理规范。

内容的提问来源于stack exchange，提问作者cxnt