Создание вашей первой Django-приложения, часть 3

Этот учебник начинается там, где закончился Урок 2. Мы продолжаем приложение Web-poll и сосредоточимся на создании публичного интерфейса — «представлениях».

Обзор

Представление — это «тип» веб-страницы в вашем Django-приложении, который обычно выполняет определённую функцию и имеет определённую шаблонную страницу. Например, в приложении блога у вас могут быть следующие представления:

• Главная страница блога — отображает последние несколько записей.
• Страница «детали» записи — страница пермалинка для одной записи.
• Архив по годам — отображает все месяцы с записями в указанном году.
• Архив по месяцам — отображает все дни с записями в данном месяце.
• Архив по дням — отображает все записи в данный день.
• Действие комментария — обрабатывает публикацию комментариев к данной записи.

В нашем приложении опросы мы будем иметь следующие четыре представления:

• Страница вопроса «индекс» — отображает последние несколько вопросов.
• Страница вопроса «детали» — отображает текст вопроса, без результатов, но с формой для голосования.
• Страница вопроса «результаты» — отображает результаты для конкретного вопроса.
• Действие голосования — обрабатывает голосование за конкретный выбор в конкретном вопросе.

В Django веб-страницы и другой контент предоставляются представлениями. Каждое представление представляется функцией Python (или методом в случае представлений на основе классов). Django выберет представление, проанализировав URL-адрес запроса (точнее, часть URL-адреса после доменного имени).

Теперь, в своё время в интернете, вы, возможно, сталкивались с такими красотами, как ME2/Sites/dirmod.htm?sid=&type=gen&mod=Core+Pages&gid=A6CD4967199A42D9B65B1B. Вас обрадует, что Django позволяет нам гораздо более элегантные URL-шаблоны, чем это.

URL-шаблон — это общий вид URL-адреса, например: /newsarchive/<year>/<month>/.

Для перехода от URL-адреса к представлению Django использует то, что известно как «URLconfs». URLconf сопоставляет URL-шаблоны с представлениями.

Этот учебник предоставляет базовые инструкции по использованию URLconfs, и вы можете обратиться к Диспечеру URL для получения дополнительной информации.

Написание дополнительных представлений

Теперь добавим несколько дополнительных представлений в polls/views.py. Эти представления немного отличаются, так как они принимают аргумент:

def detail(request, question_id):
    return HttpResponse("You're looking at question %s." % question_id)

def results(request, question_id):
    response = "You're looking at the results of question %s."
    return HttpResponse(response % question_id)

def vote(request, question_id):
    return HttpResponse("You're voting on question %s." % question_id)

Подключите эти новые представления к модулю polls.urls , добавив следующие вызовы path():

from django.urls import path

from . import views

urlpatterns = [
    # ex: /polls/
    path('', views.index, name='index'),
    # ex: /polls/5/
    path('<int:question_id>/', views.detail, name='detail'),
    # ex: /polls/5/results/
    path('<int:question_id>/results/', views.results, name='results'),
    # ex: /polls/5/vote/
    path('<int:question_id>/vote/', views.vote, name='vote'),
]

Посмотрите в своём браузере на «/polls/34/». Он запустит метод detail() и отобразит любой ID, который вы укажете в URL. Попробуйте также «/polls/34/results/» и «/polls/34/vote/» — они отобразят страницы результатов и голосования.

Когда кто-то запрашивает страницу с вашего веб-сайта — скажем, «/polls/34/», Django загрузит модуль Python mysite.urls, поскольку он указан в настройке ROOT_URLCONF. Он находит переменную с именем urlpatterns и проходит по шаблонам в порядке. После нахождения совпадения в 'polls/', он удаляет соответствующий текст ("polls/") и отправляет оставшийся текст — "34/" — в URLconf ‘polls.urls’ для дальнейшей обработки. Там он находит '<int:question_id>/', что приводит к вызову представления detail() следующим образом:

detail(request=<HttpRequest object>, question_id=34)

Часть question_id=34 происходит из <int:question_id>. Использование угловых скобок «захватывает» часть URL и отправляет её в качестве аргумента ключевого слова функции представления. Часть :question_id> строки определяет имя, которое будет использоваться для идентификации сопоставленного шаблона, а часть <int: — преобразователь, определяющий, какие шаблоны должны соответствовать этой части пути URL.

Напишите представления, которые фактически что-то делают

Каждое представление отвечает за выполнение одного из двух действий: возвращение объекта HttpResponse, содержащего контент для запрошенной страницы, или возбуждение исключения, такого как Http404. Остальное зависит от вас.

Ваше представление может читать записи из базы данных или нет. Оно может использовать систему шаблонов, например, систему шаблонов Django, или стороннюю систему шаблонов Python, или нет. Оно может генерировать файл PDF, выводить XML, создавать ZIP-архив на лету — всё, что вы хотите, используя любые библиотеки Python, которые вам нужны.

Всё, что нужно Django, — это HttpResponse. Или исключение.

Для удобства давайте воспользуемся собственным API базы данных Django, который мы рассмотрели в Учебнике 2. Вот одна попытка нового представления index(), которое отображает последние 5 вопросов опроса в системе, разделённых запятыми, в соответствии с датой публикации:

from django.http import HttpResponse

from .models import Question


def index(request):
    latest_question_list = Question.objects.order_by('-pub_date')[:5]
    output = ', '.join([q.question_text for q in latest_question_list])
    return HttpResponse(output)

# Leave the rest of the views (detail, results, vote) unchanged

Однако здесь есть проблема: дизайн страницы жёстко закодирован в представлении. Если вы хотите изменить внешний вид страницы, вам нужно будет отредактировать этот код Python. Поэтому давайте воспользуемся системой шаблонов Django, чтобы разделить дизайн и Python, создав шаблон, который может использовать представление.

Сначала создайте каталог с именем templates в вашем каталоге polls. Django будет искать шаблоны там.

Настройка TEMPLATES вашего проекта описывает, как Django будет загружать и отображать шаблоны. Файл настроек по умолчанию настраивает бэкенд DjangoTemplates, у которого опция APP_DIRS установлена в True. По соглашению DjangoTemplates ищет подкаталог «templates» в каждом из приложений INSTALLED_APPS.

Внутри каталога templates, который вы только что создали, создайте ещё один каталог, назвав его polls, а в нём создайте файл с именем index.html. Другими словами, ваш шаблон должен находиться в polls/templates/polls/index.html. Из-за того, как работает загрузчик шаблонов app_directories, как описано выше, вы можете обратиться к этому шаблону в Django как к polls/index.html.

Вставьте следующий код в этот шаблон:

{% if latest_question_list %}
    <ul>
    {% for question in latest_question_list %}
        <li><a href="/polls/{{ question.id }}/">{{ question.question_text }}</a></li>
    {% endfor %}
    </ul>
{% else %}
    <p>No polls are available.</p>
{% endif %}

Теперь обновим наше представление index в polls/views.py для использования шаблона:

from django.http import HttpResponse
from django.template import loader

from .models import Question


def index(request):
    latest_question_list = Question.objects.order_by('-pub_date')[:5]
    template = loader.get_template('polls/index.html')
    context = {
        'latest_question_list': latest_question_list,
    }
    return HttpResponse(template.render(context, request))

Этот код загружает шаблон с именем polls/index.html и передаёт ему контекст. Контекст — это словарь, отображающий имена переменных шаблона в объекты Python.

Загрузите страницу, указав в браузере «/polls/», и вы должны увидеть список с пунктами, содержащим вопрос «Что нового» из Учебника 2. Ссылка ведёт на страницу подробностей вопроса.

Сокращение: render()

Очень часто используется фрагмент кода для загрузки шаблона, заполнения контекста и возвращения объекта HttpResponse с результатом рендеринга шаблона. Django предоставляет сокращение. Вот полное представление index(), переписанное:

from django.shortcuts import render

from .models import Question


def index(request):
    latest_question_list = Question.objects.order_by('-pub_date')[:5]
    context = {'latest_question_list': latest_question_list}
    return render(request, 'polls/index.html', context)

Обратите внимание, что после выполнения этих действий для всех представлений нам больше не нужно импортировать loader и HttpResponse (вам нужно сохранить HttpResponse , если у вас всё ещё есть методы-заглушки для detail, results, и vote).

Функция render() принимает в качестве первого аргумента объект запроса, во втором — имя шаблона, а в качестве необязательного третьего — словарь. Она возвращает объект HttpResponse заданного шаблона, отрисованного с заданным контекстом.

Выдача ошибки 404

Теперь давайте разберемся с детальным представлением вопроса — страницей, отображающей текст вопроса для заданного опроса. Вот представление:

from django.http import Http404
from django.shortcuts import render

from .models import Question
# ...
def detail(request, question_id):
    try:
        question = Question.objects.get(pk=question_id)
    except Question.DoesNotExist:
        raise Http404("Question does not exist")
    return render(request, 'polls/detail.html', {'question': question})

Новая концепция здесь: представление вызывает исключение Http404, если вопрос с запрошенным идентификатором не существует.

Мы обсудим, что вы можете поместить в этот polls/detail.html шаблон чуть позже, но если вы хотите быстро запустить пример выше, файл, содержащий только:

{{ question }}

поможет вам начать работу.

Сокращение: get_object_or_404()

Очень часто используется get() и вызывается Http404, если объект не существует. Django предоставляет сокращение. Вот представление detail(), переписанное:

from django.shortcuts import get_object_or_404, render

from .models import Question
# ...
def detail(request, question_id):
    question = get_object_or_404(Question, pk=question_id)
    return render(request, 'polls/detail.html', {'question': question})

Функция get_object_or_404() принимает в качестве первого аргумента Django модель и произвольное количество ключевых аргументов, которые она передаёт функции get() менеджера модели. Она вызывает Http404, если объект не существует.

Также есть функция get_list_or_404(), которая работает так же, как get_object_or_404(), за исключением использования filter() вместо get(). Она вызывает Http404, если список пуст.

Использование системы шаблонов

Вернемся к detail() представлению нашего приложения для опросов. Учитывая переменную контекста question, вот как может выглядеть шаблон polls/detail.html.

<h1>{{ question.question_text }}</h1>
<ul>
{% for choice in question.choice_set.all %}
    <li>{{ choice.choice_text }}</li>
{% endfor %}
</ul>

Система шаблонов использует синтаксис точечного поиска для доступа к атрибутам переменных. В примере {{ question.question_text }}, Django сначала выполняет поиск в словаре по объекту question. Если это не удается, он пытается найти атрибут — что работает в этом случае. Если поиск атрибута завершился неудачей, он бы попытался выполнить поиск по индексу списка.

Вызов метода происходит в цикле {% for %}: question.choice_set.all интерпретируется как Python-код question.choice_set.all(), который возвращает итерируемый набор объектов Choice и подходит для использования в теге {% for %}.

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

Удаление жестко закодированных URL-адресов в шаблонах

Помните, когда мы писали ссылку на вопрос в шаблоне polls/index.html, ссылка частично была закодирована следующим образом:

<li><a href="/polls/{{ question.id }}/">{{ question.question_text }}</a></li>

Проблема с этим жестко закодированным, тесно связанным подходом заключается в том, что при изменении URL-адресов в проектах с большим количеством шаблонов возникают сложности. Однако, поскольку вы определили аргумент name в функциях path() в модуле polls.urls, вы можете избавиться от зависимости от определённых URL-путей, определённых в вашей конфигурации URL, с помощью тега шаблона {% url %}:

<li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

Этот подход работает путём поиска определения URL, как указано в модуле polls.urls. Вы можете увидеть, где определено имя URL «detail» ниже:

...
# the 'name' value as called by the {% url %} template tag
path('<int:question_id>/', views.detail, name='detail'),
...

Если вы хотите изменить URL-адрес представления деталей опроса на что-то другое, например, на polls/specifics/12/ вместо того, чтобы делать это в шаблоне (или шаблонах), вы измените его в polls/urls.py:

...
# added the word 'specifics'
path('specifics/<int:question_id>/', views.detail, name='detail'),
...

Назначение имен URL-адресов

В проекте учебника всего один модуль, polls. В реальных проектах Django может быть пять, десять, двадцать или более приложений. Как Django различает имена URL-адресов между ними? Например, приложение polls имеет представление detail, и аналогичное представление может быть в приложении для блога в том же проекте. Как заставить Django знать, какое представление приложения создать для URL, когда используется тег шаблона {% url %}?

Ответ заключается в добавлении пространств имен в ваш URLconf. В файле polls/urls.py добавьте app_name для задания пространства имен приложения:

from django.urls import path

from . import views

app_name = 'polls'
urlpatterns = [
    path('', views.index, name='index'),
    path('<int:question_id>/', views.detail, name='detail'),
    path('<int:question_id>/results/', views.results, name='results'),
    path('<int:question_id>/vote/', views.vote, name='vote'),
]

Теперь измените шаблон polls/index.html из:

<li><a href="{% url 'detail' question.id %}">{{ question.question_text }}</a></li>

на указание на пространственное представление detail:

<li><a href="{% url 'polls:detail' question.id %}">{{ question.question_text }}</a></li>

Когда вы будете готовы к работе с представлениями, прочитайте часть 4 этого учебника, чтобы узнать основы обработки форм и общих представлений.