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

Научимся на примере.

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

Оно будет состоять из двух частей:

• Веб-сайт для просмотра опросов и голосования.
• Админ-панель для добавления, изменения и удаления опросов.

Предполагается, что у вас уже установлен Django. Вы можете проверить установку и версию Django, выполнив следующую команду в командной строке (обозначена префиксом $):

$ python -m django --version

...\> py -m django --version

Если Django установлен, вы увидите номер вашей версии. Если нет, появится ошибка «No module named django».

Это руководство написано для Django 3.0, который поддерживает Python 3.6 и выше. Если версия Django отличается, вы можете обратиться к руководству для вашей версии Django, используя переключатель версий в правом нижнем углу этой страницы или обновить Django до последней версии. Если вы используете более старую версию Python, ознакомьтесь с Какой версии Python можно использовать с Django?, чтобы найти совместимую версию Django.

См. Как установить Django за рекомендациями по удалению старых версий Django и установке новой.

Создание проекта

Если это ваш первый опыт работы с Django, вам нужно будет выполнить первоначальную настройку. В частности, вам нужно будет сгенерировать код, который создаст проект Django, – коллекцию настроек для экземпляра Django, включая конфигурацию базы данных, специфичные для Django параметры и настройки для приложений.

В командной строке перейдите в cd каталог, где вы хотите сохранить свой код, а затем выполните следующую команду:

$ django-admin startproject mysite

...\> django-admin startproject mysite

Это создаст mysite каталог в текущем каталоге. Если это не сработало, см. Проблемы с запуском django-admin.

Давайте посмотрим, что создал startproject:

mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        asgi.py
        wsgi.py

Эти файлы:

• Внешний mysite/ корневой каталог — контейнер для вашего проекта. Его имя для Django не имеет значения; вы можете переименовать его в любое другое.
• manage.py: утилита командной строки, позволяющая взаимодействовать с этим проектом Django различными способами. Все подробности о manage.py можно узнать в django-admin и manage.py.
• Внутренний mysite/ каталог — фактический пакет Python для вашего проекта. Его имя — имя пакета Python, которое вам нужно использовать для импорта всего, что находится внутри (например, mysite.urls).
• mysite/__init__.py: пустой файл, который сообщает Python, что этот каталог следует рассматривать как пакет Python. Если вы новичок в Python, прочитайте подробнее о пакетах в официальной документации Python.
• mysite/settings.py: Настройки/конфигурация для этого проекта Django. Настройки Django расскажут вам о том, как работают настройки.
• mysite/urls.py: Объявления URL для этого проекта Django; «оглавление» вашего сайта на Django. Подробнее об URL можно прочитать в диспетчере URL.
• mysite/asgi.py: Точка входа для серверов веб-приложений, совместимых с ASGI, для обработки запросов вашего проекта. Подробнее см. в Как развернуть с помощью ASGI.
• mysite/wsgi.py: Точка входа для веб-серверов, совместимых с WSGI, для обработки запросов вашего проекта. Подробнее см. в Как развернуть с помощью WSGI.

Сервер разработки

Проверим работоспособность вашего проекта Django. Перейдите в внешний mysite каталог, если еще не сделали этого, и выполните следующие команды:

$ python manage.py runserver

...\> py manage.py runserver

В командной строке вы увидите следующее:

Performing system checks...

System check identified no issues (0 silenced).

You have unapplied migrations; your app may not work properly until they are applied.
Run 'python manage.py migrate' to apply them.

November 02, 2020 - 15:50:53
Django version 3.0, using settings 'mysite.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

Вы запустили сервер разработки Django — легкий веб-сервер, написанный полностью на Python. Мы включили его в Django, чтобы вы могли быстро разрабатывать, не заботясь о настройке сервера (например, Apache) до тех пор, пока вам не понадобится производство.

Сейчас важно отметить: не используйте этот сервер в производственной среде. Он предназначен только для разработки. (Мы занимаемся разработкой фреймворков, а не веб-серверов.)

После запуска сервера перейдите по адресу http://127.0.0.1:8000/ в вашем веб-браузере. Вы увидите страницу «Поздравляем!», с взлетающей ракетой. Всё сработало!

$ python manage.py runserver 8080

...\> py manage.py runserver 8080

$ python manage.py runserver 0:8000

...\> py manage.py runserver 0:8000

Создание приложения Polls

Теперь, когда ваша среда — «проект» — настроена, вы можете начать работу.

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

Ваши приложения могут находиться в любой точке вашего пути Python. В этом руководстве мы создадим наше приложение опросов в том же каталоге, что и файл manage.py, чтобы его можно было импортировать как отдельный модуль верхнего уровня, а не как подмодуль mysite.

Чтобы создать приложение, убедитесь, что вы находитесь в том же каталоге, что и файл manage.py, и введите эту команду:

$ python manage.py startapp polls

...\> py manage.py startapp polls

Это создаст каталог polls, который выглядит так:

polls/
    __init__.py
    admin.py
    apps.py
    migrations/
        __init__.py
    models.py
    tests.py
    views.py

Эта структура каталогов будет содержать приложение опросов.

Напишите свой первый вид

Давайте напишем первый вид. Откройте файл polls/views.py и поместите в него следующий Python-код:

from django.http import HttpResponse


def index(request):
    return HttpResponse("Hello, world. You're at the polls index.")

Это самый простой возможный вид в Django. Чтобы вызвать вид, нам нужно сопоставить его с URL-адресом — для этого нам нужен URLconf.

Чтобы создать URLconf в каталоге polls, создайте файл под названием urls.py. Каталог вашего приложения теперь должен выглядеть так:

polls/
    __init__.py
    admin.py
    apps.py
    migrations/
        __init__.py
    models.py
    tests.py
    urls.py
    views.py

В файле polls/urls.py включите следующий код:

from django.urls import path

from . import views

urlpatterns = [
    path('', views.index, name='index'),
]

Следующим шагом является указание корневого URLconf на модуль polls.urls. В mysite/urls.py, добавьте импорт для django.urls.include и вставьте include() в список urlpatterns, так что у вас будет:

from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path('polls/', include('polls.urls')),
    path('admin/', admin.site.urls),
]

Функция include() позволяет ссылаться на другие URLconf. Всякий раз, когда Django сталкивается с include(), она отсекает ту часть URL, которая совпала до этого момента, и отправляет оставшуюся строку включенному URLconf для дальнейшей обработки.

Идея, стоящая за include(), заключается в том, чтобы легко подключать и использовать URL-адреса. Поскольку опросы находятся в собственном URLconf (polls/urls.py), их можно разместить под «/polls/», или под «/fun_polls/», или под «/content/polls/», или под любым другим корневым путем, и приложение по-прежнему будет работать.

Вы теперь подключили представление index в URLconf. Проверьте его работу с помощью следующей команды:

$ python manage.py runserver

...\> py manage.py runserver

Перейдите по адресу http://localhost:8000/polls/ в вашем браузере, и вы должны увидеть текст «Привет, мир. Вы находитесь на странице опросов.», который вы определили в представлении index.

Функция path() принимает четыре аргумента, два обязательных: route и view, и два необязательных: kwargs, и name. На этом этапе стоит рассмотреть назначение этих аргументов.

path() аргумент: route

route — это строка, содержащая шаблон URL. При обработке запроса Django начинает с первого шаблона в urlpatterns и проходит по списку, сравнивая запрашиваемый URL с каждым шаблоном, пока не найдет соответствующий.

Шаблоны не ищут параметры GET и POST, или имя домена. Например, в запросе к https://www.example.com/myapp/, URLconf будет искать myapp/. В запросе к https://www.example.com/myapp/?page=3, URLconf также будет искать myapp/.

path() аргумент: view

Когда Django находит соответствующий шаблон, он вызывает указанную функцию представления с объектом HttpRequest в качестве первого аргумента и любыми «захваченными» значениями из маршрута в качестве ключевых аргументов. Мы немного позже приведем пример этого.

path() аргумент: kwargs

Произвольные ключевые аргументы могут быть переданы в целевое представление в виде словаря. В данном руководстве мы не будем использовать эту функцию Django.

path() аргумент: name

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

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