Как импортировать файл в питоне
Как работают импорты в Python
Порой бывает трудно правильно реализовать import с первого раза, особенно если мы хотим добиться правильной работы на плохо совместимых между собой версиях Python 2 и Python 3. Попытаемся разобраться, что из себя представляют импорты в Python и как написать решение, которое подойдёт под обе версии языка.
Содержание
Ключевые моменты
Основные определения
Пример структуры директорий
Что делает import
Основы import и sys.path
Вот как оператор import производит поиск нужного модуля или пакета согласно документации Python:
Программы могут изменять переменную sys.path после её инициализации. Директория, содержащая запускаемый скрипт, помещается в начало поиска перед путём к стандартной библиотеке. Это значит, что скрипты в этой директории будут импортированы вместо модулей с такими же именами в стандартной библиотеке.
Кроме того, импорты в Python регистрозависимы: import Spam и import spam — разные вещи.
Функцию pkgutil.iter_modules() (Python 2 и Python 3) можно использовать, чтобы получить список всех модулей, которые можно импортировать из заданного пути:
Чуть подробнее о sys.path
Документация Python описывает sys.path так:
Список строк, указывающих пути для поиска модулей. Инициализируется из переменной окружения PYTHONPATH и директории по умолчанию, которая зависит от дистрибутива Python.
Документация к интерфейсу командной строки Python добавляет информацию о запуске скриптов из командной строки. В частности, при запуске python
Подключение модулей в Python
Язык программирования Python имеет много встроенных функций. Однако их не хватает для решения всех видов задач, поэтому программисты добавляют инструменты, подключая модули.
Что такое модуль
Это отдельный файл, содержащий какой-то код. Любой скрипт, написанный программистом на Python 3, можно назвать модулем. Он может быть как исполняемым, так и подключаемым. Исполняемый модуль содержит код, который самостоятельно выполняет какие-то действия, а подключаемый представляет из себя набор функций, классов и объектов, которые можно использовать для решения задач в другой программе.
Разделение программ на модули даёт ряд преимуществ:
Исполняемый и подключаемый модуль
Можно написать такой скрипт, который будет и выполнять какие-то действия (программа), и импортироваться в другие модули (библиотека).
Его важно правильно оформить:
Подключение модуля
Это можно сделать разными способами, выбор зависит только от нужд и желаний программиста.
Модули в Python — это файлы с расширением «.py». При импорте расширение опускается, интерпретатор и так знает, что после команды import следует имя модуля.
Программист может без проблем подключить любой модуль, который есть в стандартной библиотеке Python 3. Для подключения специфичных пользовательских инструментов сначала нужно их скачать. Обычно для этого используется пакетный менеджер pip.
Обычное подключение — import
После подключения программа получает доступ ко всем функциям, методам и классам, содержащимся в нём.
Программист может вызвать любую функцию из подключенной библиотеки используя префикс « имя_модуля. «. Пример: random.randint(1,15) где random — это библиотека, которую мы подключили, а randint — имя функции, которая в ней описана.
Этот способ не допускает пересечения имён, то есть программист может использовать одно и то же имя функции в скрипте, точно такое же, как и в подключаемой библиотеке и не бояться, что после её подключения, функция будет переопределена.
Вот полный пример использования инструкции import в Python 3:
Использование псевдонимов — as
Некоторые модули имеют длинное и неудобное название. Для удобства и сокращения количества кода программист может заменить его на своё.
Импорт компонентов — from
Чтобы не захламлять программу большим количеством неиспользуемых инструментов, можно подключать не весь модуль, а какую-то его часть.
Таким образом, основной скрипт получает доступ только к определённой функции. Кроме того, при таком подключении при вызове функций из подключённого модуля не используется префикс. Важно не забывать об этом, чтобы не допустить конфликта имён.
Можно подключить несколько функций сразу в одной строке. Для этого их надо перечислить через запятую.
Если после import написать символ звёздочки «*», подключится все содержимое модуля. Это считается плохим тоном, потому что может привести к совпадению имён из основного скрипта с именами из подключаемого. Но если программист уверен, что использовал уникальные названия для функций и переменных, теоретически он может использовать этот способ.
Перезагрузка библиотеки
За один сеанс модуль можно импортировать только один раз. Если программист после импорта, изменит в файле, который импортировал что-либо, а потом снова его импортирует, основная программа не будет видеть этих изменений.
Всё потому, что при импорте библиотека кешируется, когда её пытаются импортировать снова, интерпретатор Python просто использует сохранённую в кэше копию.
Если всё же необходимо перезагрузить модуль, на помощью приходит функция reload() из стандартной библиотеки importlib. Перезагрузка не влияет на объекты, ссылающиеся на импортированный модуль, и позволяет реализовать динамическую перезагрузку компонентов программы.
Подключение из другой папки
Библиотеки подключаются очень просто, когда интерпретатор Python знает, где их искать. Python ищет модули:
Чтобы импортировать модуль из другой папки в Python 3, можно сделать следующее:
Для того чтобы директория, содержащая файлы, определялась как пакет, в неё необходимо добавить файл __init__.py. Он показывает интерпретатору Python, что папка — это пакет с модулями.
Начиная с версии Python 3.3, добавлять файл __init__.py в директорию больше не нужно, интерпретатор Python считает все папки пакетами.
Импорт модулей в Python
Оператор импорта в Python используется для импорта модулей, которые мы хотим использовать в нашей программе. Модули – это скрипты в Python, содержащие служебные функции, типы, классы и т.д. Есть много модулей, которые мы регулярно используем в программах, такие как sys, os, collections и т.д.
Если мы хотим импортировать встроенные модули в Python или любой сторонний модуль, установленный с помощью диспетчера пакетов, такого как PIP, мы можем очень легко импортировать и использовать их в нашей программе.
Python ищет модули и пакеты в свойстве sys.path. Этот путь всегда содержит текущий каталог, из которого выполняется сценарий, поэтому любой модуль в текущем каталоге можно импортировать как есть.
Импорт в Python чувствителен к регистру, поэтому import sys и import Sys ищут разные модули для импорта.
Python сначала ищет модуль во встроенных модулях. Если не найден, то ищет модули в текущем каталоге. Итак, если у нас есть файл math.py в том же каталоге, что и наш основной скрипт, он будет загружен при вызове import math, если модуль ‘math’ отсутствует во встроенных модулях. Вы можете получить список встроенных модулей, используя sys.builtin_module_names. На изображении ниже показаны встроенные модули:
Классы и функции импорта из модуля
Мы также можем импортировать определенные классы из модуля. Таким образом, мы можем импортировать определенные части модуля и использовать их. Это также помогает в написании свободного кода. Мы можем добиться этого, используя ключевое слово from с оператором импорта.
Пользовательский модуль импорта
Когда мы создаем скрипт, мы можем импортировать его в другой скрипт Python, используя его имя. Допустим, у нас есть следующая структура каталогов с несколькими скриптами.
У нас есть следующие функции, определенные в файле utils.py.
Мы можем импортировать его в python_import_examples.py и использовать его функции.
Импорт as
Мы можем определить собственное имя для импортированного модуля, используя оператор import as.
Результат будет таким же, как и в предыдущей программе.
Импорт из другого каталога
Если скрипт, который мы импортируем, находится в том же каталоге, то мы можем импортировать его так же, как и встроенные модули. Однако, если скрипт присутствует в другом каталоге, мы можем использовать библиотеку importlib, чтобы импортировать их как модуль.
Скажем, наш Strutils.py имеет следующие функции:
Теперь давайте посмотрим, как использовать importlib для импорта этого скрипта в наш пример.
Класс импорта из другого файла
Мы можем импортировать скрипты и использовать определенные в них классы с помощью importlib. Допустим, у нас есть классы Person и Student, определенные в файле myclasses.py.
Вот пример кода, в котором я использую ранее определенную функцию для импорта этого скрипта и использования его классов.
Обратите внимание, что мы можем сохранить любое имя для импортируемого модуля, это похоже на использование оператора import as.
Есть еще один способ импортировать скрипты из другого каталога с помощью модуля sys.
Это полезно, когда мы хотим импортировать только определенные классы и функции из импортированного файла. Кроме того, использование этого кода намного проще для понимания.
Заключение
Оператор импорта Python позволяет нам импортировать модули, определенные классы и функции из модулей. Его очень легко использовать, и, поскольку в большинстве случаев мы работаем со встроенными модулями или модулями, установленными с использованием PIP, нам не нужно писать логику для загрузки скриптов из другого каталога.
Полное руководство по использованию инструкции import в Python
Общее / Ключевые моменты
Основные определения
Пример структуры директории
Основы использования оператора import и переменной sys.path
В соответствии с документацией Python, оператор import ищет корректный модуль или пакет для импорта в соответствии со следующими правилами.
Функция pkgutil.iter_modules (Python 2 и 3) может использоваться для получения списка всех импортируемых модулей по заданному пути:
Подробнее о sys.path
Документация Python для sys.path описывает это следующим образом.
Давайте рассмотрим порядок, в соответствии с которым интерпретатор Python ищет модули для импорта:
Все о __init__.py
Файл __init__.py выполняет 2 функции.
Преобразование папки сценариев в импортируемый пакет модулей
Это НЕ применимо к Python 3.3 и выше, благодаря принятию неявных пространств имен пакетов. В принципе, Python 3.3+ рассматривает все папки как пакеты, поэтому пустые файлы __init__.py больше не нужны и могут быть опущены.
Запуск кода инициализации пакета
Рассмотрим следующий пример.
Листинг файла test/packA/a1.py :
Листинг файла test/packA/__init__.py :
Листинг файла test/start.py :
Команда python start.py выведет следующее:
Использование объектов из импортированного модуля или пакета
Существует четыре различных вида синтаксиса для записи операторов импорта.
Решение №1:
затем мы можем вызывать функцию непосредственно по имени:
Решение №2:
затем мы должны будем использовать в качестве префикса к имени функции имя модуля.
Решение №3:
Далее необходимо использовать полный путь:
Использование dir() для проверки содержимого импортированного модуля
Импорт пакетов
Импорт пакета концептуально эквивалентен импорту файла __init__.py из папки пакета в качестве модуля. И действительно это так. Вот как Python рассматривает импортируемый пакет:
Импорт с использованием абсолютных и относительных путей
Импорт по относительному пути использует относительный путь (начинающийся с пути к текущему модулю) до требуемого для импорта модуля. Существует два вида импорта с использованием относительного пути:
В документации Python говорится о том, как Python 3+ обрабатывает импорт по относительному пути:
В целом импорт по абсолютному пути предпочтительнее чем по относительному. Их использование позволяет избежать путаницы между явным или неявным импортом. Кроме того, любой сценарий, который использует явный импорт по относительному пути, не может быть запущен напрямую:
Обратите внимание, что импорт по относительному пути основан на имени текущего модуля. Поскольку имя основного модуля всегда «main», то модули, предназначенные для использования в качестве основного модуля приложения Python, должны всегда использовать импорт по абсолютному пути.
Источники: Python 2 и 3.
Примеры
Пример 1: содержание sys.path заранее известно
Пример 2: содержание sys.path может изменяться
Часто мы хотим гибко использовать сценарии Python независимо от того выполняются ли они в командной строке или импортированы как модуль в другой скрипт. Как будет показано ниже, здесь мы столкнемся с проблемами, а в особенности в коде написанном на Python 3.
Таким образом, по использованию инструкции import в файле a2.py имеем:
Решение (обходной путь решения проблемы): Мне ничего не известно о простом и наглядном способе решения этой проблемы. Вот некоторые обходные пути:
ПРИМЕЧАНИЕ. Обычно этот метод работает. Однако в некоторых установках Python переменная __file__ может быть некорректной. В этом случае вам нужно будет использовать встроенный в стандартную библиотеку Python пакет inspect. Ознакомьтесь с вопросом на StackOverflow для правильного использования приведенных выше инструкций.
Пример 3: содержание sys.path может изменяться (вариант 2)
В этом случае Решение №1 не будет работать. Но другие будут.
Пример 4: Импорт из родительской директории
Если мы не собираемся модифицировать переменные PYTHONPATH и sys.path в коде, то в этом случае основным ограничением импорта является следующее: При непосредственном запуске скрипта через консоль невозможно импортировать что-либо из его родительского каталога.
Python 2 VS. Python 3
Импорт в Python: часть 2
Система импорта Python
Мы видели много преимуществ системы импорта Python и способов их использования. В этой статье мы приподнимем завесу над тем, что происходит при импорте модулей и пакетов.
Как и многое в Python, систему импорта можно настраивать. Мы увидим несколько способов изменения системы импорта, в том числе автоматическую загрузку недостающих пакетов из PyPI и импорт файлов данных, как если бы они были модулями.
Импорт содержимого модулей
Система импорта Python подробно описана в официальной документации. Вот что происходит на высоком уровне при импорте модуля (или пакета). Модуль:
Например, следующие способы импортирования и переименования math.pi примерно эквивалентны:
Конечно, в обычном коде вы бы отдали предпочтение первому.
Следует отметить, что даже если из модуля импортируется только один атрибут, то загружается и выполняется весь модуль. Остальное содержимое модуля просто не привязано к текущему пространству имён. Чтобы доказать это, обратимся к кэшу модулей:
sys.modules — это и есть кэш модулей. Он содержит ссылки на все импортированные модули.
Это не только отличная оптимизация, но и необходимость. Если бы модули при каждом импортировании загружались заново, то в некоторых ситуациях могли бы возникнуть несоответствия (например, когда имеющийся исходный код меняется во время выполнения скрипта).
Вспомните путь импорта, который вы рассматривали ранее, в первой статье. Фактически он сообщает Python, где искать модули. Но если Python находит модуль в кэше модулей, то он не станет утруждать себя поиском пути импорта для этого модуля.
Пример: синглтоны в качестве модулей
В объектно-ориентированном программировании синглтон — это класс, имеющий не более одного экземпляра. И хотя мы можем реализовать синглтоны в Python, большинство случаев хорошего использования синглтонов связано с модулями. Мы можем доверить кэшу модулей инстанцирование класса только один раз.
В качестве примера вернемся к демографическим данным Организации Объединенных Наций, которые мы уже рассматривали ранее, в первой статье. Следующий модуль определяет класс, обёртывающий данные о населении:
Чтение данных с диска занимает некоторое время. Мы не ожидаем, что файл данных изменится, поэтому инстанцируем класс при загрузке модуля. Название класса начинается с подчеркивания для указания на то, что его не следует использовать.
Мы можем задействовать синглтон population.data для создания диаграммы Matplotlib, иллюстрирующей демографический прогноз для стран с наибольшей численностью населения:
Создаётся такой график:
Обратите внимание, что загрузка данных во время импорта — это своего рода антипаттерн. В идеале желательно, чтобы импорт был максимально свободен от побочных эффектов. Лучшим подходом была бы ленивая загрузка данных, т.е. загружать их по мере необходимости. Это может получаться довольно элегантно, если мы задействуем свойства. Пример того, как это делается, можете увидеть ниже.
Повторная загрузка модулей
Кэш модулей может быть несколько неудобным, когда вы работаете в интерактивном интерпретаторе. Не так просто перезагрузить модуль после его изменения. Рассмотрим, например, следующий модуль:
Вернувшись в консоль, импортируем обновленный модуль, чтобы увидеть, что получилось после исправления ошибки:
Самое простое решение здесь — выйти из консоли Python и перезапустить её. Это заставит Python очистить свой кэш модулей:
Однако перезапуск интерпретатора не всегда возможен. Вероятно, виной тому более сложная сессия, на настройку которой может уйти много времени. В этом случае для перезагрузки модуля можно использовать importlib.reload() :
Средства поиска и загрузчики
Но это не всегда так. Создадим файл с именем time.py и таким содержимым:
Затем откроем интерпретатор Python и импортируем этот новый модуль:
Модуль math импортируется из файла, а вот time — это уже встроенный модуль. Кажется, встроенные модули не затеняются локальными.
Давайте ещё больше углубимся в систему импорта Python, а заодно разберёмся, почему встроенные модули не затеняются локальными. Импортирование модуля проходит в три этапа:
Вы можете расширить систему импорта Python, внедрив своё собственное средство поиска и при необходимости — собственный загрузчик. Позже мы увидим пример использования такого средства поиска. А пока что научимся делать базовые (и совсем простенькие) персональные настройки системы импорта.
sys.meta_path управляет тем, какие средства поиска вызываются в процессе импорта:
Стоит обратить внимание на два обстоятельства. Во-первых, здесь даётся ответ на поставленный ранее вопрос: встроенные модули не затеняются локальными модулями, потому что встроенное средство поиска вызывается до средства поиска пути импорта, которое находит локальные модули. Во-вторых, есть возможность настроить sys.meta_path так, как вам нужно.
Внесём немного неразберихи в наш сеанс работы в Python. Для этого удалим все средства поиска:
Средств поиска не осталось, поэтому Python не может найти или импортировать новые модули. Но у Python остаётся возможность импортировать те модули, которые уже находятся в кэше модулей. Он заглядывает туда, прежде чем вызывать средства поиска.
Далее приведём более полезный пример. Напишем средство поиска, которое выведет на консоль сообщение, идентифицирующее импортируемый модуль. В этом примере показано, как добавить собственное средство поиска, пусть и фактически без попыток найти модуль:
Вставив DebugFinder первым в список средств поиска, получаем рабочий список всех импортируемых модулей:
Или вот ещё пример: скажем, у нас задача избавить мир от регулярных выражений. (Но к чему такая категоричность? Регулярные выражения — это здорово!). Мы можем реализовать средство поиска, которое запрещает модуль регулярных выражений re :
Появление ModuleNotFoundError гарантирует, что ни одно из средств поиска, идущих далее в списке средств поиска, выполнено не будет. Тем самым обеспечивается неиспользование регулярных выражений в Python:
Пример: автоматическая установка из PyPI
Система импорта Python уже достаточно мощная и удобная, поэтому куда проще внести в неё сумятицу, чем дополнить чем-то полезным. Однако следующий пример в определенных ситуациях может пригодиться.
Каталог пакетов Python Package Index (PyPI) — это универсальный каталог программного обеспечения для поиска сторонних модулей и пакетов. Кроме того, это место, откуда pip загружает пакеты.
Во избежание ошибок при установке модулей в Python следует экспериментировать с этим кодом только в тех средах, которые не жалко будет удалить или переустановить.
Следующее средство поиска пытается установить модули с помощью pip :
Применение PipFinder для импорта и установки reader приводит к установке неправильного пакета:
Это может иметь катастрофические последствия для вашего проекта.
Автоматическая установка может быть очень полезна при запуске Python в облаке с более ограниченным контролем над средой. Например, когда вы запускаете инструменты типа Jupyter notebook в Google Colaboratory. Среда Colab notebook отлично подходит для совместного просмотра данных.
Типичная среда notebook идёт с кучей установленных пакетов для обработки и анализа данных, таких как NumPy, Pandas и Matplotlib, а с помощью pip можно добавлять новые пакеты. Кроме того, можно активировать автоматическую установку:
pip_importer недоступен локально на сервере Colab, поэтому код копируется в первую ячейку notebook.
Пример: импорт файлов данных
Последний пример в этой части составлен по мотивам замечательной статьи Алексея Билогура Import Almost Anything in Python: An Intro to Module Loaders and Finders (eng). Мы уже видели, как использовать importlib.resources для импорта файлов данных. Здесь же мы реализуем пользовательский загрузчик, который может импортировать CSV-файл напрямую.
Ранее у нас был огромный CSV-файл с демографическими данными. Сделаем пример пользовательского загрузчика более управляемым с помощью файла меньшего размера employees.csv :
Первая строка представляет собой заголовок с названиями для трёх полей, а следующие две строки содержат информацию о сотрудниках. Ещё больше о работе с CSV-файлами можно узнать в статье Reading and Writing CSV Files in Python (eng).
Наша цель в этой части статьи — написать средство поиска и загрузчик, позволяющие импортировать CSV-файл напрямую, так чтобы можно было написать такой код:
Средство поиска должно будет находить и распознавать CSV-файлы. А загрузчик — импортировать данные в формате CSV. Средства поиска и соответствующие им загрузчики зачастую можно реализовать в одном общем классе. Именно такой подход мы здесь и применим:
Например, добавив fieldnames (имена полей) в словарь модуля в строке 44, можно увидеть имена полей в CSV-файле:
Импорт: полезные советы
В завершение статьи покажем несколько хитрых приёмов, помогающих справиться с определёнными ситуациями, которые время от времени возникают. Увидим, как быть с недостающими пакетами, циклическим импортом и даже пакетами, хранящимися в ZIP-файлах.
Пакеты в разных версиях Python
Пока различные версии пакета совместимы, мы можем просто переименовывать пакет с помощью as :
Предыдущий пример можно переписать следующим образом:
Недостающие пакеты: используем альтернативу
Следующий сценарий применения тесно связан с предыдущим примером. Предположим, у нас есть совместимая повторная реализация пакета. Повторная реализация лучше оптимизирована, поэтому желательно использовать её, если она доступна. Но исходный пакет ещё более доступен и к тому же обеспечивает приемлемую производительность.
Похожий пример — пакет UltraJSON, сверхбыстрый кодер и декодер JSON, который может заменить json из стандартной библиотеки:
Переименовываем ujson в json и не задумываемся о том, какой именно пакет импортирован.
Недостающие пакеты: используем имитированную реализацию
Конкретизируем пример: будем использовать Colorama для добавления цветного текста в консоль. Colorama в основном состоит из специальных строковых констант, которые добавляют цвет при выводе на печать:
К сожалению, цвет не отображается в приведенном выше примере. В терминале он будет выглядеть примерно так:
Если же вы захотите вывести всё, например в синем цвете, то установите autoreset на False и добавьте Fore.BLUE к началу скрипта. Доступны следующие цвета:
И наконец, есть colorama.Cursor с кодом для управления положением курсора. Можно использовать для отображения хода выполнения или статуса запущенного скрипта. В следующем примере показывается обратный отсчет от 10 :
Обратите внимание: счётчик остается на месте, обратный отсчёт не показывается на отдельных строках, как происходит обычно:
Вернёмся к нашей задаче. Для многих приложений добавление цвета в консольный вывод — это круто, но не так чтобы очень необходимо. Чтобы не добавлять приложению очередную зависимость, надо использовать Colorama только в том случае, если последняя есть на компьютере, и не ломать приложение, если её нет.
Для этого можно попробовать тестирование и использование моков. Мок может заменить другой объект, позволяя контролировать его поведение. Вот наивная попытка сымитировать Colorama:
Но она не совсем работает, потому что Fore.RED представлен строкой, которая вносит сумятицу в вывод. В то время как нужно создать объект, который всегда выводит на экран пустую строку.
ColoramaMock(«») — это пустая строка, которая при вызове также возвращает пустую строку. Это фактически даёт нам повторную реализацию Colorama, только без цветов.
Модуль optional_color служит упрощённой заменой Colorama, поэтому мы можем обновить пример с обратным отсчётом с помощью поиска и замены:
Если запустить этот скрипт на компьютере без Colorama, он всё равно будет работать, разве что выглядеть может не так изящно:
А с установленной Colorama результаты будут такими же, что мы видели раньше.
Импорт скриптов в качестве модулей
Отличие скриптов от библиотечных модулей состоит в том, что скрипты обычно что-то делают, библиотеки же обеспечивают функциональность. И скрипты, и библиотеки находятся внутри обычных файлов Python, и с точки зрения Python между ними нет никакой разницы.
Разница в том, как файл должен использоваться: выполняться с помощью python file.py или импортироваться с помощью import file внутри другого скрипта?
Когда у вас есть модуль, который работает как скрипт и библиотека, можно попробовать выполнить рефакторинг этого модуля на два разных файла.
JSON часто читаются только машинами, поэтому многие файлы JSON не форматируются в виде, удобном для восприятия человеком. Так что файлы JSON, состоящие из одной очень длинной строки текста, — явление распространенное.
json.tool — это скрипт, который использует библиотеку json для форматирования JSON в более удобной для восприятия человеком форме:
Разделение скриптов и библиотек — это хорошая практика. Тем не менее в Python есть идиома, благодаря которой можно обращаться с модулем как скриптом и библиотекой одновременно. Как мы уже видели ранее, значение специальной переменной модуля __name__ устанавливается во время выполнения в зависимости от того, импортируется ли модуль или выполняется как скрипт.
Давайте проверим это! Создадим следующий файл:
При запуске этого файла увидим, что __name__ имеет специальное значение __main__ :
Но при импорте этого модуля значением __name__ будет имя модуля:
Это поведение используется в следующем шаблоне:
Возьмём пример побольше. Оставаться вечно молодыми нам поможет следующий скрипт, в котором любой «старый» возраст ( 25 года или больше) будет заменяться на 24 года:
Можно запустить это как скрипт, и он в интерактивном режиме будет делать вводимый вами возраст меньше:
Запуск скриптов Python из ZIP-файлов
Немного неясной представляется способность Python запускать скрипты, упакованные в ZIP-файлы. Её главное преимущество в возможности распространять весь пакет одним файлом.
Однако для этого нужно, чтобы Python был установлен на компьютере. Если хотите распространять свое приложение Python как автономный исполняемый файл, смотрите статью Using PyInstaller to Easily Distribute Python Applications (eng).
Если дать интерпретатору Python ZIP-файл, то он будет искать файл с именем __main__.py внутри ZIP-архива, извлечёт его и запустит. Проиллюстрируем это на простом примере, создадим следующий файл __main__.py :
При его запуске появится такое приветственное сообщение:
Теперь добавим его в ZIP-архив. Это можно сделать в командной строке:
А в Windows для этого можно использовать метод «укажи и щелкни». Выберите файл в «Проводнике», затем нажмите на нём правой кнопкой мыши и выберите Send to (Отправить) → Compressed (zipped) folder (Сжатая (заархивированная) папка).
Вспомним наш пример с созданием викторины, основанной на демографических данных. Можно распространять всё это приложение одним ZIP-файлом. importlib.resources позаботится о том, чтобы файл данных был извлечён из ZIP-архива, когда это потребуется.
Приложение состоит из следующих файлов:
Что делает эта команда: создает точку входа и упаковывает приложение.
Однако эта функция доступна только в Python 3.7 и более поздних версиях. Ещё больше узнать о zipapp можно в официальной документации.
Решение: добавить к population_quiz.pyz абсолютный путь. На Mac и Linux это можно сделать с помощью такого приёма:
Команда pwd расширяется до пути к текущему каталогу.
В завершение этой часть статьи рассмотрим, как importlib.resources помогают открывать файл данных. Ранее мы уже использовали для этого следующий код:
Более распространенный способ открытия файлов данных — обнаруживать их с помощью атрибута модуля __file__ :
Такой подход обычно хорошо работает. Но даёт сбой, когда приложение упаковывается в ZIP-файл:
Файл данных внутри ZIP-архива, поэтому open() не может его открыть. importlib.resources решает эту проблему: извлекает данные во временный файл и потом открывает его.
Циклический импорт
В системе импорта Python предусмотрены определённые возможности для работы с циклами импорта. Например, следующий код — хотя и не очень полезный — работает нормально:
При попытке в интерактивном интерпретаторе импортировать yin вместе с ним импортируется и yang :
Проделайте сами нечто подобное или что-то более толковое с модулями. Если вы в своих модулях определяете атрибуты и функции, всё это по-прежнему работает:
Импорт yin работает так же, как и раньше:
Проблемы с рекурсивным импортом начинают возникать, когда вы фактически используете другой модуль во время импорта, вместо того чтобы просто определять функции, которые впоследствии будут использовать другой модуль. Добавим одну строчку к yang.py :
И тут импорт приводит Python в замешательство:
Кроме этой проблемы, никаких сложностей при импортировании yang не возникнет:
Так как же нам избежать путаницы и не увязнуть в циклическом импорте? Наличие как минимум двух модулей, импортирующих друг друга, часто свидетельствует о том, что можно улучшить структуру модулей.
Часто решить проблему циклического импорта проще всего до момента его реализации. Если вы видите циклы в своих упрощённых структурах, присмотритесь повнимательнее и попробуйте разорвать эти циклы.
Тем не менее бывает целесообразно оставить цикл импорта. Как мы уже видели, это не проблема, пока модули определяют только атрибуты, функции, классы и так далее. Второй совет (тоже хорошая структурная практика) — предохранять модули от побочных эффектов во время импорта.
Если уж вам так нужны модули с циклами импорта и побочными эффектами, есть ещё один выход: выполняйте импорт локально внутри функций.
Теперь нет никаких проблем при импортировании и использовании yin :
Профиль импорта
Одна из проблем при импорте нескольких модулей и пакетов состоит в том, что это увеличивает время запуска скрипта. В зависимости от приложения она может быть критичной или некритичной.
Взгляните на пример countdown.py с Colorama, который был приведён чуть выше в этой статье:
В этом примере импортирование optional_color заняло почти 0,013 секунды. Большая часть этого времени была потрачена на импорт Colorama и её зависимостей. В столбце self показано время импорта без учета вложенного импорта.
Здесь импорт population занимает почти 2 секунды, из которых около 1,6 секунды тратятся в самом модуле, в основном на загрузку файла данных.
-X importtime — это отличный инструмент для оптимизации импорта. Если вам нужен более общий мониторинг и оптимизация кода, ознакомьтесь со статьёй Python Timer Functions: Three Ways to Monitor Your Code (eng).
Заключение
В этой статье мы познакомились с системой импорта Python. Как и многое другое, что есть в Python, она довольно проста в использовании для выполнения базовых задач, таких как импорт модулей и пакетов. В то же время система импорта достаточно сложная, гибкая и расширяемая. Мы с вами узнали ряд приёмов и особенностей, связанных с импортом, которые можно использовать в своём собственном коде.
Из этой статьи мы узнали, как:
На протяжении всей статьи мы видели много ссылок на дополнительную информацию. Наиболее авторитетным источником по системе импорта Python является официальная документация:
Теперь мы можем применять на практике полученные знания об импорте Python, следуя примерам этой статьи. Нажмите на ссылку ниже, чтобы перейти к исходному коду:
Получить исходный код: Нажмите здесь и получите исходный код, используемый для изучения системы импорта Python в этой статье.