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

Пишем минимальную форму¶

Давайте обновим наш детальный шаблон опроса («polls/detail.html») из последнего урока, чтобы шаблон содержал HTML-элемент <form>:

<form action="{% url 'polls:vote' question.id %}" method="post">
{% csrf_token %}
<fieldset>
    <legend><h1>{{ question.question_text }}</h1></legend>
    {% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %}
    {% for choice in question.choice_set.all %}
        <input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}">
        <label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label><br>
    {% endfor %}
</fieldset>
<input type="submit" value="Vote">
</form>

Краткое изложение:

• Приведенный выше шаблон отображает переключатель для каждого вопроса. value каждого переключателя является идентификатором (ID) соответствующего вопроса. name каждой радиокнопки - это "choice". Это означает, что когда кто-то выбирает один из переключателей и отправляет форму, он отправляет POST-данные choice=# где # - идентификатор выбранного варианта. Это основная концепция форм HTML.
• Мы установили для action формы значение {% url 'polls:vote' question.id %}, а для method="post" - значение . Использование method="post" (в отличие от method="get") очень важно, поскольку при отправке формы данные будут изменяться на стороне сервера. Всякий раз, когда вы создаете форму, изменяющую данные на стороне сервера, используйте method="post". Этот совет не относится к Django; это хорошая практика веб-разработки в целом.
• forloop.counter указывает, сколько раз тег for прошел цикл
• Поскольку мы создаем форму POST (которая может повлиять на изменение данных), нам нужно беспокоиться о подделках межсайтовых запросов. К счастью, вам не нужно слишком сильно беспокоиться, потому что Django поставляется с полезной системой для защиты от него. Короче говоря, все формы POST, предназначенные для внутренних URL-адресов, должны использовать тег шаблона {% csrf_token %}.

Теперь давайте создадим представление Django, которое обрабатывает отправленные данные и что-то с ними делает. Помните, в Части 3 мы создали URLconf для приложения polls, включающего следующую строку:

path("<int:question_id>/vote/", views.vote, name="vote"),

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

from django.http import HttpResponse, HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.urls import reverse

from .models import Choice, Question


# ...
def vote(request, question_id):
    question = get_object_or_404(Question, pk=question_id)
    try:
        selected_choice = question.choice_set.get(pk=request.POST["choice"])
    except (KeyError, Choice.DoesNotExist):
        # Redisplay the question voting form.
        return render(
            request,
            "polls/detail.html",
            {
                "question": question,
                "error_message": "You didn't select a choice.",
            },
        )
    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:results", args=(question.id,)))

Этот код включает в себя несколько моментов, которые мы еще не рассмотрели в этом руководстве:

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

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

• request.POST ['choice'] будет вызывать KeyError, если ключ choice не был предоставлен в POST. Приведенный выше код проверяет KeyError и повторно отображает форму вопроса с сообщением об ошибке, если choice не задано.

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

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

• В этом примере мы используем функцию reverse() в конструкторе HttpResponseRedirect. Эта функция помогает избежать жесткого кодирования URL-адреса в функции представления. Ему дается имя представления, которому мы хотим передать управление, и переменная часть шаблона URL, которая указывает на это представление. В этом случае, используя URLconf, который мы настроили в Части 3, вызов reverse() вернет строку, подобную

  "/polls/3/results/"
  

  где 3 - это значение question.id. Этот перенаправленный URL-адрес затем вызовет представление 'results', чтобы отобразить последнюю страницу.

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

После того, как кто-то проголосовал в опросе, представление voice() перенаправляет на страницу результатов для опроса. Давайте напишем это представление:

from django.shortcuts import get_object_or_404, render


def results(request, question_id):
    question = get_object_or_404(Question, pk=question_id)
    return render(request, "polls/results.html", {"question": question})

Оно почти такое же, как представление detail() из Части 3. Разница лишь в названии шаблона. Мы исправим эту избыточность позже.

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

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

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

<a href="{% url 'polls:detail' question.id %}">Vote again?</a>

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

Используйте базовые представления: чем меньше кода, тем лучше¶

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

Эти представления представляют собой обычный случай базовой веб-разработки: получение данных из базы данных в соответствии с параметром, переданным в URL, загрузка шаблона и возвращение отрисованного шаблона. Поскольку это так часто встречается, Django предоставляет короткий путь, называемый системой «общих представлений».

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

Давайте преобразуем наше приложение для опроса, чтобы использовать систему общих представлений, чтобы мы могли удалить часть нашего собственного кода. Мы должны сделать несколько шагов, чтобы сделать преобразование. Мы будем:

1. Преобразование URLconf.
2. Удаление некоторых старых, ненужных представлений.
3. Введите новые представления, основанные на базовых представлениях Django.

Продолжайте чтение для ознакомления с деталями.

from django.urls import path

from . import views

app_name = "polls"
urlpatterns = [
    path("", views.IndexView.as_view(), name="index"),
    path("<int:pk>/", views.DetailView.as_view(), name="detail"),
    path("<int:pk>/results/", views.ResultsView.as_view(), name="results"),
    path("<int:question_id>/vote/", views.vote, name="vote"),
]

from django.http import HttpResponseRedirect
from django.shortcuts import get_object_or_404, render
from django.urls import reverse
from django.views import generic

from .models import Choice, Question


class IndexView(generic.ListView):
    template_name = "polls/index.html"
    context_object_name = "latest_question_list"

    def get_queryset(self):
        """Return the last five published questions."""
        return Question.objects.order_by("-pub_date")[:5]


class DetailView(generic.DetailView):
    model = Question
    template_name = "polls/detail.html"


class ResultsView(generic.DetailView):
    model = Question
    template_name = "polls/results.html"


def vote(request, question_id):
    ...  # same as above, no changes needed.