Wie schreibe ich gute / korrekte Paketdateien __init__.py?

Mein Paket hat folgende Struktur:

mobilescouter/
    __init__.py #1
    mapper/
        __init__.py  #2
        lxml/
            __init__.py #3
            vehiclemapper.py
            vehiclefeaturemapper.py
            vehiclefeaturesetmapper.py
        ...
        basemapper.py
   vehicle/
        __init__.py #4
        vehicle.py
        vehiclefeature.py
        vehiclefeaturemapper.py
   ...

Ich bin nicht sicher, wie die __init__.pyDateien richtig geschrieben werden sollen.
Das __init__.py #1sieht aus wie:

__all__ = ['mapper', 'vehicle']
import mapper
import vehicle

Aber wie soll das zum Beispiel __init__.py #2aussehen? Meins ist:

__all__ = ['basemapper', 'lxml']
from basemaper import *
import lxml

Wann sollte __all__verwendet werden?

__all__ ist sehr gut - es hilft beim Importieren von Anweisungen, ohne Module automatisch zu importieren http://docs.python.org/tutorial/modules.html#importing-from-a-package

Verwenden __all__und import *ist nur redundant__all__ benötigt

Ich glaube , einer der stärksten Gründe für den Einsatz import *in einem __init__.pyzu Importpaket in der Lage sein , einen Skript Refactoring , die in mehrere Skripte , ohne zu brechen eine bestehende Anwendung gewachsen ist. Aber wenn Sie von Anfang an ein Paket entwerfen. Ich denke, es ist am besten, __init__.pyDateien leer zu lassen.

beispielsweise:

foo.py - contains classes related to foo such as fooFactory, tallFoo, shortFoo

dann wächst die App und jetzt ist es ein ganzer Ordner

foo/
    __init__.py
    foofactories.py
    tallFoos.py
    shortfoos.py
    mediumfoos.py
    santaslittlehelperfoo.py
    superawsomefoo.py
    anotherfoo.py

dann kann das init-Skript sagen

__all__ = ['foofactories', 'tallFoos', 'shortfoos', 'medumfoos',
           'santaslittlehelperfoo', 'superawsomefoo', 'anotherfoo']
# deprecated to keep older scripts who import this from breaking
from foo.foofactories import fooFactory
from foo.tallfoos import tallFoo
from foo.shortfoos import shortFoo

Damit ein Skript, das für Folgendes geschrieben wurde, während der Änderung nicht unterbrochen wird:

from foo import fooFactory, tallFoo, shortFoo

Meine eigenen __init__.pyDateien sind meistens leer. Insbesondere habe ich nie einen from blah import *Teil von __init__.py- wenn "Importieren des Pakets" bedeutet, dass alle Arten von Klassen, Funktionen usw. direkt als Teil des Pakets definiert werden, würde ich stattdessen den Inhalt von lexikalisch blah.pyin das Paket kopieren __init__.pyund entfernen blah.py( Die Multiplikation von Quelldateien nützt hier nichts.

Wenn Sie darauf bestehen, die import *Redewendungen (eek) zu unterstützen, kann die Verwendung __all__(mit einer möglichst winzigen Liste von Namen, die Sie selbst verwenden können) zur Schadensbegrenzung hilfreich sein. Im Allgemeinen sind Namespaces und explizite Importe gute Dinge, und ich empfehle dringend, jeden Ansatz zu überdenken, der auf der systematischen Umgehung eines oder beider Konzepte basiert! -)

Sie __init__.pysollten einen Docstring haben .

Obwohl alle Funktionen in Modulen und Unterpaketen implementiert sind, können Sie in Ihrem Paket docstring dokumentieren, wo Sie beginnen sollen. Betrachten Sie beispielsweise das Python- emailPaket . Die Paketdokumentation ist eine Einführung, die den Zweck, den Hintergrund und die Zusammenarbeit der verschiedenen Komponenten im Paket beschreibt. Wenn Sie automatisch Dokumentation aus Docstrings mit Sphinx oder einem anderen Paket generieren, ist das Paket Docstring genau der richtige Ort, um eine solche Einführung zu beschreiben.

Weitere Informationen finden Sie in den hervorragenden Antworten von Firecrow und Alex Martelli .