usando __init__.py

Question

Tengo dificultades para entender los escenarios de uso o los objetivos de diseño de los archivos __init__.py de python en mis proyectos.

Supongamos que tengo directorio 'modelo' (se refiere como un paquete) que contiene los siguientes archivos

1. __init__.py
2. meta.py
3. solrmodel.py
4. mongomodel.py
5. samodel.py

He encontrado dos formas de utilizar __init__.py:

1. Tengo una definición común que debe ser usado en solrmodel.py, mongomodel.py, samodel.py. ¿Puedo usar __init__.py como una definición básica/común para todas las * clases model.py? Esto significa que tengo que importar model/__init__.py.

2. O bien, el __init__.py se han importado las definiciones de solrmodel.py, mongomodel.py, samodel.py en su propia y permite la fácil importación de clases o función como esta:

   # file: __init__.py 
   
   from mongomodel import * 
   from solrmodel import * 
   from samodel import * 
   

   (I soy consciente de que import * no es recomendable y yo sólo lo utilizaron como una convención)

no podía decidir entre dos escenarios más arriba. ¿Hay más escenarios de uso para __init__.py y puede explicar el uso?

Answer 1

La gran mayoría de los archivos __init__.py que escribo están vacíos, porque muchos paquetes no tienen nada que inicializar.

Un ejemplo en el que puedo desear la inicialización es cuando en el tiempo de carga del paquete quiero leer en una serie de datos de una vez por todas (desde archivos, un DB o la web, por ejemplo), en cuyo caso es mucho mejor poner esa lectura en una función privada en el paquete __init__.py en lugar de tener un "módulo de inicialización" separado e importar de manera redundante ese módulo de cada módulo real en el paquete (inútilmente repetitivo y propenso a errores: eso es obviamente un caso en el que confiar en la garantía del idioma de que el paquete __init__.pyes cargado una vez antes de que cualquier módulo en el paquete sea obviamente mucho más ¡Ptónico!).

Para otras expresiones de opinión concretas y autorizadas, observe los diferentes enfoques adoptados en los diversos paquetes que forman parte de la biblioteca estándar de Python.

Answer 2

Los contenidos de __init__.py se importan cuando importa un módulo dentro del paquete.

Está pasando por alto un tercer escenario, que consiste en colocar las partes comunes en un módulo separado y luego importar los otros módulos, dejando __init__.py para las cosas que se utilizarán fuera del paquete. Esta es la práctica que suelo seguir.