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

Давайте будем учиться на примерах.

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

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

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

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

$ python -m django --version

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

Если Django установлен, вы увидите версию вашей установки. Если нет, вы получите ошибку, сообщающую «Нет модуля с именем django».

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

February 04, 2024 - 15:50:53
Django version 5.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.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 этого руководства, чтобы начать работу с базой данных.