Używanie __init__.py

Question

Używam __init__.py do uruchamiania czeków, gdy robię from myprojects.something import blabla.

Dzisiaj zacząłem używać pyzmq i chciałem zobaczyć, co dzieje się za kulisami. Przeglądałem kod w github i znalazłem (dla mnie) dziwne użycie __init__.py, którego nie potrafię sobie wytłumaczyć.

Na przykład zmq/core/__init__.py. Jaki jest sens dodania wartości zmq.core.__all__ o wartości zmq.core.constants, zmq.core.error, zmq.core.message, etc.?

W zmq/__init__.py widzę na końcu

__all__ = ['get_includes'] + core.__all__ 

gdzie get_includes jest funkcją, która w zasadzie zwraca listę z katalogu modułu i katalogu utils w katalogu nadrzędnego.

Jaki jest sens? Co osiągnięto, osiągając __init.py__?

Answer 1

Numer __all__ dotyczy sytuacji, gdy ktoś wykonuje from module import * jako dokumentację here.

Jedynym rozwiązaniem jest podanie przez autora pakietu jawnego indeksu pakietu. Instrukcja importu używa następującej konwencji : jeśli kod pakietu __init__.py definiuje listę o nazwie __all__, przyjmuje się, że jest to lista nazw modułów, które powinny zostać zaimportowane, gdy napotkany zostanie import pakietu *. Od autora pakietu do aktualizowanie tej listy jest możliwe po opublikowaniu nowej wersji pakietu . Autorzy pakietów mogą również zdecydować o nieobsługiwaniu tego, jeśli nie zobaczą zastosowania do importowania * z ich pakietu. Dla przykład plik sounds/effects/__init__.py mogłyby zawierać następujący kod:

__all__ = ["echo", "surround", "reverse"] 

oznaczałoby to, że from sound.effects import * będzie importować trzy nazwane submodules pakietu dźwięku.

Jedno użycie dla __all__ to narzędzie dla twórców pakietów, które pozwala im na zorganizowanie pakietu w sposób, który działa na ich korzyść, zapewniając wygodę użytkownikom. W szczególności w przypadku pyzmq, pozwala pisać kod, takich jak:

import zmq 
print zmq.zmq_version() 

Zamiast korzystać z pełnej przerywaną nazwę modułu:

print zmq.core.version.zmq_version() 

Pakiet projektanci pyzmq korzystania __all__ promowanie elementy przestrzeni nazw z zagnieżdżonych modułów do najwyższego poziomu ich przestrzeni nazw, aby użytkownik nie przejmował się strukturą pakietu.