Jak utworzyć pakiet przestrzeni nazw w Pythonie?

W Pythonie pakiet przestrzeni nazw umożliwia rozpowszechnianie kodu Pythona między kilkoma projektami. Jest to przydatne, gdy chcesz zwolnić powiązane biblioteki jako osobne pliki do pobrania. Na przykład, w katalogach Package-1i Package-2na PYTHONPATH,

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

użytkownik końcowy może import namespace.module1i import namespace.module2.

Jaki jest najlepszy sposób zdefiniowania pakietu przestrzeni nazw, aby więcej niż jeden produkt Pythona mógł definiować moduły w tej przestrzeni nazw?

TL; DR:

W Pythonie 3.3 nie musisz nic robić, po prostu nie umieszczaj żadnych __init__.pyw katalogach pakietów przestrzeni nazw i po prostu zadziała. W wersjach wcześniejszych niż 3.3 wybierz pkgutil.extend_path()rozwiązanie zamiast tego pkg_resources.declare_namespace(), ponieważ jest przyszłościowe i już jest zgodne z niejawnymi pakietami przestrzeni nazw.

Python 3.3 wprowadza niejawne pakiety przestrzeni nazw, zobacz PEP 420 .

Oznacza to, że istnieją teraz trzy typy obiektów, które można utworzyć za pomocą import foo:

• Moduł reprezentowany przez foo.pyplik
• Zwykły pakiet reprezentowany przez katalog foozawierający __init__.pyplik
• Pakiet przestrzeni nazw, reprezentowany przez jeden lub więcej katalogów foobez żadnych __init__.pyplików

Pakiety też są modułami, ale mam tu na myśli „moduł nie będący pakietem”, kiedy mówię „moduł”.

Najpierw skanuje w sys.pathposzukiwaniu modułu lub zwykłego pakietu. Jeśli się powiedzie, zatrzymuje wyszukiwanie i tworzy oraz inicjalizuje moduł lub pakiet. Jeśli nie znalazł modułu lub zwykłego pakietu, ale znalazł przynajmniej jeden katalog, tworzy i inicjalizuje pakiet przestrzeni nazw.

Moduły i zwykłe pakiety mają __file__ustawiony .pyplik, z którego zostały utworzone. Pakiety zwykłe iz przestrzeni nazw __path__ustawiły katalog lub katalogi, z których zostały utworzone.

Kiedy to zrobisz import foo.bar, powyższe wyszukiwanie odbywa się najpierw dla foo, a następnie, jeśli pakiet został znaleziony, wyszukiwanie barjest wykonywane foo.__path__za pomocą ścieżki wyszukiwania zamiast sys.path. Jeśli foo.barzostanie znaleziony, fooi foo.barsą tworzone i inicjalizowane.

Jak więc mieszają się zwykłe pakiety i pakiety przestrzeni nazw? Zwykle tak nie jest, ale stara pkgutiljawna metoda pakietu przestrzeni nazw została rozszerzona o niejawne pakiety przestrzeni nazw.

Jeśli masz istniejący zwykły pakiet, który ma taki __init__.pywygląd:

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

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

Możesz więc 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 obaj __init__.pymają extend_pathlinie (i path1, path2i path3są w twoim sys.path) import package.foo, import package.bari import package.bazwszystko będzie działać.

pkg_resources.declare_namespace(__name__) nie został zaktualizowany w celu uwzględnienia niejawnych pakietów przestrzeni nazw.

Istnieje standardowy moduł o nazwie pkgutil , za pomocą którego można „dołączać” moduły do ​​danej przestrzeni nazw.

Dzięki podanej strukturze katalogów:

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

Powinieneś umieścić te dwie linie w obu Package-1/namespace/__init__.py i Package-2/namespace/__init__.py(*):

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

(* ponieważ - jeśli nie określisz zależności między nimi - nie wiesz, które z nich zostaną rozpoznane jako pierwsze - zobacz PEP 420, aby uzyskać więcej informacji)

Jako dokumentacja mówi :

To doda do pakietu __path__wszystkie podkatalogi katalogów wsys.path nazwanych tak jak pakiet.

Od teraz powinieneś móc dystrybuować te dwa pakiety niezależnie.

Ta sekcja powinna być dość oczywista.

Krótko mówiąc, umieść kod przestrzeni nazw __init__.py, zaktualizuj, setup.pyaby zadeklarować przestrzeń nazw i możesz zaczynać.

To stare pytanie, ale ktoś niedawno skomentował na moim blogu, że mój post dotyczący pakietów przestrzeni nazw jest nadal aktualny, więc pomyślałem, że umieściłbym do niego link, ponieważ zawiera praktyczny przykład, jak to zrobić:

https://web.archive.org/web/20150425043954/http://cdent.tumblr.com/post/216241761/python-namespace-packages-for-tiddlyweb

To prowadzi do tego artykułu, aby poznać główne aspekty tego, co się dzieje:

http://www.siafoo.net/article/77#multiple-distributions-one-virtual-package

__import__("pkg_resources").declare_namespace(__name__)Trik jest dość dużo napędza zarządzania wtyczek w TiddlyWeb i do tej pory wydaje się być obecnie pracuje.

Masz koncepcje przestrzeni nazw Pythona od początku do końca, w Pythonie nie jest możliwe umieszczanie pakietów w modułach. Pakiety zawierają moduły, a nie na odwrót.

Pakiet Pythona to po prostu folder zawierający __init__.pyplik. Moduł to dowolny inny plik w pakiecie (lub bezpośrednio w PYTHONPATH), który ma .pyrozszerzenie. W twoim przykładzie masz dwa pakiety, ale nie zdefiniowano żadnych modułów. Jeśli weźmiesz pod uwagę, że pakiet to folder systemu plików, a moduł to plik, zobaczysz, dlaczego pakiety zawierają moduły, a nie na odwrót.

W twoim przykładzie zakładając, że Package-1 i Package-2 są folderami w systemie plików, które umieściłeś w ścieżce Pythona, możesz mieć następujące rzeczy:

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

Masz teraz jeden pakiet namespacez dwoma modułami module1i module2. i jeśli nie masz dobrego powodu, prawdopodobnie powinieneś umieścić moduły w folderze i mieć tylko to na ścieżce Pythona, jak poniżej:

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