Python project main file

Python Apps the Right Way: entry points and scripts

There are multiple ways to write an app in Python. However, not all of them provide your users with the best experience.

One of the problems some people encounter is writing launch scripts. The best way to handle this is the Entry Points mechanism of Setuptools, and a __main__.py file. It’s quite easy to implement. If you’re interested, read on to learn more!

Requirements and Desired Results

• a Python project
• a setup.py file using setuptools
• the following directory structure:
  • entry_points_project/
  • • my_project/
    • • __init__.py
      • __main__.py

      ( entry_points_project is also where the README and other auxiliary files go, while my_project contains all the Python code.)

      When you’re done, you will have a project that can be executed by:

      Provided that you have your Python directory and its Scripts\ subdirectory on the %PATH%, this will also work in Windows.

      Looking for a project template?

      If you want to create a well-structured project with release automation and some other goodies, check out my Python Project Template.

      Step 1: create a __main__.py file

      In order to implement the first desired result, you need to create a __main__.py file in your package. This file needs to contain a main() function that takes no arguments, and also a special passage to determine code to run:

      import sys

      def main ( args = None ):

      «»»The main routine.»»»

      if args is None :

      args = sys . argv [ 1 :]

      print ( «This is the main routine.» )

      print ( «It should do something interesting.» )

      # Do argument parsing here (eg. with argparse) and anything else

      # you want your project to do. Return values are exit codes.

      if __name__ == «__main__» :

      sys . exit ( main ())

      1. The if __name__ == «__main__»: idiom, as documented here, is used to check whether this is executed as the top-level file, or if it has been imported by someone else (in this case, executing the main() function is not always intended).
      2. The main() function must not take any arguments, because that’s how entry_points executes things.

      Step 2: adjust setup.py accordingly

      This is the real deal: create the entry points in your setup.py file.

      from setuptools import setup

      setup (

      name = «my_project» ,

      version = «0.1.0» ,

      packages = [ «my_project» ],

      entry_points =

      «console_scripts» : [

      «my_project = my_project.__main__:main»

      ]

      >,

      )

      1. You must use setuptools, otherwise this won’t work.
      2. The most important piece of code is the entry_points declaration (unsurprisingly).
      3. The declaration reads

      "name_of_executable = module.with:function_to_execute"

      1. If you are developing a GUI application (in Tkinter, PyQt/PySide, wxPython, PyGTK, PyGame…), you should change the declaration to gui_scripts . On *nix, this makes no difference, but on Windows, it means that running your script by opening the created .exe files does not show a console window. Note that stdout/stderr do not work in that mode under Windows, which can lead to spurious application crashes. (GUI-only processes cannot use stdout/stderr because they don’t have a console attached)
      2. You can create multiple scripts this way. You can also have multiple console_scripts and gui_scripts in one setup file.

      All code samples are freely reusable, but if you mention where you got them from, it’d be really nice.

      That’s all!

      Hopefully, the guide worked for you and your Python apps have good launch scripts for all platforms. If so, great! Otherwise, make sure you did everything as stated in this guide. If you are still stuck, ask for help in the comments.

      this site uses cookies.
      by using this site, you agree to our cookie and privacy policy.

      powered by Nikola, nginx and Hetzner Cloud
      copyright © 2009–2023 Chris Warrick
      CC BY-NC-SA, unless stated otherwise

      Источник

      Используйте __main__.py

      Зачем нужен __init__.py знает, наверное, любой питонист, но что насчёт __main__.py? Я видел немало проектов либо рабочих, либо на Github, которые не используют этот магический файл, хотя могли бы сделать свою жизнь проще. На мой взгляд, __main__.py это лучший способ для взаимодействия с питоновскими модулями, состоящими из нескольких файлов.

      Но давайте сначала разберёмся: как большинство людей запускают свои скрипты на Python?

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

      if __name__ == '__main__': main(sys.argv)

      Когда вы скармливаете скрипт интерпретатору, магическая глобальная переменная __name__ получает значение __main__. Таким образом мы узнаём, что это не импорт, а именно запуск. Например:

      И это прекрасно работает для одиночного файла.

      Проблема

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

      . ├── README.me ├── requirements.txt ├── setup.py └── src ├── __init__.py ├── client.py ├── logic.py ├── models.py └── run.py

      Но пользователю, который склонировал проект из репозитория будет непонятно — какой из этих файлов главный? Неужели run.py? А может client.py? Где же искать знакомую строку if __name__ == ‘__main__’? Вот здесь-то __main__.py и способен проявить себя.

      __main__.py

      Файл __main__.py вызывается при запуске проекта с флагом модуля — -m. И это весьма удобно, если код предназначен и для использования в качестве модуля, и для запуска из консоли. Думайте об этом файле, как о месте куда можно класть всё, что вы обычно кладёте внутрь if __name__ == ‘__main__’. Давайте изменим проект из примера выше соответственно:

      . ├── README.me ├── requirements.txt ├── setup.py └── myapp ├── __init__.py ├── __main__.py ├── client.py ├── logic.py ├── models.py

      И, вуаля! Теперь можно просто запускать проект как обычный модуль.

      __main__.py будет выполняться автоматически. Это идеальное место для размещения интерфейса командной строки и обработки входных аргументов!

      Источник

      Читайте также:  Двоичный поиск python код