Comment créer un paquet namespace en Python?

TL; DR:

sur Python 3.3 vous n'avez rien à faire, il suffit de ne pas mettre de __init__.py dans vos répertoires package namespace et cela fonctionnera. Sur pre-3.3, choisissez la solution pkgutil.extend_path() plutôt que la solution pkg_resources.declare_namespace() , car elle est à l'épreuve du futur et déjà compatible avec les paquets d'espaces de noms implicites.

---

Python introduit les paquets d'espaces de noms implicites, voir PEP 420 .

cela signifie qu'il y a maintenant trois types d'objets qui peuvent être créés par un import foo :

• module représenté par un foo.py fichier
• un paquet régulier, représenté par un répertoire foo contenant un __init__.py fichier
• un paquet namespace, représenté par un ou plusieurs répertoires foo sans aucun __init__.py fichiers

Les paquets

sont aussi des modules, mais ici je veux dire" module non-package "quand je dis"module".

tout d'abord, il scanne sys.path pour un module ou un paquet régulier. S'il réussit, il arrête la recherche et crée et initalise le module ou le paquet. S'il n'a trouvé aucun module ou paquet régulier, mais qu'il a trouvé au moins un répertoire, il crée et initialise un paquet namespace.

les Modules et les paquets réguliers ont __file__ .py fichier à partir duquel ils ont été créés. Les paquets réguliers et namespace ont __path__ placé dans le répertoire ou les répertoires à partir desquels ils ont été créés.

quand vous faites import foo.bar , la recherche ci-dessus se fait d'abord pour foo , puis si un paquet a été trouvé, la recherche pour bar se fait avec foo.__path__ comme le chemin de recherche au lieu de sys.path . Si foo.bar , foo et foo.bar sont créés et initialisés.

alors comment les paquets réguliers et les paquets namespace se mélangent-ils? Normalement ils ne le font pas, mais l'ancienne méthode de paquet de namespace explicite pkgutil a été étendue pour inclure les paquets de namespace implicites.

si vous avez un paquet régulier existant qui a un __init__.py comme ceci:

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

... le comportement d'héritage est d'ajouter n'importe quel autre régulier paquets sur le chemin cherché à son __path__ . Mais dans Python 3.3, il ajoute aussi des paquets namespace.

ainsi vous pouvez avoir la structure de répertoire suivante:

├── path1
│   └── package
│       ├── __init__.py
│       └── foo.py
├── path2
│   └── package
│       └── bar.py
└── path3
    └── package
        ├── __init__.py
        └── baz.py

... et aussi longtemps que les deux __init__.py ont le extend_path et path1 , path2 et path3 sont dans votre sys.path ) import package.foo , import package.bar et import package.baz .

pkg_resources.declare_namespace(__name__) n'a pas été mis à jour pour inclure les paquets d'espace de noms implicites.