Discussion :

[Luke spywoker]

Salut les pythons,
après presque 4 ans de python je suis tomber sur un os:
écrire un fichier __init__.py pour un module ou package car il y a eu une erreur de jugement ma part et je n'ai jamais vue un auteur aborder le sujet dans un de mes bouquins.
car je pensais que ces fichiers été toujours vide symbolisant une sorte de balisage.
Puis j'ai attaquer le packaging (d'un de mes modules) et je me suis intéresser a distutils, a cet effet, et boom j'ai appris que ces fichiers ne sont nullement vierge mais servent, d'après ce que je sais a ce sujet pour l'instant, au packaging de fichier de code source de modules, notamment pour les directives d'import d'objet sous la forme:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

from mon_module import ma_classe

le seule truc que je sais et qui reste a préciser et que pour la formule d'import énoncer précédemment: ont peut écrire dans le fichier __init__.py correspondant :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

__all__=["ma_classe"]

mais j'ai regarder quelques fichiers __init__.py et ça n'a pas l'air facile.

Alors si vous voulez bien m'éclairer sur cette terre inconnus de mon être je serai ravis d'apprendre de part vos lumières:

-Que mettre dans un fichier __init__.py (code python) et comment ça marche (mécanisme sous-jacent) ?

Si vous avez l'esprit didactique vous pouvez, si vous le désirez bien, me faire un petit topo sinon toute information sous forme de lien, code, truc et astuces a connaître sont la bienvenue.

Merci pour vos réponses éclairant mon ignorance.

[deusyss]

Bonjour Luke,

Alors effectivement, quel que soit le livre (le mien y compris je crois), on indique que ce fichier est vide, pour simplifier les choses.*

Dans les faits, lorsqu'on importe un package contenant plusieurs module et/ou sous package, c'est systematiquement le code contenu dans ce fichier qui est exécuté.

Aussi il est important de bien le renseigner. Le plus simple est de faire un import de chacun de tes modules et sous-package. dans le __ini__ père. Si tu fais abstrction d'un seul de ces modules/packages, tu ne pourras pas y accéder.

Il est dans ce cas aussi extremement important de bien documenter les docstrings qui permettront d'obtenir de l'aide sur l'utilisation des diverses classes et fonctions.

Je me suis toujours limité à cela, et cela m'a toujours suffit jusqu'à présent. Il existe probablement d'autre façon de faire (notamment avec ton __all__) mais je ne peux te renseigner à ce sujet.

J'espère avoir été assez clair. SInon n'hesite pas a demander plus d'infos.

[PauseKawa]

Bonjour Luke,

Pour ce qui est du contenu d'un __init__.py tu peux par exemple y mettre un __version__, des imports dépendants ou encore __path__ pour les packages avec de multiples sous répertoires. etc...

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
__version__ = "0.1"
import sys
if sys.platform == 'linux':
	blablabla

Pour ce qui est de __all__ c'est la liste des noms importables. Si __all__ est défini dans l'__init__.py de m comme __all__ = ["m1", "m2"] un from m import m3 ne fonctionneras pas.
Un from m import * (non recommandé) importeras m1 et m2, même si nous avons m3, m4, m5...
Suivant le contenu d'un module l’absence d'un __all__ explicite peux amener au fait qu'une partie ne soit pas importable.

@+

[wiztricks]

Salut,

écrire un fichier __init__.py pour un module ou package car il y a eu une erreur de jugement ma part et je n'ai jamais vue un auteur aborder le sujet dans un de mes bouquins.

Les bouquins d'initiation permettent d’acquérir le b.a.ba qui vous permettra d’être plus confortable avec la lecture de la documentation officielle et des codes/applications écrites par d'autres ou les sources de Python. Ce b.a.ba est comparable a la maîtrise de la langue française lorsqu'on entre au collège. On sait des choses pour avancer, approfondir... mais rien de ce que nous devrions savoir pour écrire un roman.

Dans la documentation officielle, vous y trouvez un vrai tuto. qui s'adresse a ceux qui savent déjà programmer dans un autre langage.
__init__.py, __all__, packages y sont présentes ici.
Dans la documentation Python, __init__.py est couvert brièvement dans le chapitre sur les import.
Mais c'est une documentation technique et donc bien plus ardue qu'un tuto.
C'est assez bref mais "suffisant":

Python defines two types of packages, regular packages and namespace packages. Regular packages are traditional packages as they existed in Python 3.2 and earlier. A regular package is typically implemented as a directory containing an __init__.py file. When a regular package is imported, this __init__.py file is implicitly executed, and the objects it defines are bound to names in the package’s namespace. The __init__.py file can contain the same Python code that any other module can contain, and Python will add some additional attributes to the module when it is imported.

Que mettre dans un __init__.py? Ce script n'est exécute qu'au premier import d'un package.
Il sert a construire l'espace de nom du package, i.e. attributs et objets associes.
Vous avez des tas de cas d'utilisation dans le "/Lib" de Python:

• tkinter: __init__.py contient tout le package,
• logging: un singleton,
• ...

Comme c'est de la "programmation", la seule limite est votre imagination (et la revue de code si c'est dans le cadre d'un projet "a plusieurs").
Si vous voulez un truc qui décoiffe, allez voir étudier l'__init__ de werkzeug.

- W