一尘不染

如何在Python中创建名称空间包?

python

在Python中,命名空间包可让你在多个项目中传播Python代码。当你要将相关的库作为单独的下载发布时,这很有用。例如,目录Package-1Package-2中PYTHONPATH

Package-1/namespace/__init__.py
Package-1/namespace/module1/__init__.py
Package-2/namespace/__init__.py
Package-2/namespace/module2/__init__.py

最终用户可以import namespace.module1import namespace.module2

定义名称空间包的最佳方法是什么,以便多个Python产品可以在该名称空间中定义模块?


阅读 554

收藏
2020-02-22

共1个答案

一尘不染

TL; DR:

在Python 3.3上,你无需执行任何操作,只需将任何内容都不放在__init__.py名称空间包目录中即可使用。在3.3之前的版本中,请选择一种pkgutil.extend_path()解决方案pkg_resources.declare_namespace(),因为它是面向未来的并且已经与隐式名称空间包兼容。

Python 3.3引入了隐式名称空间包,请参阅PEP 420。

这意味着一个对象现在可以创建三种类型的对象import foo:

  • foo.py文件代表的模块
  • 常规软件包,由foo包含__init__.py文件的目录表示
  • 一个名称空间包,由一个或多个目录表示,foo没有任何__init__.py文件

包也是模块,但是当我说“模块”时,我的意思是“非包模块”。

首先,它扫描sys.path模块或常规软件包。如果成功,它将停止搜索并创建并初始化模块或程序包。如果没有找到模块或常规包,但是找到了至少一个目录,它将创建并初始化一个名称空间包。

模块和常规软件包已__file__设置.py为创建它们的文件。常规和名称空间包已__path__设置为创建它们的目录。

完成后import foo.bar,将首先针对进行上述搜索foo,然后如果找到了软件包,bar则使用foo.__path__搜索路径而不是进行搜索sys.path。如果foo.bar找到,foo并foo.bar创建和初始化。

那么常规包和名称空间包如何混合?通常它们不会,但是旧的pkgutil显式名称空间包方法已扩展为包括隐式名称空间包。

如果你已有这样的常规软件包__init__.py:

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

…遗留行为是在搜索到的路径中将其他任何常规软件包添加到其__path__。但是在Python 3.3中,它也添加了名称空间包。

因此,你可以具有以下目录结构:

├── path1
│   └── package
│       ├── __init__.py
│       └── foo.py
├── path2
│   └── package
│       └── bar.py
└── path3
    └── package
        ├── __init__.py
        └── baz.py

......只要两个__init__.py有extend_path行(和path1,path2并path3在你的sys.path)import package.foo,import package.bar并且import package.baz将所有的工作。

pkg_resources.declare_namespace(__name__) 尚未更新为包括隐式名称空间包。

2020-02-22