Абсолютный и явный относительный импорт модуля Python

Question 1

Меня интересует предпочтительный способ импорта пакетов в приложение Python. У меня есть такая структура пакета:

project.app1.models
project.app1.views
project.app2.models

project.app1.viewsимпорт project.app1.modelsи project.app2.models. На ум приходят два способа сделать это.

С абсолютным импортом:

import A.A
import A.B.B

или с явным относительным импортом, как введено в Python 2.5 с PEP 328 :

# explicit relative
from .. import A
from . import B

Каков самый питонический способ сделать это?

Question 2

Абсолютный импорт. Из PEP 8:

Относительный импорт для импорта внутри упаковки крайне не рекомендуется. Всегда используйте абсолютный путь к пакету для всего импорта. Даже сейчас, когда PEP 328 [7] полностью реализован в Python 2.5, его стиль явного относительного импорта активно не приветствуется; абсолютный импорт более переносим и обычно более читабелен.

Явный относительный импорт - хорошая языковая функция (я думаю), но он далеко не такой явный, как абсолютный импорт. Более читаемая форма:

import A.A
import A.B.B

особенно если вы импортируете несколько разных пространств имен. Если вы посмотрите на несколько хорошо написанных проектов / руководств, которые включают импорт из пакетов, они обычно следуют этому стилю.

Несколько дополнительных нажатий клавиш, которые вы сделаете более явными, сэкономят другим (и, возможно, вам) много времени в будущем, когда они попытаются выяснить ваше пространство имен (особенно, если вы переходите на 3.x, в котором некоторые из пакетов имена изменились).

Question 3

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

См. Это обсуждение со ссылкой на самого Гвидо:

«Разве это не в основном историческое? Пока не был реализован новый синтаксис относительного импорта, были различные проблемы с относительным импортом. Краткосрочным решением было рекомендовать не использовать их. Долгосрочным решением было внедрение однозначного синтаксиса. Теперь пора отозвать антирекомендацию. Конечно, не переусердствуйте - я все еще нахожу их приобретенным вкусом; но у них есть свое место ».

OP правильно связывает PEP 328, в котором говорится:

Было представлено несколько вариантов использования, наиболее важным из которых является возможность изменить структуру больших пакетов без необходимости редактировать подпакеты. Кроме того, модуль внутри пакета не может легко импортировать себя без относительного импорта.

Также см. Почти повторяющийся вопрос Когда и зачем использовать относительный импорт в Python

Конечно, это дело вкуса. Хотя легче перемещать код с помощью относительного импорта, это также может неожиданно что-то сломать; и переименовать импорт не так уж и сложно.

Чтобы принудительно изменить поведение PEP 328, используйте:

from __future__ import absolute_import

В этом случае неявный относительный импорт больше не будет возможен (например, import localfileбольше не будет работать, только from . import localfile). Для чистого и перспективного поведения рекомендуется использовать absolute_import.

Важное предостережение заключается в том, что из-за PEP 338 и PEP 366 относительный импорт требует, чтобы файл python был импортирован как модуль - вы не можете выполнить file.py с относительным импортом, иначе вы получите файл ValueError: Attempted relative import in non-package.

Это ограничение следует учитывать при оценке наилучшего подхода. Гвидо в любом случае против запуска скриптов из модуля:

Я -1 по этому поводу и по поводу любых других предлагаемых вариантов механизма __main__. Единственный вариант использования - запуск сценариев, которые находятся внутри каталога модуля, что я всегда считал антипаттерном. Чтобы заставить меня изменить свое мнение, вам нужно убедить меня, что это не так.

Исчерпывающие обсуждения по этому вопросу можно найти на SO; ре. Python 3 довольно обширен:

Относительный импорт в Python 3

Question 4

Относительный импорт не только дает вам возможность переименовать свой пакет позже, не изменяя десятки внутренних операций импорта, но я также добился успеха с ними в решении определенных проблем, связанных с такими вещами, как циклический импорт или пакеты пространств имен, поскольку они не отправляют Python "обратно в систему". top ", чтобы заново начать поиск следующего модуля из пространства имен верхнего уровня.