Jak utworzyć pakiet przestrzeni nazw w Pythonie?

TL; DR:

W Pythonie 3.3 nie musisz nic robić, po prostu nie umieszczaj żadnych __init__.py w swoich katalogach pakietów przestrzeni nazw, a to po prostu zadziała. W wersji pre-3.3 Wybierz rozwiązanie pkgutil.extend_path() zamiast pkg_resources.declare_namespace(), ponieważ jest przyszłościowe i jest już kompatybilne z domyślnymi pakietami przestrzeni nazw.

Python 3.3 wprowadza Ukryte Pakiety przestrzeni nazw, zobacz PEP 420 .

Oznacza to, że obecnie istnieją trzy typy obiektów, które mogą być tworzone przez import foo:

• moduł reprezentowany przez plik foo.py
• zwykły pakiet, reprezentowany przez katalog foo zawierający plik __init__.py
• pakiet przestrzeni nazw reprezentowany przez jeden lub więcej katalogów foo bez żadnych plików __init__.py

Pakiety też są modułami, ale tutaj mam na myśli " non-package module "Kiedy mówię"module".

Najpierw skanuje sys.path W poszukiwaniu modułu lub zwykłego pakietu. Jeśli się powiedzie, przestaje wyszukiwać i tworzy i initalizuje moduł lub paczka. Jeśli nie znalazł żadnego modułu lub zwykłego pakietu, ale znalazł przynajmniej jeden katalog, tworzy i inicjalizuje pakiet przestrzeni nazw.

Moduły i zwykłe pakiety mają {[12] } ustawiony na .py Plik, z którego zostały utworzone. Pakiety zwykłe i przestrzenie nazw mają __path__ ustawione na katalog lub katalogi, z których zostały utworzone.

Kiedy wykonasz import foo.bar, powyższe wyszukiwanie odbywa się najpierw dla foo, Następnie jeśli pakiet został znaleziony, wyszukiwanie barodbywa się z foo.__path__ jako ścieżka wyszukiwania zamiast sys.path. Jeśli foo.bar zostanie znaleziony, foo i foo.bar zostaną utworzone i zainicjowane.

Więc jak zwykłe pakiety i przestrzenie nazw mieszają się? Zwykle tak nie jest, ale stara metoda jawnego pakietu przestrzeni nazw pkgutil została rozszerzona o domyślne Pakiety przestrzeni nazw.

Jeśli masz istniejący zwykły pakiet, który ma __init__.py w ten sposób:

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

... zachowanie starsze polega na dodaniu innych zwykłych pakietów na wyszukiwanej ścieżce do its __path__. Ale w Pythonie 3.3 dodaje również pakiety przestrzeni nazw.

Więc możesz mieć następującą strukturę katalogów:

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

... i tak długo, jak dwie __init__.py mają extend_path linie (i path1, path2 i path3 są w Twoim sys.path) import package.foo, import package.bar i wszystko będzie działać.

pkg_resources.declare_namespace(__name__) nie został zaktualizowany, aby zawierał Ukryte Pakiety przestrzeni nazw.