深度嵌套的命名空间包

Question

我需要维护一些以这种方式构建的 ETL 工具，将任务和管道定义为 python 包的集合。考虑具有小核心的插件架构和嵌套命名空间/包/子包中的近千个插件。这还不是一团糟还，整体质量相当不错，但setup.py 和__init__.py-s 看起来很hacky，有时在导入过程中会导致意想不到的问题。

我想稍微简化一下。从 Python 3.3 开始，我们可以通过创建不带__init__.py 的子目录将包放入命名空间。这正是我所需要的，但我想避免在源代码中深度嵌套子目录，因为大量的包非常小。在极端情况下，它们看起来像这样：

$ tree
.
├── setup.cfg
├── setup.py
└── src
    └── foo
        └── bar
            └── baz
                └── xyz
                    └── uvw
                        └── package
                            ├── actual_code.py
                            └── __init__.py

有没有办法使用隐式命名空间而没有如此深的结构，只需在setup.py（或者更好的setup.cfg）中的某处指定命名空间？换句话说，有没有一种简单的方式来判断：在foo.bar.baz.xyz.uvw命名空间中安装package？

我想要这样的结构：

$ tree
.
├── setup.cfg
├── setup.py
└── src
    └── package
        ├── actual_code.py
        └── __init__.py

但安装过程要把package放到foo/bar/baz/xyz/uvw/package文件夹中，这样就可以用完整路径导入了。

编辑：这是个好主意吗？

Answer 1

这可以使用distutils.core.setup 的package_dir 参数（或setuptools 的等效参数）来实现。

只需修改您的 setup.py 以包含以下内容：

from distutils.core import setup

setup(# ... other setup arguments ...
      package_dir={'foo.bar.baz.xyz.uvw': 'src'},
      packages=['foo.bar.baz.xyz.uvw.package'],
     )

这里的关键部分是package_dir 说“foo.bar.baz.xyz.uvw 的内容是在src 目录中找到的”，而packages=['foo.bar.baz.xyz.uvw.package'] 告诉它期望找到并安装一个名为@987654330 的包@。

setup.cfg 等效项是：

[options]
package_dir=
    foo.bar.baz.xyz.uvw=src
packages = foo.bar.baz.xyz.uvw.package