¿Cómo creo un paquete de espacio de nombres en Python?

En Python, un paquete de espacio de nombres le permite distribuir el código de Python entre varios proyectos. Esto es útil cuando desea lanzar bibliotecas relacionadas como descargas separadas. Por ejemplo, con los directorios Package-1y Package-2en PYTHONPATH,

Package-1/namespace/__init__.py
Package-1/namespace/module1/__init__.py
Package-2/namespace/__init__.py
Package-2/namespace/module2/__init__.py

el usuario final puede import namespace.module1y import namespace.module2.

¿Cuál es la mejor manera de definir un paquete de espacio de nombres para que más de un producto Python pueda definir módulos en ese espacio de nombres?

TL; DR:

En Python 3.3 no tiene que hacer nada, simplemente no coloque ninguno __init__.pyen sus directorios de paquetes de espacio de nombres y simplemente funcionará. En pre-3.3, elija la pkgutil.extend_path()solución sobre la anterior pkg_resources.declare_namespace(), porque es a prueba de futuro y ya es compatible con paquetes de espacio de nombres implícitos.

Python 3.3 introduce paquetes de espacio de nombres implícitos, ver PEP 420 .

Esto significa que ahora hay tres tipos de objetos que pueden ser creados por un import foo:

• Un módulo representado por un foo.pyarchivo
• Un paquete normal, representado por un directorio que foocontiene un __init__.pyarchivo
• Un paquete de espacio de nombres, representado por uno o más directorios foosin ningún __init__.pyarchivo

Los paquetes también son módulos, pero aquí me refiero a "módulo sin paquete" cuando digo "módulo".

Primero busca sys.pathun módulo o paquete normal. Si tiene éxito, deja de buscar y crea e inicializa el módulo o paquete. Si no encontró ningún módulo o paquete normal, pero encontró al menos un directorio, crea e inicializa un paquete de espacio de nombres.

Los módulos y paquetes regulares se han __file__configurado en el .pyarchivo desde el que se crearon. Los paquetes regulares y de espacio de nombres se han __path__establecido en el directorio o directorios a partir de los cuales fueron creados.

Cuando lo haga import foo.bar, la búsqueda anterior se realiza primero foo, luego, si se encontró un paquete, la búsqueda barse realiza foo.__path__como la ruta de búsqueda en lugar de sys.path. Si foo.barse encuentra fooy foo.barse crea e inicializa.

Entonces, ¿cómo se mezclan los paquetes regulares y los paquetes de espacio de nombres? Normalmente no lo hacen, pero el antiguo pkgutilmétodo de paquete de espacio de nombres explícito se ha ampliado para incluir paquetes de espacio de nombres implícitos.

Si tiene un paquete regular existente que tiene un __init__.pyaspecto como este:

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

... el comportamiento heredado es agregar cualquier otro paquete regular en la ruta buscada __path__. Pero en Python 3.3, también agrega paquetes de espacio de nombres.

Para que pueda tener la siguiente estructura de directorios:

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

... y siempre y cuando los dos __init__.pytengan las extend_pathlíneas (y path1, path2y path3estén en su sys.path) import package.foo, import package.bary import package.baztodos funcionen.

pkg_resources.declare_namespace(__name__) no se ha actualizado para incluir paquetes de espacio de nombres implícitos.

Hay un módulo estándar, llamado pkgutil , con el que puede 'agregar' módulos a un espacio de nombres dado.

Con la estructura de directorios que ha proporcionado:

Package-1/namespace/__init__.py
Package-1/namespace/module1/__init__.py
Package-2/namespace/__init__.py
Package-2/namespace/module2/__init__.py

Debe poner esas dos líneas en ambos Package-1/namespace/__init__.pyy Package-2/namespace/__init__.py(*):

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

(* dado que, a menos que establezca una dependencia entre ellos, no sabe cuál de ellos se reconocerá primero; consulte PEP 420 para obtener más información)

Como dice la documentación :

Esto agregará a __path__todos los subdirectorios de directorios sys.pathdel paquete con el nombre del paquete.

A partir de ahora, debería poder distribuir esos dos paquetes de forma independiente.

Esta sección debería explicarse bastante por sí misma.

En resumen, ingrese el código del espacio de nombres __init__.py, actualícelo setup.pypara declarar un espacio de nombres y tendrá libertad para continuar.

Esta es una vieja pregunta, pero alguien comentó recientemente en mi blog que mi publicación sobre paquetes de espacios de nombres aún era relevante, por lo que pensé en vincularla aquí ya que proporciona un ejemplo práctico de cómo hacerlo:

https://web.archive.org/web/20150425043954/http://cdent.tumblr.com/post/216241761/python-namespace-packages-for-tiddlyweb

Eso enlaza a este artículo para conocer las principales agallas de lo que está sucediendo:

http://www.siafoo.net/article/77#multiple-distributions-one-virtual-package

El __import__("pkg_resources").declare_namespace(__name__)truco consiste en impulsar la administración de complementos en TiddlyWeb y hasta ahora parece estar funcionando.

Tiene sus conceptos de espacio de nombres de Python al frente, no es posible en python poner paquetes en módulos. Los paquetes contienen módulos, no al revés.

Un paquete de Python es simplemente una carpeta que contiene un __init__.pyarchivo. Un módulo es cualquier otro archivo en un paquete (o directamente en el PYTHONPATH) que tenga una .pyextensión. Entonces, en su ejemplo, tiene dos paquetes pero no hay módulos definidos. Si considera que un paquete es una carpeta del sistema de archivos y un módulo es un archivo, entonces verá por qué los paquetes contienen módulos y no al revés.

Entonces, en su ejemplo, suponiendo que Package-1 y Package-2 son carpetas en el sistema de archivos que ha colocado en la ruta de Python, puede tener lo siguiente:

Package-1/
  namespace/
  __init__.py
  module1.py
Package-2/
  namespace/
  __init__.py
  module2.py

Ahora tiene un paquete namespacecon dos módulos module1y module2. y a menos que tenga una buena razón, probablemente debería poner los módulos en la carpeta y tener solo eso en la ruta de Python como a continuación:

Package-1/
  namespace/
  __init__.py
  module1.py
  module2.py