Общее соглашение для библиотек python, которые также имеют интерфейсный модуль?

Question

Прямо сейчас у меня есть проект, который имеет следующую структуру:

foo/ 
    __init__.py 
    __main__.py 
    foo.py 

В этом случае foo.py на самом деле главный файл апи, поэтому разработчики призваны сделать «от Foo импорта Foo», но я также хотел сделать так, чтобы конечные пользователи могли просто запустить ~$ foo и получить интерфейс.

, который, когда я выполняю установку distutils, создает /usr/bin/__main__.py, потому что (а) я не знаю, как использовать distutils, [менее важно] и (б) я не уверен в том, что обычно считается правильным Вещь.

Насколько я могу сказать, у меня есть три варианта:

1. Make Distutils умнее, так что setup.py install создает симлинка /usr/bin/foo -> $PYTHONLIB/foo/__main__.py. Это моя непосредственная интуиция , и я, вероятно, мог бы выяснить, как это сделать, , хотя все, что я думаю о том, чтобы делать все, похоже на хаки , и я не нашел никого, кто об этом говорил.

2. Переименовать __main__.py только foo перед распределением, а также изменить вызов настройки Distutils' быть setup(scripts=['foo'], ...). Это очень похоже на (1), за исключением случаев, когда это происходит, я думаю.

3. Просто не включайте интерфейс с библиотечным пакетом. Я чувствую, что , как это зависит в основном от размера библиотеки/интерфейса, как , имеет ли смысл.

я не видел очень много пакетов, которые включают в себя __main__.py, если таковые имеются, так что я не уверен, что люди просто не использовать их, или я не использую правильные пакеты. Тот факт, что я не мог найти никаких сообщений в блогах или статей, касающихся __main__.py и distutils, говорит мне, что это не особенно популярная комбинация.

Answer 1

Объединяя ответ Ignacio Vazquez-Абрамс с некоторыми Googling, что привело меня найти this article about using _main_.py, я думаю, что я, вероятно, буду идти с компоновкой по линиям:

foo/ 
    foo/ 
     __main__.py 
     ... 
    scripts/ 
     foo 

где scripts/foo просто

#!/bin/sh 
exec python foo "$@" 

Это кажется, что он будет установлен неровно, и позволяют людям использовать мой модуль без установки, просто делая python path/to/foo.

Answer 2

Вызов модуля __main__.py - плохая идея, поскольку это имя имеет особое значение. Вместо этого используйте main sentinel в __init__.py и создайте скрипт, который делает exec python -m foo.