Каждый, кто меня знает, знает, что Django — мой любимый веб-фреймворк. 2 сентября 2014 года Django 1.7 наконец был выпущен публике после долгожданного ожидания. Некоторые из новых функций, появляющихся в 1.7, включают переработку загрузки приложений, пользовательские методы Queryset и множество незначительных обновлений, чтобы сделать разработку на Django более гладкой, чем когда-либо прежде.
Однако самой интересной функцией в новой версии является управление миграциями базы данных. Это обновление функции было вызвано в основном Эндрю Годвином после успешной кампании Kickstarter для работы над интеграцией. Эндрю — автор оригинального пакета миграции схемы South, и все сообщество навсегда благодарно за его вклад в платформу.
Когда я впервые использовал Twilio, я наткнулся на библиотеку-хелпер Randall Degges для Django, django-twilio. Я предложил свою техническую поддержку Randall после отправки ему письма о фантастической библиотеке, которую он создал. После некоторых отличных python-бантеров он дал мне доступ к репозиторию, чтобы продолжить работу, которую он начал.
С появлением Django 1.7 многоразовые приложения Django (термин, используемый для обозначения плагинов) будут нуждаться в обновлении для поддержки как миграций Django 1.7, так и миграций базы данных до Django 1.7.
Недавно мне пришлось обновить многоразовое приложение django-twilio, чтобы сделать именно это, и я решил задокументировать процедуру, чтобы предоставить другим разработчикам быстрое руководство по легкому обновлению своих собственных проектов.
Это руководство охватывает только поддержку управления миграциями базы данных для Django 1.7, а не другие новые функции 1.7.
Что мы будем охватывать
Это руководство предполагает, что вы знакомы с Python, virtualenv, PyPI и разработкой открытых проектов Django. Тем не менее, чтобы следовать принципам Python, я буду явным о шагах, необходимых для надежного обновления вашего многоразового приложения Django.
В этом руководстве я буду охватывать:
— Настройку двух отдельных виртуальных сред для Django 1.7 и Django 1.6 соответственно.
— Обновление файлов миграций для поддержки Django 1.7 и Django 1.6
— Запуск миграций для вашего многоразового приложения Django в обеих версиях
— Обновление документации для охвата обеих версий Django
Настройка виртуальных сред
Быстрейший и наиболее надежный способ проверить совместимость как с Django 1.7, так и с Django 1.6 — установить обе версии на отдельные виртуальные среды. Если вы не знакомы с virtualenv, это инструмент, который позволяет вам «изолировать» среды разработки Python, чтобы не возникли проблемы с зависимостями от нескольких проектов с несколькими версиями.
Новые виртуальные среды будут директориями внутри корня вашего проекта. Вам нужно будет перейти в корень директории вашего проекта.
Я буду использовать слово «django-package», чтобы обозначить многоразовое приложение Django, которое мы обновляем, поэтому обязательно замените его на имя вашего собственного многоразового приложения. Я также сделал скриншоты процедуры с django-twilio, чтобы предоставить вам визуальную поддержку.
С установленным virtualenv мы можем создать новые виртуальные среды с помощью следующих команд:
Это добавит множество папок в новую директорию *venv1.7/* и *venv1.6/*, которая будет заполнена пакетами Python позже.
Корневая директория вашего многоразового приложения Django должна теперь иметь две дополнительные дочерние директории:
Установка Django 1.7 и Django 1.6
Чтобы установить Django 1.7 в нашу директорию *venv1.7/*, нам сначала нужно активировать виртуальную среду, используя эту команду терминала:
Это добавит имя виртуальной среды, в которой вы сейчас находитесь, в строку команд терминала:
Мы можем затем установить Django 1.7 (и любые другие требования вашего проекта) с помощью следующих команд терминала:
Вы можете выйти из виртуальной среды *venv1.7/* с помощью команды терминала:
В этот момент вам нужно активировать директорию *venv1.6/*, используя те же команды, что и выше (но заменив «venv1.7» на «venv1.6»), и затем установить последнюю версию Django 1.6 и другие требования с помощью следующей команды терминала:
Нам также нужно установить South в этой виртуальной среде, если она еще не установлена:
Теперь у нас есть:
— Виртуальная среда под названием *venv1.7/* с установленным Django 1.7
— Виртуальная среда под названием *venv1.6/* с установленным Django 1.6.7 и South 1.0
С обеими версиями Django, готовыми к работе, мы можем теперь начать обновление нашего многоразового приложения, чтобы поддерживать их!
Поддержка всех версий Django!
Суть обновления многоразового приложения Django для поддержки обеих версий миграций Django сводится к двум вещам:
— Переименование старой директории миграций в south_migrations
— Использование Django 1.7 для создания новых миграций для вашего проекта
Первый шаг очень прост: просто переименуйте старую директорию миграций в вашем проекте (обычно в той же директории, что и models.py) в *south_migrations*. Эта директория теперь будет использоваться South для запуска миграций для проектов, которые не находятся на Django 1.7. Вы также захотите удалить все старые файлы .pyc в этой директории, используя следующую команду терминала:
Второй шаг немного более сложен: вам понадобится существующий проект Django, чтобы запустить команду makemigrations, используемую Django 1.7 для создания новых файлов миграций.
В проекте Django-twilio мы используем проект Django под названием test_project, который имеет все необходимые настройки для Django, чтобы создать новые миграции. Этот проект — это проект по умолчанию с ничего дополнительным, и он используется исключительно для создания или обновления файлов миграций. Я обнаружил, что это довольно надежный способ обновления миграций, но если вы знаете лучший способ, пожалуйста, скажите мне!
Из директории django-package нам нужно активировать виртуальную среду venv1.7:
Мы можем затем создать новый проект Django 1.7, под названием *test_project*, с помощью следующей команды терминала:
В проекте test_project нам нужно добавить наше многоразовое приложение Django в список установленных приложений, в *test_project/test_project/settings.py*:
Вам может потребоваться скопировать и вставить директорию *django_package* (ваше многоразовое приложение) в *test_project* тоже, это можно сделать просто:
Наконец, мы можем запустить команду *makemigrations*:
Что происходит?
На основе структуры проекта, которую мы составили, произойдет следующее:
— Python выполнит команду makemigrations через файл manage.py в проекте *test_project*.
— На основе settings.py в директории *test_project*, Django 1.7 проверит многоразовое приложение Django на наличие изменений. Поскольку это первый раз — не будет миграций, поэтому необходимо создать новый файл миграции!
— Django 1.7 сгенерирует новые файлы миграций:
Вот мы видим пример django_twilio, который я сделал ранее
Если Django выдает предупреждение «No changes detected in app», попробуйте удалить все старые файлы .pyc.
Вот и все: поддержка миграций Django 1.7 в вашем многоразовом приложении! Разве это не было легко?
Тестирование всего
Мы еще не закончили, однако. Хорошее многоразовое приложение Django будет полностью протестировано с последней версией. С виртуальной средой Django 1.7, все еще активной, и вашим django_package в файле settings.py, мы можем попробовать создать новые миграции в базе данных с помощью команды терминала:
Вывод будет чем-то похожим на это:
В этом примере Django 1.7 обнаружил мою библиотеку *django_twilio* и применил миграции для моделей. Идеально.
Вы теперь должны быть в состоянии деактивировать текущую виртуальную среду с помощью команды терминала:
и активировать виртуальную среду django1.6 с помощью:
Нам нужно будет добавить South в список установленных приложений быстро:
Стиль обработки миграций Django 1.6, используя South, должен все еще работать с двумя командами терминала. Вам, скорее всего, предложат добавить пользователя Admin в Django, вы можете набрать «no» в этом случае, нам не нужно:
Первая команда синхронизирует стандартные модели Django и South. Вторая команда затем использует South для миграции миграций вашего многоразового приложения Django отдельно. Если старая директория миграций была переименована в *south_migrations* правильно, вы должны увидеть аналогичный успешный вывод, как на изображении выше.
Если у вас возникли проблемы, попробуйте обновить South до South 1.0 и удалить старые файлы .pyc.
Наконец, скопируйте директорию многоразового приложения обратно из *test_project* и в старую корневую директорию проекта:
Теперь вы свободны зафиксировать изменения в git и выпустить новую версию.
Но мы еще не закончили
Документация является ключевой частью любого хорошего программного обеспечения, и многоразовые приложения Django не являются исключением. С появлением Django 1.7 важно, чтобы вы предоставили документацию по настройке вашего многоразового приложения с новым Django 1.7 и более старыми версиями. Не забудьте быть подробным о командах, необходимых для каждой версии. Документация для django-twilio предоставляет подробную информацию о Django 1.6 и ниже:
а также шаги для Django 1.7:
Для вдохновения я рекомендую прочитать страницу документации для django-twilio.
Загрузка в PyPI
Это руководство предполагает, что вы хорошо знакомы с загрузкой новых версий вашего многоразового приложения Django в PyPI, онлайн-репозиторий Python и многоразовых приложений Django. Теперь вам нужно загрузить ваше обновленное многоразовое приложение Django, чтобы другие разработчики могли воспользоваться новыми обновлениями Django 1.7. Если вы немного ржавеете или не уверены, как правильно упаковать и загрузить новую версию в PyPI, есть фантастическое руководство на Twilio от моего коллеги Pythonista Matt Makai. Нет строгого правила о том, какой тип обновления версии вам понадобится, но я предлагаю обновление 0.N, поскольку это изменение значимо. Если вы не уверены, проверьте правила семантического версионирования.
Окончательные шаги
Сегодня мы только что проработали, что необходимо для обновления вашего многоразового приложения Django для поддержки новой системы миграций, включенной в Django 1.7. Дополнительные функции Django 1.7 являются революционными и обязательно сделают разработку веб-приложений на Django более гладкой и легкой.