Додавання коду до __init__.py

Я розглядаю, як працює модель моделі в django, і помітив щось, чого не розумію.

Я знаю, що ви створюєте порожній __init__.pyфайл, щоб вказати, що поточний каталог - це пакет. І що ви можете встановити деяку змінну, __init__.pyщоб імпорт * працював належним чином.

Але django додає купу операторів from ... import ... та визначає купу класів у __init__.py. Чому? Хіба це не просто робить речі безладними? Чи є причина, яка вимагає використання цього коду __init__.py?

Весь імпорт у __init__.pyдоступний, коли ви імпортуєте пакет (каталог), що його містить.

Приклад:

./dir/__init__.py:

import something

./test.py:

import dir
# can now use dir.something

EDIT: забув згадати, код in __init__.pyзапускається під час першого імпорту будь-якого модуля з цього каталогу. Тому зазвичай це гарне місце для розміщення будь-якого коду ініціалізації на рівні пакета.

EDIT2: dgrant вказав на можливу плутанину в моєму прикладі. In __init__.py import 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 * визначені у __init__.pyфайлі каталогу django / db / models / fields . Я припускаю , що вони зробили це , тому що вони не хочуть , щоб втиснути все в гіпотетичній Джанго / дб / моделі / 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

Зовні упаковка все ще виглядає точно так само, як і раніше.