Абсолютний та явний відносний імпорт модуля 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.

Це обмеження слід враховувати при оцінці найкращого підходу. У будь-якому випадку Guido проти запуску скриптів з модуля:

Я -1 на цьому та на будь-яких інших запропонованих поворотах машини __main__. Здається, єдиним варіантом використання є запуск сценаріїв, які, здається, живуть всередині каталогу модуля, який я завжди сприймав як антишаблон. Щоб я передумав, вам довелося б переконати мене, що це не так.

Вичерпні дискусії з цього приводу можна знайти на SO; повторно Python 3 це досить вичерпно:

Відносний імпорт у Python 3

Question 4

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