Обработка сбоев импорта в языке Python

Расширенные примеры импорта и обработки ImportError

Динамический импорт через importlib.import_module

Модуль выбирается по строке во время выполнения. Это полезно для плагинов и конфигураций.

import importlib

module_name = 'json'
module = importlib.import_module(module_name)
data = module.loads('{"value": 42}')
print(data)

{'value': 42}

Если имя модуля неизвестно, importlib.import_module вызывает ModuleNotFoundError. Его можно перехватить и вернуть понятное сообщение.

import importlib

def load_plugin(name):
    try:
        return importlib.import_module(name)
    except ImportError as exc:
        print(f'Плагин {name} недоступен: {exc}')
        return None

plugin = load_plugin('unknown_plugin')
print(plugin)

Плагин unknown_plugin недоступен: No module named 'unknown_plugin'
None

Загрузка модуля по полному пути с importlib.util

Иногда файл лежит вне пакетов и sys.path. spec_from_file_location создает спецификацию, module_from_spec формирует модуль, а exec_module выполняет код.

import importlib.util

file_path = '/tmp/custom_module.py'
spec = importlib.util.spec_from_file_location('custom_module', file_path)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)

print(module.some_function())

# При содержимом /tmp/custom_module.py:
# def some_function():
#     return 'custom result'
# custom result

Импорт из zip-архива

Python умеет импортировать модули из zip-файла, если добавить архив в sys.path. Такой прием встречается в автономных сборках.

import sys
sys.path.insert(0, '/tmp/modules.zip')

import mypackage.mymodule
print(mypackage.mymodule.VALUE)

# Если в архиве есть mypackage/mymodule.py с VALUE = 7:
# 7

Ленивый импорт через __getattr__ модуля

PEP 562 позволяет отложить загрузку тяжелого подмодуля до первого обращения. Это уменьшает время старта программы.

# package/__init__.py
def __getattr__(name):
    if name == 'heavy':
        import importlib
        module = importlib.import_module('package.heavy')
        globals()[name] = module
        return module
    raise AttributeError(f'module package has no attribute {name}')

# Использование:
import package
print(package.heavy.VALUE)

# Значение из package/heavy.py: 100
# 100

Обработка разных подклассов ImportError

ModuleNotFoundError сообщает об отсутствующем модуле, а обычный ImportError может означать отсутствующее имя внутри найденного модуля. Разделение помогает точнее диагностировать сбой.

try:
    from collections import OrderedDictMissing
except ModuleNotFoundError as exc:
    print('Модуль не найден:', exc.name)
except ImportError as exc:
    print('Имя не найдено в модуле:', exc)

Имя не найдено в модуле: cannot import name 'OrderedDictMissing' from 'collections'

Перехват ImportError с сохранением причины

Конструкция raise ... from ... сохраняет цепочку исключений, что упрощает отладку.

def get_math_lib():
    try:
        import numpy as np
        return np
    except ImportError as exc:
        raise RuntimeError('Для расчета требуется numpy') from exc

get_math_lib()

# RuntimeError: Для расчета требуется numpy
# The above exception was the direct cause of the following exception:
# ModuleNotFoundError: No module named 'numpy'

Пользовательский finder для запрета импорта

Мета-путевой finder может блокировать нежелательные модули. Это редкий пример контроля импорта.

import sys

class BlockFinder:
    def find_spec(self, fullname, path=None, target=None):
        if fullname == 'os':
            raise ImportError('Импорт os запрещен политикой')
        return None

sys.meta_path.insert(0, BlockFinder())

try:
    import os
except ImportError as exc:
    print(exc)

Импорт os запрещен политикой

Импорт с резервным вариантом и предупреждением

Модуль logging позволяет зафиксировать причину отката к альтернативе.

import logging
logging.basicConfig(level=logging.INFO)

try:
    import ujson as json_lib
except ImportError:
    logging.info('ujson не установлен, используется стандартный json')
    import json as json_lib

print(json_lib.dumps({'ok': True}))

INFO:root:ujson не установлен, используется стандартный json
{"ok": true}

Проверка версии модуля после импорта

Некоторые пакеты меняют API между версиями. После успешного импорта полезно проверить атрибут версии.

import pandas as pd

required = '2.0.0'
if pd.__version__ < required:
    raise ImportError(f'Нужна pandas {required} или новее, найдена {pd.__version__}')

print(pd.__version__)

2.2.1

Импорт модуля из строки конфигурации

Конфигурация может хранить путь к классу или функции. Такой шаблон часто встречается в фреймворках.

import importlib

def load_callable(dotted_path):
    module_name, attr_name = dotted_path.rsplit('.', 1)
    module = importlib.import_module(module_name)
    return getattr(module, attr_name)

func = load_callable('math.sqrt')
print(func(81))

9.0

Обработка отсутствующего модуля в CLI

Утилита командной строки может завершиться с кодом 1 и понятным текстом.

import sys

def main():
    try:
        import yaml
    except ImportError:
        print('Модуль yaml не установлен. Установка: python -m pip install PyYAML')
        return 1
    print(yaml.safe_load('key: value'))
    return 0

sys.exit(main())

# Если PyYAML отсутствует:
# Модуль yaml не установлен. Установка: python -m pip install PyYAML
# Код возврата: 1