Verwendung von __init__.py

Question

Ich verwende __init__.py, um Prüfungen durchzuführen, wenn ich from myprojects.something import blabla mache.

Heute begann ich mit pyzmq und ich wollte sehen, was hinter den Kulissen vor sich geht. Also habe ich den Code in GitHub durchsucht und finde (für mich) eine seltsame Verwendung von __init__.py dort, die ich mir nicht erklären kann.

Zum Beispiel zmq/core/__init__.py. Was ist der Sinn der zmq.core.__all__zmq.core.constants, zmq.core.error, zmq.core.message, etc.?

In zmq/__init__.py sehe ich am Ende

__all__ = ['get_includes'] + core.__all__ 

wo get_includes eine Funktion ist, die im Grunde eine Liste mit dem Verzeichnis des Moduls zurückgibt und Verzeichnis UTILS in das übergeordnete Verzeichnis.

Was ist der Sinn davon? Was hat __init.py__ dadurch erreicht?

Answer 1

Die __all__ ist für wenn jemand from module import * wie dokumentiert here.

Die einzige Lösung ist, dass der Paketautor einen expliziten Index des Pakets bereitstellt. Die Importanweisung verwendet die folgende -Konvention: Wenn der Code __init__.py eines Pakets eine Liste mit dem Namen __all__ definiert, wird dies als Liste der Modulnamen betrachtet, die importiert werden sollen, wenn der Paketimport * auftritt. Es liegt an dem Paketautor , diese Liste auf dem neuesten Stand zu halten, wenn eine neue Version des -Pakets veröffentlicht wird. Paketautoren können sich auch entschließen, nicht zu unterstützen, wenn sie keine Verwendung zum Importieren von * aus ihrem Paket sehen. Für Beispiel könnte die Datei sounds/effects/__init__.py enthalten den folgenden Code:

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

Dies würde bedeuten, dass from sound.effects import * die drei genannten Submodule des Sound-Paket importieren würde.

Eine Verwendung für __all__ ist ein Werkzeug für die Paket-Builder, damit sie ihr Paket in einer Weise zu strukturieren, die für sie arbeitet, während es für die Benutzer bequemer zu machen. Insbesondere im Fall von pyzmq, es kann Sie Code schreiben, wie zum Beispiel:

import zmq 
print zmq.zmq_version() 

Anstatt die vollen gepunkteten Modulnamen zu verwenden:

print zmq.core.version.zmq_version() 

Das Paket Designer von pyzmq __all__ verwenden zu fördern Namespace-Elemente von verschachtelten Modulen bis zur obersten Ebene ihres Namespace, so dass der Benutzer nicht von der Struktur seines Pakets gestört wird.