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

Этот учебник начинается там, где закончился Учебник 1. Мы настроим базу данных, создадим вашу первую модель и получим краткое представление о автоматически генерируемом админском сайте Django.

Настройка базы данных

Теперь откройте mysite/settings.py. Это обычный Python-модуль с переменными уровня модуля, представляющими настройки Django.

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

Если вы хотите использовать другую базу данных, установите соответствующие связки баз данных и измените следующие ключи в элементе DATABASES 'default' для соответствия настройкам подключения к вашей базе данных:

• ENGINE – Либо 'django.db.backends.sqlite3', 'django.db.backends.postgresql', 'django.db.backends.mysql', или 'django.db.backends.oracle'. Другие бэкэнды также доступны.
• NAME – Имя вашей базы данных. Если вы используете SQLite, база данных будет файлом на вашем компьютере; в этом случае, NAME должен быть полным абсолютным путем, включая имя файла, этого файла. Значение по умолчанию BASE_DIR / 'db.sqlite3', сохранит файл в вашем каталоге проекта.

Если вы не используете SQLite в качестве базы данных, необходимо добавить дополнительные настройки, такие как USER, PASSWORD и HOST. Для получения более подробной информации см. справочную документацию по DATABASES.

Пока вы редактируете mysite/settings.py, установите TIME_ZONE в соответствии с вашим часовым поясом.

Также обратите внимание на настройку INSTALLED_APPS в верхней части файла. Она содержит имена всех приложений Django, которые активированы в этом экземпляре Django. Приложения можно использовать в нескольких проектах, и вы можете упаковать и распространять их для использования другими в их проектах.

По умолчанию, INSTALLED_APPS содержит следующие приложения, все из которых поставляются с Django:

• django.contrib.admin – Админский сайт. Вы скоро его используете.
• django.contrib.auth – Система аутентификации.
• django.contrib.contenttypes – Фреймворк для типов контента.
• django.contrib.sessions – Фреймворк для управления сессиями.
• django.contrib.messages – Фреймворк для сообщений.
• django.contrib.staticfiles – Фреймворк для управления статическими файлами.

Эти приложения включаются по умолчанию для удобства в распространённом случае.

Однако некоторые из этих приложений используют по крайней мере одну таблицу базы данных, поэтому нам нужно создать таблицы в базе данных перед их использованием. Для этого выполните следующую команду:

$ python manage.py migrate

...\> py manage.py migrate

Команда migrate анализирует настройку INSTALLED_APPS и создаёт все необходимые таблицы базы данных в соответствии с настройками базы данных в вашем файле mysite/settings.py и миграциями базы данных, которые поставляются с приложением (мы рассмотрим их позже). Вы увидите сообщение для каждой применённой миграции. Если вас интересует, запустите командную строку клиента вашей базы данных и введите \dt (PostgreSQL), SHOW TABLES; (MariaDB, MySQL), .tables (SQLite) или SELECT TABLE_NAME FROM USER_TABLES; (Oracle), чтобы отобразить таблицы, созданные Django.

Создание моделей

Теперь мы определим ваши модели — по существу, структуру вашей базы данных с дополнительными метаданными.

В нашем приложении опросов мы создадим две модели: Question и Choice. Опрос содержит вопрос и дату публикации. Выбор содержит текст варианта и количество голосов. Каждый выбор связан с опросом.

Эти концепции представлены Python-классами. Измените файл polls/models.py так, чтобы он выглядел так:

from django.db import models


class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')


class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

Здесь каждая модель представлена классом, который наследуется от django.db.models.Model. Каждая модель имеет ряд переменных класса, каждая из которых представляет поле базы данных в модели.

Каждое поле представлено экземпляром класса Field — например, CharField для текстовых полей и DateTimeField для дат и времени. Это сообщает Django о типе данных, которые хранит каждое поле.

Имя каждого экземпляра Field (например, question_text или pub_date) — имя поля в удобном для машины формате. Вы будете использовать это значение в своём коде Python, а ваша база данных будет использовать его как имя столбца.

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

Некоторые Field классы имеют обязательные аргументы. Например, CharField требует, чтобы вы указали max_length. Это используется не только в схеме базы данных, но и в валидации, как мы скоро увидим.

У Field также могут быть различные необязательные аргументы; в этом случае мы установили значение default для votes в 0.

Наконец, обратите внимание, что отношение определено с помощью ForeignKey. Это сообщает Django, что каждый Choice связан с одним Question. Django поддерживает все распространённые отношения в базе данных: многие-к-одному, многие-ко-многим и один-к-одному.

Активизация моделей

Этот небольшой фрагмент кода модели предоставляет Django много информации. С помощью него Django может:

• Создать схему базы данных (CREATE TABLE инструкции) для этого приложения.
• Создать Python API для доступа к Question и Choice объектам.

Но сначала нам нужно сообщить проекту, что приложение polls установлено.

Чтобы включить приложение в наш проект, нам нужно добавить ссылку на его конфигурационный класс в настройку INSTALLED_APPS. Класс PollsConfig находится в файле polls/apps.py, поэтому его путь с точками — 'polls.apps.PollsConfig'. Откройте файл mysite/settings.py и добавьте этот путь с точками в настройку INSTALLED_APPS. Это будет выглядеть так:

INSTALLED_APPS = [
    'polls.apps.PollsConfig',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

Теперь Django знает, как включить приложение polls. Давайте выполним ещё одну команду:

$ python manage.py makemigrations polls

...\> py manage.py makemigrations polls

Вы должны увидеть что-то похожее на следующее:

Migrations for 'polls':
  polls/migrations/0001_initial.py
    - Create model Question
    - Create model Choice

Выполняя makemigrations, вы сообщаете Django, что внесли изменения в свои модели (в данном случае, создали новые) и хотите, чтобы эти изменения были сохранены как миграция.

Миграции — это способ, которым Django сохраняет изменения в ваших моделях (и, следовательно, схеме вашей базы данных) — это файлы на диске. Вы можете прочитать миграцию для вашей новой модели, если хотите; это файл polls/migrations/0001_initial.py. Не волнуйтесь, вам не нужно читать их каждый раз, когда Django создает миграцию, но они предназначены для редактирования человеком, если вы захотите вручную настроить, как Django вносит изменения.

Есть команда, которая выполнит миграции за вас и автоматически управляет схемой вашей базы данных — это команда migrate, и мы к ней обратимся чуть позже — но сначала давайте посмотрим, какой SQL эта миграция запустит. Команда sqlmigrate принимает имена миграций и возвращает их SQL:

$ python manage.py sqlmigrate polls 0001

...\> py manage.py sqlmigrate polls 0001

Вы должны увидеть что-то похожее на следующее (мы отформатировали его для удобочитаемости):

BEGIN;
--
-- Create model Question
--
CREATE TABLE "polls_question" (
    "id" serial NOT NULL PRIMARY KEY,
    "question_text" varchar(200) NOT NULL,
    "pub_date" timestamp with time zone NOT NULL
);
--
-- Create model Choice
--
CREATE TABLE "polls_choice" (
    "id" serial NOT NULL PRIMARY KEY,
    "choice_text" varchar(200) NOT NULL,
    "votes" integer NOT NULL,
    "question_id" integer NOT NULL
);
ALTER TABLE "polls_choice"
  ADD CONSTRAINT "polls_choice_question_id_c5b4b260_fk_polls_question_id"
    FOREIGN KEY ("question_id")
    REFERENCES "polls_question" ("id")
    DEFERRABLE INITIALLY DEFERRED;
CREATE INDEX "polls_choice_question_id_c5b4b260" ON "polls_choice" ("question_id");

COMMIT;

Обратите внимание на следующее:

• Точный вывод будет зависеть от используемой базы данных. Приведённый выше пример сгенерирован для PostgreSQL.
• Имена таблиц автоматически генерируются путём объединения имени приложения (polls) и нижнего регистра имени модели — question и choice. (Вы можете настроить это поведение.)
• Первичные ключи (ID) добавляются автоматически. (Вы можете это настроить.)
• По соглашению Django добавляет "_id" к имени поля внешнего ключа. (Да, вы можете настроить это тоже.)
• Взаимосвязь внешнего ключа явно задаётся ограничением FOREIGN KEY. Не беспокойтесь о частях DEFERRABLE; это сообщает PostgreSQL о том, что ограничение внешнего ключа не должно выполняться до конца транзакции.
• Он настраивается для используемой базы данных, поэтому типы полей, специфичные для базы данных, такие как auto_increment (MySQL), serial (PostgreSQL) или integer primary key autoincrement (SQLite), обрабатываются автоматически. То же самое касается цитирования имён полей — например, с использованием двойных или одинарных кавычек.
• Команда sqlmigrate фактически не выполняет миграцию в вашей базе данных; вместо этого она выводит SQL на экран, чтобы вы могли увидеть, что Django считает необходимым. Это полезно для проверки того, что Django собирается сделать, или если у вас есть администраторы базы данных, которым требуются SQL-скрипты для изменений.

Если вас интересует, вы также можете запустить python manage.py check; это проверяет наличие каких-либо проблем в вашем проекте без создания миграций или изменения базы данных.

Теперь запустите migrate снова, чтобы создать эти таблицы моделей в вашей базе данных:

$ python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, polls, sessions
Running migrations:
  Rendering model states... DONE
  Applying polls.0001_initial... OK

...\> py manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, polls, sessions
Running migrations:
  Rendering model states... DONE
  Applying polls.0001_initial... OK

Команда migrate берёт все миграции, которые ещё не были применены (Django отслеживает, какие из них применены, используя специальную таблицу в вашей базе данных под названием django_migrations) и выполняет их в вашей базе данных — по сути, синхронизирует изменения, которые вы внесли в свои модели, со схемой в базе данных.

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

• Измените свои модели (в models.py).
• Запустите python manage.py makemigrations, чтобы создать миграции для этих изменений.
• Запустите python manage.py migrate, чтобы применить эти изменения к базе данных.

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

Обратитесь к документации django-admin для получения полной информации о том, что может сделать утилита manage.py.

Работа с API

Теперь давайте перейдём в интерактивную оболочку Python и поиграем с бесплатным API, который предоставляет Django. Для запуска оболочки Python используйте эту команду:

$ python manage.py shell

...\> py manage.py shell

Мы используем её вместо простого ввода «python», потому что manage.py устанавливает переменную окружения DJANGO_SETTINGS_MODULE, которая предоставляет Django путь импорта Python к файлу mysite/settings.py.

После запуска оболочки изучите API базы данных:

>>> from polls.models import Choice, Question  # Import the model classes we just wrote.

# No questions are in the system yet.
>>> Question.objects.all()
<QuerySet []>

# Create a new Question.
# Support for time zones is enabled in the default settings file, so
# Django expects a datetime with tzinfo for pub_date. Use timezone.now()
# instead of datetime.datetime.now() and it will do the right thing.
>>> from django.utils import timezone
>>> q = Question(question_text="What's new?", pub_date=timezone.now())

# Save the object into the database. You have to call save() explicitly.
>>> q.save()

# Now it has an ID.
>>> q.id
1

# Access model field values via Python attributes.
>>> q.question_text
"What's new?"
>>> q.pub_date
datetime.datetime(2012, 2, 26, 13, 0, 0, 775217, tzinfo=<UTC>)

# Change values by changing the attributes, then calling save().
>>> q.question_text = "What's up?"
>>> q.save()

# objects.all() displays all the questions in the database.
>>> Question.objects.all()
<QuerySet [<Question: Question object (1)>]>

Подождите минутку. <Question: Question object (1)> — не очень полезное представление этого объекта. Давайте исправим это, отредактировав модель Question (в файле polls/models.py и добавив метод __str__() в Question и Choice:

from django.db import models

class Question(models.Model):
    # ...
    def __str__(self):
        return self.question_text

class Choice(models.Model):
    # ...
    def __str__(self):
        return self.choice_text

Важно добавлять методы __str__() в свои модели не только для удобства работы с интерактивным приглашением, но и потому, что представления объектов используются по всему Django, в автоматически сгенерированном администраторе.

Давайте также добавим в эту модель пользовательский метод:

import datetime

from django.db import models
from django.utils import timezone


class Question(models.Model):
    # ...
    def was_published_recently(self):
        return self.pub_date >= timezone.now() - datetime.timedelta(days=1)

Обратите внимание на добавление import datetime и from django.utils import timezone, чтобы сослаться на стандартный модуль Python datetime и средства обработки часовых поясов Django в django.utils.timezone, соответственно. Если вы не знакомы с обработкой часовых поясов в Python, вы можете узнать больше в документации по поддержке часовых поясов.

Сохраните эти изменения и запустите новую интерактивную оболочку Python, выполнив python manage.py shell снова:

>>> from polls.models import Choice, Question

# Make sure our __str__() addition worked.
>>> Question.objects.all()
<QuerySet [<Question: What's up?>]>

# Django provides a rich database lookup API that's entirely driven by
# keyword arguments.
>>> Question.objects.filter(id=1)
<QuerySet [<Question: What's up?>]>
>>> Question.objects.filter(question_text__startswith='What')
<QuerySet [<Question: What's up?>]>

# Get the question that was published this year.
>>> from django.utils import timezone
>>> current_year = timezone.now().year
>>> Question.objects.get(pub_date__year=current_year)
<Question: What's up?>

# Request an ID that doesn't exist, this will raise an exception.
>>> Question.objects.get(id=2)
Traceback (most recent call last):
    ...
DoesNotExist: Question matching query does not exist.

# Lookup by a primary key is the most common case, so Django provides a
# shortcut for primary-key exact lookups.
# The following is identical to Question.objects.get(id=1).
>>> Question.objects.get(pk=1)
<Question: What's up?>

# Make sure our custom method worked.
>>> q = Question.objects.get(pk=1)
>>> q.was_published_recently()
True

# Give the Question a couple of Choices. The create call constructs a new
# Choice object, does the INSERT statement, adds the choice to the set
# of available choices and returns the new Choice object. Django creates
# a set to hold the "other side" of a ForeignKey relation
# (e.g. a question's choice) which can be accessed via the API.
>>> q = Question.objects.get(pk=1)

# Display any choices from the related object set -- none so far.
>>> q.choice_set.all()
<QuerySet []>

# Create three choices.
>>> q.choice_set.create(choice_text='Not much', votes=0)
<Choice: Not much>
>>> q.choice_set.create(choice_text='The sky', votes=0)
<Choice: The sky>
>>> c = q.choice_set.create(choice_text='Just hacking again', votes=0)

# Choice objects have API access to their related Question objects.
>>> c.question
<Question: What's up?>

# And vice versa: Question objects get access to Choice objects.
>>> q.choice_set.all()
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>
>>> q.choice_set.count()
3

# The API automatically follows relationships as far as you need.
# Use double underscores to separate relationships.
# This works as many levels deep as you want; there's no limit.
# Find all Choices for any question whose pub_date is in this year
# (reusing the 'current_year' variable we created above).
>>> Choice.objects.filter(question__pub_date__year=current_year)
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

# Let's delete one of the choices. Use delete() for that.
>>> c = q.choice_set.filter(choice_text__startswith='Just hacking')
>>> c.delete()

Для получения дополнительной информации о связях моделей см. доступ к связанным объектам. Дополнительные сведения о том, как использовать двойные подчёркивания для выполнения поисков по полям через API, см. в поисках по полям. Полные сведения об API базы данных см. в справочнике по API базы данных.

Представление Django Admin

Создание пользователя администратора

Сначала нам нужно создать пользователя, который сможет войти в админ-панель. Выполните следующую команду:

$ python manage.py createsuperuser

...\> py manage.py createsuperuser

Введите желаемое имя пользователя и нажмите Enter.

Username: admin

Затем вам будет предложено ввести желаемый адрес электронной почты:

Email address: admin@example.com

Окончательным шагом является ввод пароля. Вам будет предложено ввести пароль дважды, второй раз для подтверждения первого.

Password: **********
Password (again): *********
Superuser created successfully.

Запуск сервера разработки

Django админ-панель активирована по умолчанию. Давайте запустим сервер разработки и изучим её.

Если сервер не запущен, запустите его следующим образом:

$ python manage.py runserver

...\> py manage.py runserver

Теперь откройте веб-браузер и перейдите по адресу «/admin/» на вашем локальном домене — например, http://127.0.0.1:8000/admin/. Вы увидите экран входа в админ-панель:

Поскольку перевод включён по умолчанию, если вы установите LANGUAGE_CODE, экран входа будет отображаться на заданном языке (если у Django есть соответствующие переводы).

Вход в админ-панель

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

Вы должны увидеть несколько типов редактируемого контента: группы и пользователи. Они предоставляются django.contrib.auth, фреймворком аутентификации Django.

Настройка приложения poll для редактирования в админ-панели

Но где наше приложение poll? Оно не отображается на главной странице админ-панели.

Осталось сделать всего одно: нужно сказать админ-панели, что Question объекты имеют интерфейс администратора. Для этого откройте файл polls/admin.py и отредактируйте его следующим образом:

from django.contrib import admin

from .models import Question

admin.site.register(Question)

Изучение функциональности админ-панели

Теперь, когда мы зарегистрировали Question, Django знает, что оно должно отображаться на главной странице админ-панели:

Нажмите «Вопросы». Теперь вы на странице «список изменений» для вопросов. Эта страница отображает все вопросы в базе данных и позволяет выбрать один для изменения. Вот вопрос «Что нового?», который мы создали ранее:

Нажмите на вопрос «Что нового?», чтобы отредактировать его:

Следует обратить внимание на следующие моменты:

• Форма автоматически генерируется из модели Question.
• Разные типы полей модели (DateTimeField, CharField) соответствуют соответствующим HTML-виджетам ввода. Каждый тип поля знает, как отобразить себя в Django админ-панели.
• Каждый DateTimeField получает удобные JavaScript-сокращения. Даты получают сокращение «Сегодня» и всплывающее окно календаря, а время получает сокращение «Сейчас» и удобное всплывающее окно, в котором перечислены часто вводимые временные значения.

В нижней части страницы есть несколько вариантов:

• Сохранить — сохраняет изменения и возвращается на страницу списка изменений для этого типа объекта.
• Сохранить и продолжить редактирование — сохраняет изменения и перезагружает страницу админ-панели для этого объекта.
• Сохранить и добавить ещё — сохраняет изменения и загружает новую пустую форму для этого типа объекта.
• Удалить — отображает страницу подтверждения удаления.

Если значение «Дата публикации» не соответствует времени создания вопроса в Уроке 1, вероятно, вы забыли установить правильное значение для параметра TIME_ZONE. Измените его, перезагрузите страницу и проверьте, что правильное значение отображается.

Измените «Дата публикации», нажав на сокращения «Сегодня» и «Сейчас». Затем нажмите «Сохранить и продолжить редактирование». Затем нажмите «История» в правом верхнем углу. Вы увидите страницу, на которой перечислены все изменения, внесённые в этот объект через Django админ-панель, с отметкой времени и именем пользователя, который внес изменения:

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