命名空间包的话题对于外行来说似乎有点令人困惑，而且以前版本的 Python 以几种不同的方式实现了它，或者 StackOverflow 上的很多问答都过时了，这无济于事。我正在寻找 Python 3.5 或更高版本的解决方案。

#场景: 我正在将一堆 Python 代码重构为模块和子模块，并努力将这些项目中的每一个设置为在同一命名空间中相互独立运行。

我们最终将使用内部 PyPi 服务器，将这些包提供给我们的内部网络，并且不想将它们与外部(公共(public))PyPi 包混淆。

示例:我有 2 个模块，我希望能够执行以下操作:

from org.client.client1 import mod1
from org.common import config

反射的模块将被分开:

存储库 1:

org_client_client1_mod1/
  setup.py
  mod1/
    __init__.py
    somefile.py

存储库 2:

org_common_config/
  setup.py
  config/
    __init__.py
    someotherfile.py

我的 Git 存储库已经设置为 org_client_client1_mod1 和 org_common_config，所以我只需要在打包和 __init__.py 上执行设置文件，我相信。

问题:

#1

With the __init__.py, which of these should I be using (if any)?:

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

Or:

import pkg_resources
pkg_resources.declare_namespace(__name__)

#2

With setup.py, do I still need to add the namespace_modules parameter, and if so, would I use namespace_modules=['org.common'], or namespace_modules=['org', 'common']?

#3

Could I forgo all of the above by just implementing this differently somehow? Perhaps something simpler or more "pythonic"?

最佳答案

聚会迟到了，但在 Python 中帮助其他旅行者沿着命名空间路径走下去永远不会受到伤害!

#1:

With the __init__.py, which of these should I be using (if any)?:

这取决于，列出的命名空间包有三种方法 here :

1. Use native namespace packages. This type of namespace package is defined in PEP 420 and is available in Python 3.3 and later. This is recommended if packages in your namespace only ever need to support Python 3 and installation via pip.

2. Use pkgutil-style namespace packages. This is recommended for new packages that need to support Python 2 and 3 and installation via both pip and python setup.py install.

3. Use pkg_resources-style namespace packages. This method is recommended if you need compatibility with packages already using this method or if your package needs to be zip-safe.

如果您使用#2 (pkgutil-style) 或#3 (pkg_resources-style)，那么您将不得不为 使用相应的样式__init__.py 文件。如果您使用 native 命名空间，则命名空间目录中没有 __init__.py。

#2:

With setup.py, do I still need to add the namespace_modules parameter, and if so, would I use namespace_modules=['org.common'], or namespace_modules=['org', 'common']?

如果您选择的命名空间包不是原生样式，那么是的，您将需要 setup() 中的 namespace_packages。

#3:

Could I forgo all of the above by just implementing this differently somehow? Perhaps something simpler or more "pythonic"?

由于您最终在 python 中遇到了一个复杂的主题，因此您似乎知道自己在做什么，想要什么，并确定创建 Python 命名空间包是实现它的方法。这将被视为解决问题的 Python 方法。

除了您的问题之外，我还发现了以下几点:

我读过 PEP420 , Python Packaging guide并花了很多时间了解命名空间包，我大致了解它是如何工作的。我阅读了几个答案here , here , here ，以及关于 SO 的这个线程 - 这里和 Git link 上的示例由 Rob 分享。

然而，我的问题是在我创建了我的包之后。由于所有说明和示例代码在 setuptools.setup(package=[]) 函数中明确列出了包，因此我的代码失败了。我的子包/目录不包括在内。深入挖掘，我发现 setuptools 有一个 find_namespace_package() 函数，它也有助于添加子包

编辑:

链接到 find_namespace_packages()(setuptools 版本高于 40.1.0):https://setuptools.readthedocs.io/en/latest/setuptools.html#find-namespace-packages

编辑(2019 年 8 月 9 日):

为了完成答案，让我也用一个例子来重构。

以下解决方案假设 Python 3.3+ 支持隐式命名空间包

由于您正在寻找适用于 Python 版本 3.5 或更高版本的解决方案，让我们使用提供的代码示例并进一步详细说明。

假设如下:

命名空间/Python 包名:org

分发包:org_client、org_common

Python:3.3+

设置工具:40.1.0

为您执行以下操作

from org.client.client1 import mod1
from org.common import config

并保持您的顶级目录相同，即。 org_client_client1_mod1 和 org_common_config，您可以将结构更改为以下内容

存储库 1:

org_client_client1_mod1/
  setup.py
  org/
    client/
      client1/
        __init__.py
        submod1/
          __init__.py
        mod1/
          __init__.py
          somefile.py
        file1.py

更新了 setup.py

from setuptools import find_namespace_packages, setup
setup(
    name="org_client",
    ...
    packages=find_namespace_packages(), # Follows similar lookup as find_packages()
    ...
)

存储库 2:

org_common_config/
  setup.py
  org/
    common/
      __init__.py
      config/
        __init__.py
        someotherfile.py

更新了setup.py:

from setuptools import find_namespace_packages, setup
setup(
    name="org_common",
    ...
    packages=find_namespace_packages(), # Follows similar lookup as find_packages()
    ...
)

安装(使用 pip):

(venv) $ pip3 install org_common_config/
(venv) $ pip3 install org_client_client1_mod1/

更新的点子列表将显示以下内容:

(venv) $ pip3 list
...
org_client
org_common
...

但它们是不可导入的，要导入你必须遵循 org.client 和 org.common 表示法。

要了解原因，您可以在此处浏览(假设在 venv 内部):

(venv) $ cd venv/lib/python3.5/site-packages/
(venv) $ ls -l | grep org

您会看到没有 org_client 或 org_common 目录，它们被解释为命名空间包。

(venv) $ cd venv/lib/python3.5/site-packages/org/
(venv) $ ls -l
client/
common/
...

关于Python3 中的 Python 命名空间包，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/41621131/