Простая проблема развертывания Python - целый мир боли

Разработка и развертывание кода Python значительно облегчается благодаря setuptools в сочетании с virtualenv и pip.

Основные идеи

Самая сложная часть, как я обнаружил, это запуск среды разработки, которая как можно точнее повторяет развернутую установку, и в то же время уважает инструменты и идиомы Pythonic. Но оказалось, что этого очень легко добиться с помощью pip и setuptools, которые вместе позволяют "установить" дерево разработки в среду Python без перемещения файлов. (На самом деле setuptools делает это сам по себе, но pip действует как front end для лучшей обработки зависимостей.)

Другой ключевой вопрос - подготовка чистой среды с известным набором пакетов для обеих сред. Virtualenv Python - просто находка в этом отношении, позволяющая вам настроить полностью индивидуальную среду Python с вашим собственным выбором пакетов, не требуя root-доступа, пакетов ОС (rpm или dpkg), и не будучи ограниченным пакетами и их версиями, которые установлены в вашем дистрибутиве.

Наконец, одним из раздражающих недостатков является сложность создания скриптов командной строки, которые хорошо работают с PYTHON_PATH. С этим довольно элегантно справляется setuptools.

Настройка

(Чтобы не усложнять ситуацию, здесь даны довольно подробные указания. Не стесняйтесь отклоняться от них по мере необходимости.)

1. Подготовьте рабочий каталог, в котором ваши Python-материалы смогут стать домом.
2. Возьмите последнюю версию virtualenv из нижней части этой страницы и распакуйте ее (неважно, где).

3. Из рабочего каталога создайте новое виртуальное окружение Python:

   $ python /virtualenv.py venv
   

4. Вы захотите выполнять большую часть своей работы из этой виртуальной среды. Для этого используйте эту команду (. - это сокращение для source):

   $ . venv/bin/activate
   

5. Установите pip:

   $ easy_install pip
   

6. Создайте каталоги для каждого устанавливаемого пакета, который вы хотите создать.

7. В каждой директории вам понадобится setup.py, определяющий содержимое и структуру пакета. Документация setuptools documentation - очень хороший ресурс для начала работы. Стоит потратить время на изучение больших ее частей.

Разработка

Когда ваша древовидная структура готова, вы почти готовы приступить к кодированию. Но сейчас пакеты, зависящие друг от друга, не видят друг друга так, как они будут видеться в развернутой среде. Эта проблема решается с помощью маленькой хитрости, которую предлагает setuptools и которую использует pip. Для каждого пакета, который вы разрабатываете, выполните следующую команду (убедитесь, что вы находитесь в виртуальной среде вашего проекта, как указано в шаге 3 выше):

$ pip install -e pkg1

Эта команда установит pkg1 в вашу виртуальную среду, причем без копирования каких-либо файлов. Она просто добавляет ссылку в каталог site-packages, указывающую на корень разработки пакета, и создает каталог egg-info в этом корне. Вы также можете сделать это без pip, следующим образом:

$ cd pkg1
$ python setup.py develop

И это обычно работает, но если у вас есть сторонние зависимости (которые должны быть указаны в setup.py, как объясняется здесь в документации по setuptools), pip будет умнее в их поиске.

Одна оговорка: ни setuptools, ни pip не умеют находить зависимости среди ваших собственных пакетов. Если PkgB в каталоге B зависит от PkgA в каталоге A, то pip install -e B потерпит неудачу, потому что pip не знает, что PkgA можно найти в каталоге A; вместо этого он попытается загрузить PkgA из его онлайн-репозитория. Обходной путь - просто установить каждый пакет после его зависимостей.

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

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

Развертывание

Когда ваши пакеты готовы к работе, вы можете использовать setup.py для создания пакетов развертывания. Здесь слишком много вариантов, но следующие должны помочь вам начать:

$ cd pkg1
$ python setup.py --help
$ python setup.py --help-commands

Свободные концы

Из-за широкой природы вопроса этот ответ будет неполным. Я не рассматривал долго работающие серверы, веб-фреймворки и сам процесс установки (в частности, использование --index-url в pip install для управления частным репозиторием сторонних и внутренних пакетов и -e vcs+.... , который будет извлекать пакеты из svn, git, hg или bzr). Но я надеюсь, что дал вам достаточно веревки, чтобы связать все это вместе (только не повесьтесь на ней:-).