Написание вашего первого приложения 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 каждой радиокнопки — это идентификатор соответствующего варианта ответа на вопрос. name каждой радиокнопки — "choice". Это означает, что когда кто-то выбирает одну из радиокнопок и отправляет форму, он отправит данные POST choice=#, где # — ID выбранного варианта. Это базовая концепция 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 для приложения опросов, который включает эту строку:

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

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

from django.db.models import F
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 = F("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'] возвращает ID выбранного варианта ответа в виде строки. Значения request.POST всегда являются строками.

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

• request.POST['choice'] будет генерировать KeyError, если choice не был предоставлен в данных POST. Приведенный выше код проверяет на KeyError и повторно отображает форму опроса с сообщением об ошибке, если choice не указан.
• F("votes") + 1 инструктирует базу данных увеличить счетчик голосов на 1.

• После увеличения счетчика выбранного варианта код возвращает 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 см. в документации по запросам и ответам.

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

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, чтобы написать приложение. Например, универсальные представления ListView и DetailView абстрагируют понятия «отображение списка объектов» и «отображение страницы подробностей для определённого типа объекта» соответственно.

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

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.db.models import F
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.
    ...