咨询Python包中外部依赖的最佳导入方式（PyPi发布场景）

首先得指出，你当前的代码存在几个语法错误，先修正下：

• def Class(Foo): 应该写成 class Foo:（定义类要用class关键字）
• 类里的方法需要加self参数，所以function应该定义为def function(self, a: int, b: int):
• np.arrange是拼写错误，正确写法是np.arange
• 文档字符串的缩进需要和方法体对齐

修正后的基础代码示例：

class Foo:
    def function(self, a: int, b: int):
        '''A class that uses numpy to do something with a and b'''
        import numpy as np
        return np.arange(a + b)

回到你的核心问题——依赖处理，下面是几种最佳实践：

1. 必须在包配置文件中声明依赖 #

这是PyPI包的核心要求，也是避免用户导入报错的根本解决方案。用户安装你的包时，pip会自动下载并安装这些依赖。

如果使用现在推荐的pyproject.toml配置方式，可以这么写：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "你的包名"
version = "0.1.0"
# 声明核心依赖，用户安装包时自动安装
dependencies = [
    "numpy>=1.21.0",  # 指定最低兼容版本，避免版本兼容问题
    "scikit-learn>=1.0"
]

如果使用旧版的setup.py，则在文件中添加：

from setuptools import setup

setup(
    name="你的包名",
    version="0.1.0",
    install_requires=[
        "numpy>=1.21.0",
        "scikit-learn>=1.0"
    ]
)

只要正确声明了依赖，模块顶部直接导入numpy/sklearn是完全没问题的——用户安装包时已经自动装好了这些依赖，不会出现导入失败。

2. 延迟导入（按需导入） #

如果你的包有部分功能依赖numpy/sklearn，但不是所有用户都会用到这些功能，或者依赖包体积大、导入慢，可以把导入语句移到具体的函数/方法内部，而不是模块顶部。

比如上面修正后的代码，把import numpy as np放在function方法里，这样用户导入Foo类时不会触发numpy的导入，只有调用function时才会检查依赖。

为了给用户更友好的提示，还可以捕获ImportError并给出明确指引：

class Foo:
    def function(self, a: int, b: int):
        '''A class that uses numpy to do something with a and b'''
        try:
            import numpy as np
        except ImportError:
            raise RuntimeError("使用该功能需要安装numpy，请执行：pip install numpy")
        return np.arange(a + b)

这种方式尤其适合处理可选依赖——比如你的包大部分功能不需要sklearn，只有某几个函数用到，就可以把sklearn的导入放在这些函数里，同时在配置文件里声明可选依赖：

[project.optional-dependencies]
sklearn = ["scikit-learn>=1.0"]

用户可以通过pip install 你的包名[sklearn]安装包含sklearn的版本，不使用相关功能的用户则无需安装。

3. 总结 #

• 核心依赖必须在配置文件里声明，这是PyPI包的标准流程，能确保用户安装时自动获取依赖，此时模块顶部直接导入完全没问题。
• 延迟导入适合处理可选依赖或非核心功能，能提升模块导入速度，避免强制用户安装不必要的依赖。
• 永远不要假设用户已经安装了你的依赖，必须通过配置文件明确声明，或者在代码里处理导入失败的情况。

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