Как работает __init__.py?

Question

[PyLearner]

Цитирую документацию: https://docs.python.org/3/tutorial/modules.html#pa...

The __init__.py files are required to make Python treat the directories as containing packages; this is done to prevent directories with a common name, such as string, from unintentionally hiding valid modules that occur later on the module search path

Допустим, в одном каталоге из sys.path есть папка package1. Его структура:

package1/
     sub_package1/
          module1.py
     sub_package2/
          module2.py

Далее в интерпретаторе я пишу import package1. Почему нельзя просто найти папку package1 и импортировать её без __init__.py? (т.е, почему питону не понятно, что папка с модулями и с нужным названием - это пакет, который нужно импортировать?) Можете привести пример случая prevent directories with a common name, such as string, from unintentionally hiding valid modules или случая, когда __init__.py полезен?

Comments

[PrAw]

1. создай каталог sys рядом со скриптом,
потом импортируй sys
работает?

2. добавь в каталог sys/__init__.py
потом импортируй sys
работает?

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

[PyLearner]

PrAw, а в чем логика не импортировать свой пакет sys без init, если я создал его и переместил в папку с пакетами?

Какая была логика создания init.py? Это по типу "А что если юзер создаст свой пакет sys, переместит его в одну из директорий sys.path, но не захочет его использовать. Сделаем так, чтобы пакеты без init не импортировались, если пакет с таким же именем и init есть"? Только для таких случаев был создан init?

[PyLearner]

Грубо говоря, мне непонятно вот что:

1) Почему питон сам не может идентифицировать и импортировать пакет без init, если:
a) Папка содержит модули
b) Папка находится в нужной директории из sys.path
c) Папка имеет то же имя, что и я ввожу

Я уверен, что это легко могло быть реализовано, но не сделано из-за каких-то нюансов. Каких? Для включения\отключения каких-то дублей?

2) Если я создал пакет с таким же именем, что уже встроен в Питон, переместил его в нужную директорию, то очевидно я хочу его использовать? Иначе зачем я его создавал и перемещал, куда надо? Если я не хочу использовать пакет с таким же именем, то я его просто удалю из виртуальной среды?

[PrAw]

PyLearner,
1. В файле может быть дополнительная логика инициализации
2. Наличие этого файла гарантирует, что случайное совпадение имени каталога и имени импортируемого пакета не сделает в сумме модуль.

Answer 1

[Станислав Макаров]

1. Питон может искать модули в нескольких папких в порядке очередности (в том числе по путям в PYTHON_PATH).
2. Представьте что по одному из путей у вас вот так:

а по другому вот так:

3. Вы импортируете модуль string, но первой по приоритету обрабатывается директория с папкой string. А у вас там например вообще не питоновский код, а документация какая-нибудь. Вы на самом деле хотите заимпортить string.py из второй папки, но интерпретатор будет думать что нужно взять директорию, и выдаст ошибку (скажет что мол не является это валидным пакетом или что-то в таком духе).
4. Чтобы такого не было, разработчики решили что вы должны явно помечать, что хотите чтобы папка считалась пакетом. Это тоже самое что помечать файлы с кодом на питоне расширением .py - вы же не ждёте что интерпретатор будет воспринимать .txt-шники как модули на питоне? То же самое и с папкой.

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

Answer 2

[Вячеслав]

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

• переменная __all__
  
• проверка ограничений при использовании пакета
  
• сообщение о deprecated
  

Answer 3

[Игорь]

Перечитав комментарии, я думаю что правильный ответ такой:
да потому что разработчики решили сделать именно так, решили сделать маркером пакета этот файл... а сейчас уже все привыкли
точно также как в других языках фигурные скобки, begin/end, точка с запятой... без которых питон обходится, а что другим языкам мешает? вот по этой-же самой причине

Answer 4

[Kir ---]

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

import package1
from package1.sub_package1 import *

Comments

[Anton Mashletov]

Вы бы еще раз вопрос автора перечитали, а не только заголовок. Он в курсе, что такое __init__.py

Answer 5

[Pixilys]

С версии Python 3.3 + . Этот файлик больше не нужен.