LXF167:Добавлять формы
|
|
|
Каркас для web-приложений. Добавим функциональности
Django: Данные и формы
Во второй части серии Джоно Бэкон показывает, как заранее загрузить в проект данные и дать пользователям внести свой вклад с помощью форм. [[Файл: |100px|left|thumb|Наш эксперт Джоно Бэкон – менеджер сообщества Ubuntu, автор книги «Искусство сообщества» и основатель ежегодного саммита руководителей сообщества. ]]
В LXF165/166 я написал введение в Django, и оказалось, что многим из вас, наших дорогих читателей, он понравился, и вы хотите узнать о нем больше. Поэтому я рад сообщить, что в нашей серии будут еще три прекрасных статьи. По окончании серии у вас будет все необходимое, чтобы написать полноценное web-приложение Django, которое изумит ваших друзей.
В первой части серии я показал, как создать простое приложение для управления ломбардом. Для этого мы создали проект Django, создали новое приложение в этом проекте, создали модель, активировали интерфейс администратора, чтобы добавить немного данных, и затем создали шаблон и представление для отображения списка результатов. Затем мы создали вид для отображения подробной информации каждого предмета, который хранится в ломбарде. В итоге получилось простое приложение, демонстрирующее основные возможности Django.
В этой части на основе предыдущей работы мы исследуем, как предварительно загрузить в проект данные и создать и применить формы, чтобы пользователи могли добавлять информацию в базу данных.
Предзагрузка проекта данными
Одна из самых приятных черт Django – автоматизированный интерфейс администратора. В других фреймворках обычно приходится создавать его вручную, на что уходит много времени и кода. В Django вы получаете его даром, и с ним очень удобно добавлять в базу новые данные, удалять записи и выполнять другие действия.
Во многих проектах Django удобно автоматически загрузить в проект данные заранее. В нашем примере с ломбардом у нас есть таблица Category. Если бы мы удалили базу данных и снова создали ее, пришлось бы снова добавлять все категории. В идеальном случае хорошо иметь набор категорий по умолчанию, который будет автоматически создаваться при создании базы данных. Для этого нужно создать кое-какие приспособления – фикстуры [fixtures].
Фикстура – это просто готовая запись, добавляемая в базу данных. Когда мы создадим фикстуры, Django автоматически импортирует их при создании новой базы данных. Вот мы их и понаделаем.
На это есть разные способы, но я покажу два простых подхода. Первый – воспользоваться YAML, простым форматом сериализации. Для начала создадим каталог fixtures в приложении Django (в данном случае, в каталоге inventory). Django ищет каталог fixtures в каждом приложении и автоматически загружает найденные фикстуры при создании базы данных.
Создадим файл initial_data.yaml в каталоге fixtures и добавим в него следующие строки:
- model: inventory.category
pk: 1
fields:
name: Watches
- model: inventory.category
pk: 2
fields:
name: Electronics
- model: inventory.category
pk: 3
fields:
name: Instruments
- model: inventory.category
pk: 4
fields:
name: Memorabilia
Одна из самых привлекательных особенностей Django – фантастическая документация. Официальную документацию можно найти на https://docs.djangoproject.com
У каждой версии документация своя. Обязательно проверьте, что используемая вами документация соответствует вашей версии Django. Чтобы узнать версию Django, просто скомандуйте
python manage.py version
Также обязательно задавайте все вопросы по Django в канале #django сети Freenode IRC – тамошний народ с удовольствием помогает.
Здесь мы добавили четыре записи в таблицу Category. Для каждого блока мы указываем имя модели (таблица Category внутри приложения inventory). Затем в поле pk мы указываем первичный ключ для каждого блока. Он должен быть уникальным числом. Обычно мы просто начинаем с 1 и увеличиваем его на единицу с каждым блоком. Наконец, мы указываем каждое поле в текущей модели блока (Category) и значение для этого поля. Поскольку наша модель Category имеет всего одно поле (name), это довольно просто; мы просто указываем его значение (например, Watches [Наручные часы]).
Чтобы загрузить фикстуры, просто удалите базу данных, удалив файл pawnstore.db в корневом каталоге проекта и выполнив команду
python manage.py syncdb
При генерации базы данных вы должны увидеть следующую строку:
Installed 4 object(s) from 1 fixture(s)
Она говорит о том, что наши четыре фикстуры были загружены в один файл fixture. Хотя этот подход создания фикстур удобен, он бывает скучным и приводит к ошибкам. Часть проблемы в том, что можно неверно указать первичные ключи, и для моделей с большим количеством полей на создание каждой фикстуры уходит больше времени. Другой подход – добавлять наши данные через интерфейс администратора и экспортировать фикстуры.
Чтобы применить этот подход, сначала удалите базу данных и создайте ее снова, чтобы у нас была свежая база данных. Теперь добавьте данные фикстур через интерфейс администратора. Добавляйте только те данные, которые нужно загрузить заранее, так как все, что вы добавите, экспортируется в фикстуры. Когда вы покончите с этим, сконвертируйте содержимое базы данных в файл YAML, запустив команду:
python manage.py dumpdata inventory format yaml > initial_data.yaml
Эта команда берет все данные из приложения inventory и записывает их в файл initial_data.yaml. Когда команда отработает, можете загрузить файл и посмотреть на сгенерированные данные. Затем просто поместите его в каталог inventory/fixtures, и он будет импортирован при следующем запуске команды python manage.py syncdb.
Добавляем данные через формы
Пока в наших приключениях с Django мы добавляли данные в базу только через интерфейс администратора. Это не самый удобный способ, да к тому же позволенный только администратору. Если вы хотите, чтобы информацию могли добавлять несколько пользователей, или хотите изменить способ добавления информации в базу данных, нужно создать форму.
Для новичков в web-программировании скажу, что формы – это интерактивные элементы управления, через которые можно добавлять информацию на сайт. Например, в почтовом клиенте (скажем, в Google Mail) форма применяется в окне создания письма, где вводятся получатель, тема и сообщение. Эти элементы управления вместе с кнопками Send/Cancel/Save Draft (Отправить/Отмена/Сохранить черновик) представляют собой форму.
К счастью, создавать формы в Django довольно просто. Рассмотрим пример добавления формы для добавления нового предмета в ломбард.
Первым делом добавьте в файл urls.py строку, которая будет соответствовать адресу добавления нового предмета. Откройте urls.py и вставьте в него следующую строку:
url(r’^newitem/$’, ‘inventory.views.newitem’, name=”newitem”),
Один из вопросов, которые я часто слышу, рассказывая о Django – «каким редактором лучше всего пользоваться для создания приложения в Django?»
На практике можно пользоваться почти любым редактором, способным создавать и сохранять текстовые файлы, но есть редакторы для web-программистов со специальными функциями, удобными при создании web-приложений в таких фреймворках, как Django.
Прежде всего и более всего я бы посоветовал Geany. В нем есть подсветка синтаксиса для Python, HTML и CSS, автоматическое закрытие HTML-тэгов, сворачивание кода, дополнение кода и встроенный терминал (где можно запускать python manage.py) и другие возможности. Обязательно загляните в наш учебник по Geany в LXF165/166.
Если Geany – герой не вашего романа, попробуйте такие редакторы:
» Bluefish http://bluefish.openoffice.nl – более старый житель мира редакторов для web-приложений. Он легок и быстр, в нем есть сворачивание кода и дополнение тэгов, а также простые интерфейсы для создания HTML-кода, которые пригодятся новичкам в HTML. Bluefish был разработан для Gnome и прекрасно интегрируется в Ubuntu, Fedora и другие популярные дистрибутивы.
» KompoZer www.kompozer.net. Этот редактор содержит полный набор возможностей для создания web-приложений. Он включает многие возможности Geany и Bluefish, а также содержит графические средства для создания кода HTML, CSS и других визуальных компонентов приложения.
Хотя с этими графическими утилитами удобно учиться создавать web-приложения, помните, что иногда код получается не слишком хорош – приглядывайте за его качеством, чтобы оно было на уровне.
> В Geany большее всего возможностей для написания кода на Python, HTML и CSS.
В этой строке мы связываем адрес http://127.0.0.1:8000/newitem/ с представлением newitem. Мы создадим его немного позже. Возможно, вы также заметили, что name=“newitem” есть только в этой строке. Благодаря этому атрибуту, позже мы сможем ссылаться на этот адрес по имени newitem. Тогда, если мы решим изменить адрес, шаблоны менять не придется.
Адрес задан, теперь создадим форму. Ветераны web-разработки сейчас подумали, что мы напишем форму на HTML. К счастью, в Django есть прекрасный способ избежать этой работы.
Одна из функций Django – ModelForms. Если вкратце, с ModelForms можно указать модель, куда нужно добавить данные (например, нашу модель Item), и Django создаст форму на основе типов полей. Например, в нашей модели Item поле Category ссылается на элемент модели Category, а ModelForm автоматически добавит различные категории в выпадающий список. Мы также задаем тип поля Name в CharField, которое будет добавлено в виде однострочного текстового поля. Затем мы задаем поле Description с типом TextField, оно будет добавлено в виде текстового поля большего размера.
Чтобы воспользоваться ModelForms, определим нашу новую форму. Для этого создайте новый файл forms.py в приложении inventory и добавьте в него следующий код:
from django.forms import ModelForm
from inventory.models import Item
class NewItemForm(ModelForm):
class Meta:
model = Item
В этом файле мы сначала импортируем модуль ModelForm, а затем импортируем нашу модель Item из приложения inventory. Затем создаем класс новой формы NewItemForm типа ModelForm. Мы будем создавать свой класс для каждой формы, которую нужно создать в проекте Django.
Затем мы создаем класс Meta как часть нашей формы и указываем, что воспользуемся моделью Item. Это означает, что при дальнейшем обращении к NewItemForm в нашем проекте мы будем обращаться к форме ModelForm, сгенерированной из нашей модели Item.
Создаем представление
Теперь создадим представление, которое будет загружено при открытии адреса http://127.0.0.1:8000/newitem/. Откройте файл views.py и обновите строку django.shortcuts, чтобы заодно импортировать модуль redirect:
from django.shortcuts import render_to_response, redirect
Мы будем использовать этот модуль, чтобы произвести перенаправление на другую страницу (нашу главную) после обработки формы и добавления содержимого в базу данных.
Теперь добавим следующую строку в начало файла:
from django.template import RequestContext
Здесь мы сначала импортируем RequestContext, это новый способ обработки нашего представления. Более подробно об этом позже. Теперь добавим весь код представления:
def newitem(request):
form = NewItemForm(request.POST or None)
if form.is_valid():
cmodel = form.save()
cmodel.save()
return redirect(index)
return render_to_response(‘inventory/newitem.html’, {‘item_form’: form}, context_instance=RequestContext(request))
Пройдемся по каждой строке этого представления. Сначала идет такая:
form = NewItemForm(request.POST or None)
Здесь мы создаем новый экземпляр ModelForm. Мы передадим его нашему шаблону позже. Затем мы проверяем, была ли форма проверена (когда пользователь отправил данные).
if form.is_valid():
Если форма была отправлена, мы создаем объект из данных формы и сохраняем его в базу данных:
cmodel = form.save()
cmodel.save()
Теперь объект сохранен в базе данных. Мы перенаправляем пользователя на главную страницу:
return redirect(index)
Если форма не была отправлена и проверена (и, следовательно, form.is_valid() не равно True), мы с помощью метода render_to_response() затем загружаем шаблон из формы и передаем его нашему объекту формы:
return render_to_response(‘inventory/newitem.html’, {‘item_form’: form}, context_instance=RequestContext(request))
В конце строки вы видите особый фрагмент context_instance =RequestContext(request). Одно из преимуществ RequestContext в том, что он предоставляет защиту от атак методом подделки межсетевых запросов [cross-site request forgery], также известных как атака в один клик или захват сессии [session riding]. Добавив к нашему шаблону токен CSRF, Django поможет защитить ваше приложение от подобных атак.
Теперь представление готово, и пора создать шаблон для обработки формы. В каталоге pawnstore/templates/inventory создайте файл newitem.html и добавьте в него следующий код:
Add New Item
<form action=”{% url newitem %}” method=”post”>{% csrf_token %}
Шаблон:Item form.as table<input type=”submit” value=”Save” />
</form>
В этом файле мы создаем тэг <form> и передаем код шаблона, который будет для вас новым:
<form action=”{% url newitem %}” method=”post”>
Синтаксис { % url newitem %} – это короткая ссылка на строку newitem в файле urls.py. Вы помните, что в этой строке мы указали имя name=“newitem”; ну, а теперь мы на него сослались. Как я отметил, для защиты от атак нам нужен токен CSRF, и теперь мы его добавим:
{% csrf_token %}
Затем мы добавляем саму главную форму:
Шаблон:Item form.as tableЗдесь мы просто создаем тэг
и из него обращаемся к item_form, которая была передана шаблону, используя as_table для отображения содержимого формы в виде таблицы. Наконец, мы добавляем кнопку Save (Сохранить) и закрываем форму: <input type=”submit” value=”Save” /> </form> Теперь форма должна работать, и с ее помощью вы сможете добавить новый объект в базу данных. После добавления элемента происходит перенаправление на индекс объектов.Настраиваем форму
Теперь форма готова, и можно кое-что изменить. Например, сейчас в нашей форме дату нужно вводить в особом формате:
YYYY-MM-DD
Это может запутать пользователей, к тому же в разных странах форматы даты разные.
Некоторые из читателей нашей серии уроков являются новичками в Python и HTML. Вот несколько отличных ссылок и ресурсов, которые помогут узнать о Python и HTML больше:
» Dive Into Python — www.diveintopython.net. Это отличная бесплатная книга Марка Пилгрима [Mark Pilgrim], представляющая собой исчерпывающее руководство по программированию на Python. В ней рассматриваются различные темы, такие как начальные знания, переменные, функции, объектно-ориентированное программирование, обработка файлов, регулярные выражения (полезные для нашего urls.py), обработка HTML и другие. Она также есть на DVD этого номера.
» W3Schools — www.w3schools.com – крупнейший сайт по обучению web-программированию в Cети. Содержит руководства и путеводители почти по всем аспектам web-программирования, включая HTML, CSS, JavaScript и многие другие.
Идеально было бы подставить в это поле текущую дату. Также стоит установить количество по умолчанию в 1, поскольку, скорее всего, каждый предмет будет в единственном числе.
Чтобы подставить в поле дату, нужно определить текущую дату, для чего воспользуемся модулем datetime. Сначала импортируем модуль в начале файла views.py:
import datetime
Теперь заполним форму. Для этого создадим новый экземпляр Item и заполним некоторые поля. Затем передадим его форме при ее создании.
Это означает, что форма заполняется заранее, и любые изменения в форме применяются к этому экземпляру. Мы также сохраняем его в базе данных.
В функции view объекта newitem(), создайте экземпляр объекта с такой первой строкой функции:
formdata = Item(dateadded = datetime.date.today().isoformat(), quantity = 1)
Здесь мы создаем новый экземпляр Item и задаем значения по умолчанию для каждого из полей. Текущая дата для поля «дата» у нас задается с помощью функции isoformat() модуля datetime.
Осталось просто сказать форме, чтобы она загружала этот экземпляр в качестве своих данных. Для этого измените строку, в которой создается экземпляр NewItemForm():
form = NewItemForm(request.POST or None, instance = formdata)
Мы здесь создаем экземпляр нашего элемента Item(). Если теперь перезагрузить форму, на ней появится дата.
Тут некоторые из вас могут поинтересоваться, зачем мы все равно спрашиваем у пользователя дату. Ее можно заполнять автоматически и даже не обязательно показывать пользователю.
В этом, несомненно, есть смысл, да и в других случаях тоже можно скрывать некоторые поля формы. Для этого обновим класс NewItemForm() в forms.py. Внутри класса, сразу после строки class Meta: добавьте следующее:
exclude = [ ‘dateadded’ ]
Потом перезагрузите форму и порадуйтесь тому, что поле с данными исчезло!
Далее, перейдем к другому этапу обработки формы, который мы еще не исследовали. Загрузите форму и заполните все поля, кроме одного (скажем, Description) – его не трогайте.
Вы увидите, что перед дальнейшей обработкой Django напомнит пользователю, что заполнены не все поля.
Это одна из по-настоящему удобных возможностей Django, ведь в большинстве фреймворков такое приходится обрабатывать вручную. Впрочем, иногда некоторые поля могут быть и пустыми – например, если они содержат опциональную информацию.
И настроить это, к счастью, довольно легко. Нужно лишь немного изменить наши модели данных в models.py.
Чтобы поле Description могло быть пустым, просто добавьте следующий код к определению поля в классе Item():
description = models.TextField(blank=True)
При добавлении blank=True поле будет принимать пустые значения; это будет отражено в базе данных.
В заключение
На нашем уроке мы перекрыли важный участок пути к нирване Django. Как и с любой технологией, чтобы сделать что-то хорошее, нужно практиковаться. Продолжайте писать код, выходить из трудных ситуаций – и совсем скоро вы будете создавать фантастические web-приложения.
На следующем уроке я покажу, как, не изучая CSS, украсить свое приложение профессиональными темами. Удачи, приятного программирования, и – увидимся! |