Python 在setup.py中如何包含和安装本地依赖项

在本文中，我们将介绍如何在Python的setup.py文件中包含和安装本地依赖项。setup.py是用于构建和安装Python模块的脚本文件，其中可以指定模块的依赖项。有时候，我们可能需要引入一些自己开发或修改的本地依赖项，而不是从Python Package Index (PyPI) 安装。

通常情况下，我们可以通过在setup.py中指定依赖项的名称和版本号来安装依赖项。但如果依赖项不在PyPI上，我们需要使用其他方法来包含和安装本地依赖项。下面我们将介绍两种常用的方法来实现这一目标。

阅读更多：Python 教程

方法1：通过引入本地路径来安装依赖项

第一种方法是通过引入本地路径来安装依赖项。可以将本地依赖项作为子目录或其他位置中的独立项目进行开发，并在setup.py中指定其路径。我们可以使用dependency_links参数将其添加到setup函数中。

以下是一个示例setup.py文件代码，其中依赖项mydependency位于项目根目录下的dependencies文件夹中：

from setuptools import setup

setup(
    name='myproject',
    version='1.0',
    install_requires=[
        'mydependency'
    ],
    dependency_links=[
        'file:///path/to/dependencies/mydependency'
    ]
)

在这个示例中，我们在install_requires中添加了依赖项mydependency，并在dependency_links中指定了mydependency的本地路径。需要注意的是，路径应该是绝对路径，可以是硬盘上的路径或者网络路径。

方法2：使用setuptools的extras_require功能

第二种方法是使用setuptools的extras_require功能来安装本地依赖项。extras_require允许我们在安装过程中选择不同的依赖项，可以根据本地依赖项来选择安装。

以下是一个示例setup.py文件代码，其中依赖项mydependency位于项目根目录下的dependencies文件夹中，并且通过extras_require按需安装：

from setuptools import setup

setup(
    name='myproject',
    version='1.0',
    extras_require={
        'local': ['mydependency @ file:///path/to/dependencies/mydependency'],
    }
)

在这个示例中，我们在extras_require中定义了一个local选项，并添加了mydependency的本地路径。使用时，可以通过pip install -e .[local]命令来安装这个特定的依赖项。这样可以轻松地选择性地安装本地依赖项，而不会干扰其他环境。

总结

在本文中，我们介绍了如何在Python的setup.py文件中包含和安装本地依赖项。我们介绍了两种常用的方法：通过引入本地路径来安装依赖项以及使用setuptools的extras_require功能。通过这些方法，我们可以方便地包含和安装本地依赖项，满足项目特定的需求。