プロジェクト間モジュール共有のための名前空間パッケージの定義

Python では、名前空間パッケージは、複数のプロジェクトにわたって関連するコードを構造化する手段を提供します。名前空間パッケージを定義するには、名前空間パッケージ ディレクトリ内に __init__.py ファイルを配置しないようにすることが重要です。

名前空間パッケージの進化

Python 3.3 より前では、名前空間パッケージが必要でしたpkgutil.extend_path() または pkg_resources.declare_namespace() を使用した明示的な宣言。ただし、Python 3.3 以降では、暗黙的な名前空間パッケージが導入され、宣言なしでシームレスに作成できるようになりました。

通常のパッケージとの相互作用

名前空間パッケージは通常のパッケージと共存できます、階層構造が可能になります。名前空間パッケージ内のモジュールをインポートする場合、Python は親パッケージの path 内を検索し、標準の sys.path.

pkgutil.extend_path() を超えて検索を拡張します。 pkg_resources.declare_namespace()

以前は pkgutil.extend_path() と pkg_resources.declare_namespace() の両方が名前空間パッケージの定義に使用されていましたが、暗黙的な名前空間パッケージとの将来の互換性のために前者が推奨されます。 .

構造例

次のディレクトリ構造を考えてみましょう:

Package-1/namespace/
Package-2/namespace/
├── path1
│  └── package
│     ├── __init__.py
│     └── foo.py
├── path2
│  └── package
│     └── bar.py
└── path3
    └── package
        ├── __init__.py
        └── baz.py

__init__.py ファイル内で必要な extend_path 宣言を使用すると、namespace.foo、namespace.bar、namespace.baz などのインポートはすべて成功します。