Создаем свое первое приложение с Django, часть 4

Этот раздел – продолжение Части 3 учебника. Мы продолжим разрабатывать приложение для голосования и сосредоточимся на обработке форм и упрощении нашего кода.

Создадим простую форму

Отредактируем шаблон страницы опроса (“polls/detail.html”) из предыдущего раздела учебника, и добавим HTML элемент <form>:

<h1>{{ poll.question }}</h1>

{% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %}

<form action="/polls/{{ poll.id }}/vote/" method="post">
{% csrf_token %}
{% for choice in poll.choice_set.all %}
    <input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}" />
    <label for="choice{{ forloop.counter }}">{{ choice.choice }}</label><br />
{% endfor %}
<input type="submit" value="Vote" />
</form>

Краткий обзор:

  • Данный шаблон отображает radio-поле для каждого варианта ответа опроса. value поля содержит ID варианта опроса. name каждого поля равно "choice". Это означает, что при выборе поля и отправке формы, будет отправлены POST данные choice=3.

  • Значение action формы равно /polls/{{ poll.id }}/vote/, еще добавлено method="post". Использование method="post" (вместо method="get") очень важно, так как оправка формы изменяет данные. Для форм изменяющих данные используйте method="post". Этот совет не относится к Django, это хорошая практика для Web-приложений.

  • forloop.counter содержит номер итерации цикла тега for

  • Так как мы создаем POST форму (которая может привести к изменениям данных), нам следует побеспокоится о Cross Site Request Forgeries. Благодаря Django это очень просто. В общем, все POST формы, которые отправляются на внутренний URL, должны использовать тег {% csrf_token %}.

Тег {% csrf_token %} требует информацию из объекта запроса, которая обычно не находится в контексте шаблона. Что бы это исправить следует внести кое какие изменения в представление detail:

from django.template import RequestContext
# ...
def detail(request, poll_id):
    p = get_object_or_404(Poll, pk=poll_id)
    return render_to_response('polls/detail.html', {'poll': p},
                               context_instance=RequestContext(request))

Подробности о том, как это работает, смотрите в описании RequestContext.

Теперь создадим представление Django, которые принимает данные отправленные формой и обрабатывает их. Вспомним, в Части 3 мы создали URLconf который содержит следующую строку:

(r'^(?P<poll_id>\d+)/vote/$', 'vote'),

Мы так же создали функцию-“заглушку” vote(). Давайте создадим настоящую функцию представления. Добавьте следующее в polls/views.py:

from django.shortcuts import get_object_or_404, render_to_response
from django.http import HttpResponseRedirect, HttpResponse
from django.core.urlresolvers import reverse
from django.template import RequestContext
from polls.models import Choice, Poll
# ...
def vote(request, poll_id):
    p = get_object_or_404(Poll, pk=poll_id)
    try:
        selected_choice = p.choice_set.get(pk=request.POST['choice'])
    except (KeyError, Choice.DoesNotExist):
        # Redisplay the poll voting form.
        return render_to_response('polls/detail.html', {
            'poll': p,
            'error_message': "You didn't select a choice.",
        }, context_instance=RequestContext(request))
    else:
        selected_choice.votes += 1
        selected_choice.save()
        # Always return an HttpResponseRedirect after successfully dealing
        # with POST data. This prevents data from being posted twice if a
        # user hits the Back button.
        return HttpResponseRedirect(reverse('polls.views.results', args=(p.id,)))

Этот код содержит вещи, которые еще не объяснялись в учебнике:

  • request.POST – это объект с интерфейсом словаря, который позволяет получить отправленные данные через название ключа. В нашем случае request.POST['choice'] вернет ID выбранного варианта ответа в виде строки. request.POST всегда содержит строки.

    Заметим что Django так же предоставляет request.GET для аналогичного доступа к GET данным – но мы используем request.POST что бы быть уверенным, что данные передаются только при POST запросе.

  • request.POST['choice'] вызовет исключение KeyError, если choice не находится в POST. Код обрабатывает исключение KeyError и показывает страницу опроса с ошибкой, если не был выбран вариант ответа.

  • После увеличения счетчика ответов, представление возвращает HttpResponseRedirect вместо HttpResponse. HttpResponseRedirect принимает один аргумент: URL, на который необходимо перенаправить пользователя (обратите внимание как мы создаем URL).

    После успешной обработки POST запроса, вы должны возвращать HttpResponseRedirect. Это не относится конкретно к Django, это просто хорошая практика при разработке Web-приложений.

  • Мы используем функцию reverse() при создании HttpResponseRedirect. Это функция помогает избегать “хардкодинга” URL-ов в коде. Она принимает название URL-шаблона и необходимые аргументы для создания URL-а. В этом примере используется конфигурация URL-ов из Части 3 и reverse() вернет:

    '/polls/3/results/'

    ... где 3 значение p.id. При запросе к этому URL-у вызовется представление 'results' для отображения результатов опроса. Обратите внимание, вы должны использовать полное название к представлению (включая префикс).

Как упоминалось в Части 3, request является экземпляром HttpRequest. Подробности о классе HttpRequest смотрите в разделе о объектах запроса и ответа.

После ответа на опрос, представление vote() перенаправит пользователя на страницу с результатами. Давайте создадим представление для этой страницы:

def results(request, poll_id):
    p = get_object_or_404(Poll, pk=poll_id)
    return render_to_response('polls/results.html', {'poll': p})

Это представление аналогично представлению detail() из Части 3. Единственная разница - используемый шаблон. Повторение кода мы исправим позже.

Теперь создадим шаблон results.html:

<h1>{{ poll.question }}</h1>

<ul>
{% for choice in poll.choice_set.all %}
    <li>{{ choice.choice }} -- {{ choice.votes }} vote{{ choice.votes|pluralize }}</li>
{% endfor %}
</ul>

<a href="/polls/{{ poll.id }}/">Vote again?</a>

Теперь откройте страницу /polls/1/ в браузере и ответьте на опрос. Вы должны увидеть страницу с результатами, которые обновляются после каждого ответа на опрос. Если вы отправите форму не ответив на вопрос, вы должны увидеть сообщение про ошибку.

Общие представления: меньше кода - меньше проблем

Представления detail() (из Части 3) и results() до глупости просты – и, как упоминалось выше, избыточны. Представление index() (также из Части 3), так же довольно стандартное.

Эти представления выполняют стандартные операции Веб-приложений: получение данных из базы данных в соответствии с параметрами из URL, загрузка шаблона и возвращение результата выполнения шаблона. Так как это обычные операции Django представляет систему “общих представлений(generic views)”.

Общие представления позволяют создавать приложения практически не написав ни строчки кода Python.

Давайте используем их в нашем приложении. Необходимо выполнить следующие действия:

  1. Изменить URLconf.

  2. Удалить старые и ненужные представления.

  3. Изменить URL-ы для новых представлений.

Подробности читайте далее.

Why the code-shuffle?

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

Вы должны знать основы математики для использования калькулятора.

Первым делом откройте polls/urls.py. Вы должны увидеть следующее:

from django.conf.urls import patterns, include, url

urlpatterns = patterns('polls.views',
    url(r'^$', 'index'),
    url(r'^(?P<poll_id>\d+)/$', 'detail'),
    url(r'^(?P<poll_id>\d+)/results/$', 'results'),
    url(r'^(?P<poll_id>\d+)/vote/$', 'vote'),
)

Отредактируйте этот файл:

from django.conf.urls import patterns, include, url
from django.views.generic import DetailView, ListView
from polls.models import Poll

urlpatterns = patterns('',
    url(r'^$',
        ListView.as_view(
            queryset=Poll.objects.order_by('-pub_date')[:5],
            context_object_name='latest_poll_list',
            template_name='polls/index.html')),
    url(r'^(?P<pk>\d+)/$',
        DetailView.as_view(
            model=Poll,
            template_name='polls/detail.html')),
    url(r'^(?P<pk>\d+)/results/$',
        DetailView.as_view(
            model=Poll,
            template_name='polls/results.html'),
        name='poll_results'),
    url(r'^(?P<poll_id>\d+)/vote/$', 'polls.views.vote'),
)

Мы используем здесь два общих представления: ListView и DetailView. Эти два типа представлений отображают две концепции: “отображение списка объектов” и “отображение подробностей о конкретном объекте”.

  • Каждое общее представление должно знать с какой моделью работать. Ее можно указать с помощью параметра model.

  • Представление DetailView принимает значение первичного ключа из URL с названием "pk", по этому мы изменили название параметра с poll_id на pk.

  • Мы добавили название, poll_results, для представления, которое отображает страницу с опросом, что бы мы могли обратиться к этому URL-у позже (подробности смотрите в разделе о именованных URL-шаблонах). Мы так же используем функцию url() из django.conf.urls. Использовать url() - хорошая привычка при указании названия URL-шаблона.

По умолчанию представление DetailView использует шаблон <app name>/<model name>_detail.html. В нашем случае будет использоваться "polls/poll_detail.html". Параметр template_name позволяет указать Django какой шаблон использовать.

Аналогично ListView использует шаблон <app name>/<model name>_list.html, мы использовали template_name что бы определить другой шаблон - "polls/index.html".

В предыдущей части учебника в шаблоне использовался контекст с переменными poll и latest_poll_list. Для DetailView переменная poll добавляется автоматически – так как мы используем модель Poll, Django автоматически генерирует подходящее название для переменной контекста. Для ListView переменная будет называться poll_list. Что бы переопределить это название мы использовали параметр context_object_name указав latest_poll_list. Как вариант, вы можете изменить шаблон и использовать poll_list.

Теперь вы можете удалить функции index(), detail() и results() из polls/views.py. Они нам больше не нужны.

В представлении для голосования мы использовали функцию reverse() что бы избежать “хардкодинга” URL-а. Теперь нам необходимо чтобы reverse() возвращал URL на наше новое представление. Мы не можем использовать функцию представления – общее представление может использоваться для разных URL-ов – но мы можем использовать указанное название:

return HttpResponseRedirect(reverse('poll_results', args=(p.id,)))

Запустите сервер и протестируйте наше приложение.

Подробности об общих представлениях смотрите в соответствующем разделе.

Скоро будет

В будущем учебник планируется расширить следующими разделами:

  • Продвинутая обработка форм

  • Использование RSS

  • Использование кеширования

  • Использование комментариев

  • Использование прав в интерфейсе администратора

  • Использование JavaScript скриптов в интерфейсе администратора

Советуем прочитать “Куда двигаться далее”

« previous | up | next »