Wofür ist __init__.py da?

Question

Was ist __init__.py für in einem Python-Quellverzeichnis?

Answer 1

Früher war es ein obligatorischer Bestandteil eines Pakets ( altes, vor 3.3 erstelltes "normales Paket" no neueres 3.3+ "Namensraum-Paket" ).

Hier ist die Dokumentation.

Python definiert zwei Arten von Paketen, reguläre Pakete und Namespace-Pakete. Reguläre Pakete sind traditionelle Pakete, wie sie in Python 3.2 und früher existierten. Ein reguläres Paket ist typischerweise als ein Verzeichnis implementiert, das eine __init__.py Datei. Wenn ein reguläres Paket importiert wird, wird diese __init__.py Datei wird implizit ausgeführt, und die darin definierten Objekte werden an Namen im Namensraum des Pakets gebunden. Die __init__.py Datei kann den gleichen Python-Code enthalten wie jedes andere Modul auch, und Python fügt dem Modul beim Import einige zusätzliche Attribute hinzu.

Aber klicken Sie einfach auf den Link, er enthält ein Beispiel, weitere Informationen und eine Erklärung von Namespace-Paketen, der Art von Paketen ohne __init__.py .

Answer 2

Dateien mit dem Namen __init__.py werden verwendet, um Verzeichnisse auf der Festplatte als Python-Paketverzeichnisse zu markieren. Wenn Sie die Dateien

mydir/spam/__init__.py
mydir/spam/module.py

y mydir auf Ihrem Pfad ist, können Sie den Code in module.py als

import spam.module

o

from spam import module

Wenn Sie die __init__.py Datei, sucht Python nicht mehr nach Untermodulen in diesem Verzeichnis, so dass Versuche, das Modul zu importieren, fehlschlagen.

Le site __init__.py ist in der Regel leer, kann aber verwendet werden, um ausgewählte Teile des Pakets unter einem passenderen Namen zu exportieren, Komfortfunktionen zu enthalten usw. Im obigen Beispiel kann auf den Inhalt des init-Moduls wie folgt zugegriffen werden

import spam

auf Grund ce

Answer 3

Neben der Kennzeichnung eines Verzeichnisses als Python-Paket und der Definition von __all__ , __init__.py ermöglicht es Ihnen, jede Variable auf Paketebene zu definieren. Dies ist oft praktisch, wenn ein Paket etwas definiert, das häufig importiert wird, ähnlich wie eine API. Dieses Muster fördert die Einhaltung der Pythonic "flach ist besser als verschachtelt" Philosophie.

Ein Beispiel

Hier ein Beispiel aus einem meiner Projekte, bei dem ich häufig eine sessionmaker genannt. Session um mit meiner Datenbank zu interagieren. Ich habe ein "Datenbank"-Paket mit ein paar Modulen geschrieben:

database/
    __init__.py
    schema.py
    insertions.py
    queries.py

Meine __init__.py enthält den folgenden Code:

import os

from sqlalchemy.orm import sessionmaker
from sqlalchemy import create_engine

engine = create_engine(os.environ['DATABASE_URL'])
Session = sessionmaker(bind=engine)

Da ich definiere Session Hier kann ich eine neue Sitzung mit der folgenden Syntax starten. Dieser Code würde sowohl innerhalb als auch außerhalb des Paketverzeichnisses "database" ausgeführt werden.

from database import Session
session = Session()

Natürlich ist dies eine kleine Erleichterung - die Alternative wäre die Definition von Session in einer neuen Datei wie "create_session.py" in meinem Datenbankpaket, und starten Sie neue Sitzungen mit:

from database.create_session import Session
session = Session()

Weitere Lektüre

Es gibt einen ziemlich interessanten reddit-Thread über die angemessene Verwendung von __init__.py hier:

http://www.reddit.com/r/Python/comments/1bbbwk/whats_your_opinion_on_what_to_include_in_init_py/

Die Mehrheitsmeinung scheint zu sein, dass __init__.py Dateien sollten sehr dünn sein, um nicht gegen die Philosophie "explizit ist besser als implizit" zu verstoßen.

Answer 4

Es gibt 2 Hauptgründe für __init__.py

1. Der Einfachheit halber: Die anderen Benutzer müssen nicht wissen, wo genau sich Ihre Funktionen in Ihrer Pakethierarchie befinden ( Dokumentation ).

   your_package/
     __init__.py
     file1.py
     file2.py
       ...
     fileN.py
   
   # in __init__.py
   from file1 import *
   from file2 import *
   ...
   from fileN import *
   
   # in file1.py
   def add():
       pass

   dann können andere add() aufrufen, indem sie

    from your_package import add

   ohne file1 zu kennen, wie

    from your_package.file1 import add

2. Wenn etwas initialisiert werden soll, z. B. die Protokollierung (die auf der obersten Ebene erfolgen sollte):

    import logging.config
    logging.config.dictConfig(Your_logging_config)

Answer 5

Le site __init__.py Datei bewirkt, dass Python Verzeichnisse, die sie enthalten, als Module behandelt.

Außerdem ist dies die erste Datei, die in einem Modul geladen wird. Sie können sie also verwenden, um Code auszuführen, der bei jedem Laden eines Moduls ausgeführt werden soll, oder um die zu exportierenden Untermodule anzugeben.