python - Setuptools 包发现

Question

我的项目有下面的包树

└── src
|    ├── mypkg1
|    │   ├── module1.py
|    │   ├── module2.py
|    │   └── __init__.py
|    |   |-- setup.py
|    |   |__ requirements.py 
|    └── mypkg2
|        ├── module1.py
|        └── __init__.p
|
|---- base
|      |----- init.py
|      |----- module1.py      

注意 - src 和 base 处于同一级别。

我应该如何配置 setup.py 文件，以便我可以只安装 base 和 mypkg1 包并排除 mypkg2.

我试过在包中提及 ['base','mypkg1'] 但没有成功也尝试使用 find_packages() 它只会显示 mypkg1 和 mypkg2。

Answer 1

由于复杂的代码库布局，有很多事情需要处理。另外，我不确定你为什么要在 src/mypkg1 中显示设置脚本 - 从那里调用它不会在 src 之外找到任何东西，因此你将拥有没有机会包含 base。在下面的示例中，我切换到包含 src 和 base 目录的根目录:

project_root
├── src/
├── base/
└── setup.py

包发现

因为 base 在项目根目录下，它会被简单的 find_packages 调用发现:

>>> from setuptools import find_packages
>>> find_packages()
['base']

要在 src 下找到包，通过 where 参数传递它:

>>> from setuptools import find_packages
>>> find_packages(where='src')
['mypkg1', 'mypkg2']

要排除 mypkg2，通过 exclude 参数中的列表传递它:

>>> from setuptools import find_packages
>>> find_packages(where='src', exclude=['mypkg2'])
['mypkg1']

包结构映射和文件包含

像收集包一样调用 setuptools.setup() 仅适用于 base，因为 mypkg1 不在根级别.您必须通过 package_dir 映射它的位置:

setup(
    ...,
    package_dir={'': 'src'},
)

但是，这会指示 setup() 在 src 中查找 所有 包的文件，这使得文件位于 base 找不到。因此，您必须显式映射它:

setup(
    ...,
    package_dir={'': 'src', 'base': 'base'},
)

完成最小设置脚本

from setuptools import setup, find_packages

setup(
    name='...',
    version='...',
    packages=find_packages() + find_packages(where='src', exclude=['mypkg2']),
    package_dir={'': 'src', 'base': 'base'},
)

现在当例如构建一个轮子，这将产生以下文件布局:

  Length      Date    Time    Name
---------  ---------- -----   ----
        0  06-24-2022 21:55   base/__init__.py
        0  06-24-2022 21:55   base/module1.py
        0  06-24-2022 21:54   mypkg1/__init__.py
        0  06-24-2022 21:54   mypkg1/module1.py
        0  06-24-2022 21:54   mypkg1/module2.py