Добавление кода в __init__.py

Все операции импорта в __init__.py становятся доступными, когда вы импортируете пакет (каталог), который его содержит.

Пример:

./dir/__init__.py:

import something

./test.py:

import dir
# can now use dir.something

Обновлено: забыл упомянуть, что код __init__.py запускается при первом импорте любого модуля из этого каталога. Так что обычно это хорошее место для размещения любого кода инициализации на уровне пакета.

EDIT2: dgrant указал на возможную путаницу в моем примере. В __init__.pyimport something может импортировать любой модуль, не обязательно из пакета. Например, мы можем заменить его на import datetime, тогда на нашем верхнем уровне test.py оба этих фрагмента будут работать:

import dir
print dir.datetime.datetime.now()

и

import dir.some_module_in_dir
print dir.datetime.datetime.now()

Итог: все имена, присвоенные в __init__.py, будь то импортированные модули, функции или классы, автоматически становятся доступными в пространстве имен пакета всякий раз, когда вы импортируете пакет или модуль в пакете.

На самом деле это просто личные предпочтения, и они связаны с компоновкой ваших модулей Python.

Допустим, у вас есть модуль erikutils. Есть два способа, которыми он может быть модулем: либо у вас есть файл с именем erikutils.py на вашем sys.path, либо у вас есть каталог с именем erikutils на вашем sys.path с пустым файлом __init__.py внутри. Затем предположим, что у вас есть группа модулей под названием fileutils, procutils, parseutils, и вы хотите, чтобы они были подмодулями erikutils. Итак, вы создаете несколько файлов .py с именами fileutils.py, procutils.py и parseutils.py:

erikutils
  __init__.py
  fileutils.py
  procutils.py
  parseutils.py

Возможно, у вас есть несколько функций, которых нет в модулях fileutils, procutils или parseutils. Допустим, вам не хочется создавать новый модуль под названием miscutils. И вы хотите иметь возможность вызывать функцию следующим образом:

erikutils.foo()
erikutils.bar()

вместо того, чтобы делать

erikutils.miscutils.foo()
erikutils.miscutils.bar()

Так как модуль erikutils - это каталог, а не файл, мы должны определить его функции внутри файла __init__.py.

В django лучший пример, который я могу придумать, - это django.db.models.fields. ВСЕ классы django * Field определены в файле __init__.py в каталоге django / db / модели / поля. Я предполагаю, что они сделали это, потому что не хотели втиснуть все в гипотетическую модель django / БД / модели / fields.py, поэтому они разделили ее на несколько подмодулей (например, related.py, files.py) и вставили созданные * определения полей в сам модуль полей. (следовательно, __init__.py).

Использование файла __init__.py позволяет сделать внутреннюю структуру пакета невидимой извне. Если внутренняя структура изменилась (например, из-за того, что вы разбили один жирный модуль на два), вам нужно настроить только файл __init__.py, но не код, который зависит от пакета. Вы также можете сделать части вашего пакета невидимыми, например если они не готовы к общему использованию.

Обратите внимание, что вы можете использовать команду del, поэтому типичный __init__.py может выглядеть так:

from somemodule import some_function1, some_function2, SomeObject

del somemodule

Теперь, если вы решите разделить somemodule, новый __init__.py может быть:

from somemodule1 import some_function1, some_function2
from somemodule2 import SomeObject

del somemodule1
del somemodule2

Снаружи упаковка по-прежнему выглядит точно так же, как и раньше.