如何让 setup.py 在子目录中包含一个包？

Question

我有一个库 git repo sub_lib，由于各种原因，我无法直接发布到 pypi 存储库。相反，我将它用作另一个库 main_lib 的 git 子模块，结构如下：

my_repo/
  setup.py
  main_lib/
    __init__.py
  sub_lib/  # a git submodule
    setup.py
    sub_lib/
      __init__.py

main_lib 需要import sub_lib，那么如何配置my_repo 的setup.py 以同时包含main_lib 和sub_lib 作为包？特别是，是否可以让setup.py 包含来自子目录的包（因为它在sub_lib/sub_lib/ 中）？

当前 setup.py：

from setuptools import setup, find_packages
setup(
  name='main-lib',
  ...,
  packages=find_packages(exclude=['tests*']),
  package_data={'main_lib': ['py.typed'], 'sub_lib': ['py.typed']},
)

或者使用符号链接更好地解决这个问题？

Answer 1

我可以通过符号链接来实现这个功能：

my_repo/
  setup.py
  main_lib/
    __init__.py
  sub_lib_repo/  # a git submodule
    setup.py
    sub_lib/
      __init__.py
  sub_lib -> ./sub_lib_repo/sub_lib

在我的特殊情况下，我需要 sub_lib 也是 main_lib 的 pip 子模块，我可以使用第二个符号链接：

my_repo/
  setup.py
  main_lib/
    __init__.py
    sub_lib -> ../sub_lib_repo/sub_lib
  sub_lib_repo/  # a git submodule
    setup.py
    sub_lib/
      __init__.py
  sub_lib -> ./sub_lib_repo/sub_lib

以这种方式，一旦安装了 pip，from main_lib.sub_lib.foo import bar 之类的东西就可以工作，from sub_lib.foo import bar 之类的东西就可以工作（sub_lib 中的必要导入）。无需更改 setup.py。