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

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

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

Это приложение будет состоять из двух частей:

• Общедоступный сайт, позволяющий пользователям просматривать опросы и голосовать в них.
• Сайт администратора, позволяющий добавлять, изменять и удалять опросы.

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

$ python -m django --version

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

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

Это руководство написано для Django 4.2, которое поддерживает Python 3.8 и новее. Если версия 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.

April 12, 2023 - 15:50:53
Django version 4.2, 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.0.0.0:8000

...\> py manage.py runserver 0.0.0.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 этого руководства, чтобы начать работать с базой данных.