如何为setuptools发布创建嵌套命名空间包

Question

我正在开发一个python项目，它将具有可单独分发的部分。

通过创建命名空间包 ，我已经能够完成部分目标。 我在命名空间“lvl1”中都有“sub1”和“sub2”。 我可以使用“pip install -e”或python setup.py develop在开发模式下安装这些。 我可以使用import lvl1.sub1导入它们并import lvl1.sub2 。

但是，该项目规模庞大，需要嵌套命名空间 。 我想import lvl1.lvl2.sub1并import lvl1.lvl2.sub2 。 因此，两个子包都位于相同的命名空间（“lvl2”）中，它本身位于命名空间（“lvl1”）中。

理想的概念结构：

lvl1/
    lvl2/
        sub1/
            code.py
            more_code.py
            ...
        sub2/
            code.py
            ...

有办法做到这一点，怎么做？

Answer 1

是的，不止一种方式。 请阅读PEP 420中的“嵌套命名空间包”部分 。

在python> = 3.3中，制作嵌套命名空间的最简单方法是在每个可分发部分中的特定文件夹（“lvl1”和“lvl2”）中删除（不包括）文件__init__.py 。 在每个setup.py ，显式列出最深的命名空间中的所有包。

“lvl1_part1 / setup.py”

setup(
    name='lvl1_part1',
    ...
    zip_safe=False,
    packages=['lvl1.lvl2.sub1']
)

“lvl1_part2 / setup.py”

setup(
    name='lvl1_part2',
    ...
    zip_safe=False,
    packages=['lvl1.lvl2.sub2']
)

用于测试的文件结构：

lvl1_part1/
           setup.py
           lvl1/
                lvl2/
                     sub1/
                          __init__.py
lvl1_part2/
           setup.py
           lvl1/
                lvl2/
                     sub2/
                          __init__.py

要使上述软件包与旧的python版本兼容，请将pkgutil magic文件添加到每个“lvl1”和“lvl2”文件夹中。

致谢：上面的例子是从https://github.com/pypa/sample-namespace-packages/tree/master/pkgutil修改的