A quoi sert __init__.py ?

Question

Qu'est-ce que __init__.py dans un répertoire de sources Python ?

Answer 1

Il s'agissait autrefois d'une partie obligatoire d'un paquet ( ancien, pré-3.3 "paquet normal". pas newer 3.3+ "namespace package" (paquet de noms) ).

Voici la documentation.

Python définit deux types de paquets, les paquets réguliers et les paquets d'espace de noms. Les paquets réguliers sont des paquets traditionnels tels qu'ils existaient dans Python 3.2 et antérieurs. Un paquet régulier est typiquement implémenté comme un répertoire contenant un fichier __init__.py dossier. Lorsqu'un paquet régulier est importé, ce __init__.py est implicitement exécuté, et les objets qu'il définit sont liés à des noms dans l'espace de noms du paquet. Le site __init__.py peut contenir le même code Python que n'importe quel autre module, et Python ajoutera quelques attributs supplémentaires au module lors de son importation.

Mais il suffit de cliquer sur le lien, il contient un exemple, plus d'informations, et une explication des paquets de l'espace de nom, le genre de paquets sans __init__.py .

Answer 2

Fichiers nommés __init__.py sont utilisés pour marquer les répertoires sur le disque comme des répertoires de paquets Python. Si vous avez les fichiers

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

y mydir est sur votre chemin, vous pouvez importer le code en module.py comme

import spam.module

ou

from spam import module

Si vous retirez le __init__.py Python ne recherchera plus les sous-modules dans ce répertoire, et les tentatives d'importation du module échoueront.

Le site __init__.py est généralement vide, mais peut être utilisé pour exporter certaines parties du paquetage sous un nom plus pratique, contenir des fonctions pratiques, etc. Dans l'exemple ci-dessus, le contenu du module init est accessible comme suit

import spam

sur la base de este

Answer 3

En plus d'étiqueter un répertoire en tant que paquetage Python et de définir les éléments suivants __all__ , __init__.py vous permet de définir n'importe quelle variable au niveau du paquet. Cela est souvent pratique si un paquet définit quelque chose qui sera importé fréquemment, à la manière d'une API. Ce modèle favorise l'adhésion à la philosophie pythonique "flat is better than nested".

Un exemple

Voici un exemple tiré d'un de mes projets, dans lequel j'importe fréquemment une sessionmaker appelé Session pour interagir avec ma base de données. J'ai écrit un paquet "base de données" avec quelques modules :

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

Mon __init__.py contient le code suivant :

import os

from sqlalchemy.orm import sessionmaker
from sqlalchemy import create_engine

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

Puisque je définis Session ici, je peux démarrer une nouvelle session en utilisant la syntaxe ci-dessous. Ce code serait le même exécuté à l'intérieur ou à l'extérieur du répertoire du paquet "database".

from database import Session
session = Session()

Bien sûr, c'est une petite commodité -- l'alternative serait de définir Session dans un nouveau fichier comme "create_session.py" dans mon paquetage de base de données, et démarrer de nouvelles sessions en utilisant :

from database.create_session import Session
session = Session()

Autres lectures

Il y a un fil de discussion intéressant sur reddit qui couvre les utilisations appropriées de __init__.py ici :

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

L'opinion majoritaire semble être que __init__.py Les fichiers doivent être très fins pour éviter de violer la philosophie "l'explicite vaut mieux que l'implicite".

Answer 4

Le site __init__.py fait que Python traite les répertoires qui le contiennent comme des modules.

En outre, il s'agit du premier fichier à être chargé dans un module, vous pouvez donc l'utiliser pour exécuter le code que vous souhaitez voir s'exécuter à chaque fois qu'un module est chargé, ou pour spécifier les sous-modules à exporter.

Answer 5

En Python, la définition d'un paquet est très simple. Comme en Java, la structure hiérarchique et la structure des répertoires sont les mêmes. Mais vous devez avoir __init__.py dans un paquet. Je vais expliquer le __init__.py avec l'exemple ci-dessous :

package_x/
|--  __init__.py
|--    subPackage_a/
|------  __init__.py
|------  module_m1.py
|--    subPackage_b/
|------  __init__.py
|------  module_n1.py
|------  module_n2.py
|------  module_n3.py

__init__.py peut être vide, tant qu'elle existe. Il indique que le répertoire doit être considéré comme un paquet. Bien sûr, __init__.py peut également définir le contenu approprié.

Si nous ajoutons une fonction dans le module_n1 :

def function_X():
    print "function_X in module_n1"
    return

Après avoir couru :

>>>from package_x.subPackage_b.module_n1 import function_X
>>>function_X()

function_X in module_n1 

Ensuite, nous avons suivi le paquet hiérarchique et appelé la fonction module_n1. Nous pouvons utiliser __init__.py dans le sous-paquet_b comme ceci :

__all__ = ['module_n2', 'module_n3']

Après avoir couru :

>>>from package_x.subPackage_b import * 
>>>module_n1.function_X()

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named module_n1

Par conséquent, en utilisant * l'importation, le paquet de module est soumis à __init__.py contenu.