Используются ли все зависимые библиотеки при импорте в Python?

Question

[Relrin]

Сейчас пишу собственную библиотеку для Python'а, которая будет иметь совместимость с Django/SQLAlchemy ORM. На текущий момент структура внутри библиотеки/пакета такая:

MyProject
  |-- db
    |-- orm
      |-- django 
      |-- sqlalchemy

Соответственно, в sqlaclhemy каталоге описаны реализованы какие-то *.py файлы, обеспечивающие совместимость с SQLAlchemy ORM, а django – реализация для Django ORM. Вопрос следующий: если программист поставил себе только этот пакет + Django, не возникнет ли у него ImportError, когда осуществляет работу только с джанговским ORMом, не выполняя явного импорта чего-либо для SQLAlchemy (если будет явный вызов для этого ORM – тут понятно, ошибка возникнет)? Если все же возникнет, то как ее можно избежать?
Быть может кто-нибудь может подсказать так называемые "best practice", чтобы сделать что-то лучше в этом плане?

Answer 1

[nirvimel]

В Python импорт полностью динамический и происходит в runtime. Можно написать:

if moon_phase == 42:
      import sqlalchemy

Тогда ImportError будет вылетать при определенной фазе луны.
Зависимости пакетов в setuptools к этому отношения не имеют.

Что касается best practice, то абстракция от ORM или любого другого уровня часто реализуется так:

• Общий функционал, не зависящий от реализации, выносится в ядро, которое оформляется отдельным пакетом mylibrary_core.
  
• Связи с конкретной реализацией оформляются в виде плагинов в отдельных пакетах (mylibrary_django, например).
  
• Каждый такой плагин имеет зависимость к ядру и к конкретной реализации (django, например).
  
• Конечный юзер начинает установку сразу с mylibrary_django, который автоматом подтягивает mylibrary_core, о котором юзеру беспокоится не приходится.
  

Comments

[Relrin]

Звучит здорово, однако, в моем случае, я хотел бы это сделать в рамках одного "пакета", чтобы из коробки уже был у пользователя возможность юзать либо то, либо то.
Конечно, какая-то "главная часть" она уже есть. Но хочется из коробки дать юзера со старта дать ему выбор что использовать из ORM'ов, либо вообще их не использовать, если в этом нужды нет.

[nirvimel]

Relrin: Ну пожалуйста, никто вам не мешает это реализовать. Только вам тогда придется не прописывать эти зависимости в setup.py, а значит при установке не будет гарантировано, что django вообще установлен.

[Relrin]

Ну я так и планирую, вообщем-то, сделать. В setup.py только сама библиотека. А Django, SQlAlchemy ORM уже сам доставляешь по необходимости.
Единственный момент, который мне все еще не дает покоя, так это импорты относительно этих "расширений", если их можно так назвать. То есть имеем такую ситуацию:

В модуле "А":
from sqlalchemy import types

В модуле "B":
from django.conf import settings

В каких случаях мы здесь получим ImportError (ибо не совсем понятно, с учетом того, что в setup.py все эти ORMы не попадают по моей задумке, а ставятся отдельно пользователем по необходимости):
1) Получим ImportError по первому обращению, поскольку не установлен ни один из модулей
2) Получим ImportError только по тому модулю, который не установлен (а допустим, уставнолен Django + этот пакет)
3) Получим ImportError только по тому модулю (в момент первой попытки использования где-то у себя в коде), который не установлен (а допустим, уставнолен Django + этот пакет)

[nirvimel]

Relrin: Я же говорю: в Python импорты динамические. То есть импорт - это не какое-то свойство модуля (тем более всей библиотеки), а просто команда, такая же как вызов любой функции. То есть импорт модуля qwerty происходит только в момент, когда интерпретатор доходит до команды "import qwerty". При импорте модуль исполняется, если при исполнении интерпретатор натыкается на еще один "import ...", то в этот момент осуществляется еще один импорт.

Значит, в вашем примере при импорте модуля "A" ImportError вылетит только при отсутствии SQLAlchemy, а при импорте модуля "B" ImportError вылетит только при отсутствии Django.

Еще можно делать импорт по условию. Или можно перехватывать и подавлять ImportError. В этом нет ничего особенного, такое иногда встречается в популярных библиотеках.

Answer 2

[sim3x]

is_user_install_anything_useful = False

try:
    import django
    is_user_install_anything_useful = True
except ImportError:
    pass

try:
    import sqlalchemy
    is_user_install_anything_useful = True
except ImportError:
    pass

if not is_user_import_anything_useful: 
     raise ImportError('Install django or SQLalchemy')