Rivalry2

HTML Diff

1 added 1 removed

Original 2026-01-01

Modified 2026-02-26

1 В разработке приложений есть такое понятие как точка входа. Понимание того, как правильно выделять точки входа, может значительно улучшить архитектуру вашего проекта и расширить его возможности.

2 <h2>Точка входа для приложения</h2>

3 Большинство приложений - это достаточно объемный проект, состоящий из множества модулей. Но когда запускается приложение, то запускается какой-то один конкретный исполняемый файл, он называетсяточкой входа:

4 Выше пример небольшого проекта из двух файлов:

5 <ul><li>my_application/module.py- определена функция, выводящая сообщение в консоль</li>

6 <li>my_application/scripts/main.py- импортируется и вызывается функция</li>

7 </ul>Модульmain.pyв таком проекте является точкой входа. Точку входа, как и прочие исполняемые файлы, принято располагать в директорииscripts. А сами исполняемые файлы часто называютскриптами. Также принято все необходимые вызовы делать внутри main(), функции без аргументов. И уже вызывая эту функцию, мы запускаем приложение.

8 В примере выше мы вызываем Python из окружения проекта командой uv run. Флаг -m означает "вызвать файл как модуль". В таком случае, Python осведомлен, что вызываемый файл не одиночный скрипт, а часть проекта с импортами из других модулей. Путь до модуля нужно передавать в формате через точку, начиная от корня проекта.

9 <h2>Специальная переменная __name__</h2>

10 В проекте бывают несколько точек входа. Каждая может работать как отдельное приложение и при этом использовать общую логику. Обычно в точке входа происходит вызов одной функции. Могут быть исключения, но всегда лучше стремиться к вызову одной единственной функции.

11 Создадим еще один скрипт и импортируем в него предыдущий:

12 Запустим его:

13 Сообщение вывелось дважды. Почему так? Чтобы импортировать функцию из модуля, интерпретатор читает и загружает модуль полностью. В этот момент будут выполнены все определения ивызовына уровне модуля. А значит, импортируя первый скрипт во второй, мы еще раз вызовем функцию main(). Выходит, нам нужно как-то различать ситуации двух типов:

14 <ul><li>Модуль работает как скрипт - выполняем вызовы</li>

15 - <li>Модуль импортируется - не выполняем вызовы</li>

15 + <li>Модуль импортируетс�� - не выполняем вызовы</li>

16 </ul>Для решения этой задачи мы можем воспользоваться специальной переменной __name__. Это одна из многих специальных переменных, которые загружаются интерпретатором на старте.

17 Кажется, что у переменной необычное имя - в нем целых четыре символа подчеркивания. На самом деле такие имена часто встречаются в Python-коде и как правило имеют какой-то специальный смысл. Опытный разработчик обычно помнит наизусть пару десятков таких переменных, поэтому про эти переменные любят спрашивать на собеседованиях.

18 Посмотрим, что хранит переменная __name__ в каждом конкретном случае:

19 <ul><li>Если происходит запуск в качестве скрипта, то переменная получает специальное значение - строку '__main__'</li>

20 <li>Если происходит обычный импорт, то эта переменная содержит полное имя модуля</li>

21 </ul>Проверив значение этой переменной, мы можем отличить запуск в качестве скрипта от импортирования. Перепишем первый скрипт main.py с применением этого нового знания:

22 И проверим:

23 Сообщение вывелось один раз, ведь условие if __name__ == "__main__": при импорте не выполнится, и функция main() не вызовется.

24 Изначальный скрипт тоже работает как полагается:

25 <h2>uv и точка входа</h2>

26 Каждый раз вводить полное имя модуля довольно затратно, да и неправильно. Пользователь нашей программы не должен знать о ее внутреннем устройстве, о структуре файлов. Должна быть короткая команда для запуска программы. uv предоставляет возможность указать точку входа проекта, после чего его можно запускать одной командой uv run <точка-входа>.

27 Для начала нужно отредактировать файл конфигурации проектаpyproject.toml:

28 Мы добавляем две группы секции. Первая, [build-system] и [XX.build.targets.wheel] указывает менеджеру, что наш проект этопакетсо своими импортами и точкой входа. При следующем запуске, uv также установит наш проект в виртуальное окружение.

29 Вторая группа, [project.scripts] указывает на точки входа в проекте. Название точки записывается через дефис. А путь до нее указывается как полный путь, через точку, до скрипта и после двоеточия сама функция запуска.

30 Теперь мы можем запустить проект короткой командой uv run <точка-входа>:

31 <h2>Точка входа для библиотеки</h2>

32 Если в приложениях точкой входа является место, где происходит вызов самого приложения в виде функции или какого-то кода, то для библиотек ситуация иная. В библиотеках мы не должны в обычной ситуации вызывать код. Библиотека предоставляет функцию или набор функций, а когда их вызывать решает тот, кто импортирует библиотеку в свой модуль.

33 Например, библиотека more-itertools предоставляет различный набор вспомогательных функций. Мы можем импортировать любое количество функций из этой библиотеки, и сами решать какую когда использовать:

34 Когда мы указываем подобный импорт, мы не указываем путь до конкретного файла, откуда нужно импортировать функцию, а только указываем название библиотеки. Но как тогда интерпретатор узнает где находится нужная нам функция? Для решения, нам нужно экспортировать "наружу", на верхний уровень библиотеки необходимые функции или целые модули. В этом нам понадобится файл__init__.py

35 Обычная задача модуля__init__.pyв том, чтобы указывать интерпретатору, что директория с файлами это пакет, чтобы он мог разруливать импорты. Но также в нем можно перечислить все функции, что мы хотим экспортировать наружу. Добавим в__init__.pyнашего проекта запись:

36 Сперва мы импортируем необходимые нам функции или целые модули. Затем вписываем кортеж из них в еще одну особую переменную __all__. Теперь, тем, кто будет использовать эту библиотеку, не нужно знать в каком файле определены функции. При импорте нашей библиотеки, экспортируется все перечисленное в __all__.

37 Подобный файл с экспортами функций и модулей для пользования нашей библиотекой называютфасадом.

38 <h2>Итог</h2>

39 Мы познакомились с точками входа для приложений и библиотек. Разобрали, что для приложений точка входа является местом, где начинается выполнение кода, а для библиотек это модуль__init__.pyс экспортом сущностей. Все, что мы обсудили, тесно связано с проектированием проекта и позволит заложить фундамент хорошей архитектуры для сложных проектов.