Django в обзоре

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

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

Проектирование модели

Хотя вы можете использовать Django без базы данных, он поставляется с объектно-реляционным маппером, в котором вы описываете структуру базы данных на языке Python.

Синтаксис моделей данных предлагает множество способов представления ваших моделей — на сегодняшний день он решает многие проблемы схем баз данных, накопившиеся за годы работы. Вот быстрый пример:

from django.db import models

class Reporter(models.Model):
    full_name = models.CharField(max_length=70)

    def __str__(self):
        return self.full_name

class Article(models.Model):
    pub_date = models.DateField()
    headline = models.CharField(max_length=200)
    content = models.TextField()
    reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)

    def __str__(self):
        return self.headline

Установка

Далее, запустите утилиты командной строки Django, чтобы автоматически создать таблицы базы данных:

$ python manage.py makemigrations
$ python manage.py migrate

...\> py manage.py makemigrations
...\> py manage.py migrate

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

Используйте бесплатный API

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

# Import the models we created from our "news" app
>>> from news.models import Article, Reporter

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

# Create a new Reporter.
>>> r = Reporter(full_name='John Smith')

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

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

# Now the new reporter is in the database.
>>> Reporter.objects.all()
<QuerySet [<Reporter: John Smith>]>

# Fields are represented as attributes on the Python object.
>>> r.full_name
'John Smith'

# Django provides a rich database lookup API.
>>> Reporter.objects.get(id=1)
<Reporter: John Smith>
>>> Reporter.objects.get(full_name__startswith='John')
<Reporter: John Smith>
>>> Reporter.objects.get(full_name__contains='mith')
<Reporter: John Smith>
>>> Reporter.objects.get(id=2)
Traceback (most recent call last):
    ...
DoesNotExist: Reporter matching query does not exist.

# Create an article.
>>> from datetime import date
>>> a = Article(pub_date=date.today(), headline='Django is cool',
...     content='Yeah.', reporter=r)
>>> a.save()

# Now the article is in the database.
>>> Article.objects.all()
<QuerySet [<Article: Django is cool>]>

# Article objects get API access to related Reporter objects.
>>> r = a.reporter
>>> r.full_name
'John Smith'

# And vice versa: Reporter objects get API access to Article objects.
>>> r.article_set.all()
<QuerySet [<Article: Django is cool>]>

# The API follows relationships as far as you need, performing efficient
# JOINs for you behind the scenes.
# This finds all articles by a reporter whose name starts with "John".
>>> Article.objects.filter(reporter__full_name__startswith='John')
<QuerySet [<Article: Django is cool>]>

# Change an object by altering its attributes and calling save().
>>> r.full_name = 'Billy Goat'
>>> r.save()

# Delete an object with delete().
>>> r.delete()

Динамичный административный интерфейс: это не просто каркас — это весь дом

После определения моделей Django может автоматически создать профессиональный, готовый к производству административный интерфейс — веб-сайт, который позволяет авторизованным пользователям добавлять, изменять и удалять объекты. Единственный необходимый шаг — зарегистрировать вашу модель в административной системе:

from django.db import models

class Article(models.Model):
    pub_date = models.DateField()
    headline = models.CharField(max_length=200)
    content = models.TextField()
    reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)

from django.contrib import admin

from . import models

admin.site.register(models.Article)

Философия заключается в том, что вашим сайтом пользуются сотрудники или клиенты, а может быть, и только вы — и вам не нужно создавать интерфейсы на стороне сервера только для управления содержимым.

Один из типичных рабочих процессов при создании приложений Django — это создание моделей и быстрая настройка административных сайтов, чтобы ваши сотрудники (или клиенты) могли начать заполнять данные. Затем разработайте способ представления данных широкой публике.

Проектирование URL-адресов

Чистая и элегантная схема URL-адресов — важный элемент качественного веб-приложения. Django поощряет красивое проектирование URL-адресов и не вводит в них лишний мусор, как .php или .asp.

Для проектирования URL-адресов приложения создайте модуль Python под названием URLconf. Он представляет собой таблицу содержания вашего приложения, содержащую сопоставление шаблонов URL-адресов и функций обратного вызова Python. URLconf также служат для разъединения URL-адресов от кода Python.

Вот как может выглядеть URLconf для примера Reporter/Article выше:

from django.urls import path

from . import views

urlpatterns = [
    path('articles/<int:year>/', views.year_archive),
    path('articles/<int:year>/<int:month>/', views.month_archive),
    path('articles/<int:year>/<int:month>/<int:pk>/', views.article_detail),
]

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

После того, как один из шаблонов URL-адресов сопоставится, Django вызывает заданную функцию представления, которая является функцией Python. Каждое представление получает объект запроса — который содержит метаданные запроса — и значения, захваченные в шаблоне.

Например, если пользователь запросил URL-адрес «/articles/2005/05/39323/», Django вызовет функцию news.views.article_detail(request, year=2005, month=5, pk=39323).

Написание представлений

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

В общем случае представление извлекает данные в соответствии с параметрами, загружает шаблон и рендерит шаблон с извлечёнными данными. Вот пример представления для year_archive из вышеприведённого примера:

from django.shortcuts import render

from .models import Article

def year_archive(request, year):
    a_list = Article.objects.filter(pub_date__year=year)
    context = {'year': year, 'article_list': a_list}
    return render(request, 'news/year_archive.html', context)

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

Проектирование шаблонов

Код выше загружает шаблон news/year_archive.html.

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

Предположим, что шаблон news/year_archive.html был найден. Вот как это может выглядеть:

{% extends "base.html" %}

{% block title %}Articles for {{ year }}{% endblock %}

{% block content %}
<h1>Articles for {{ year }}</h1>

{% for article in article_list %}
    <p>{{ article.headline }}</p>
    <p>By {{ article.reporter.full_name }}</p>
    <p>Published {{ article.pub_date|date:"F j, Y" }}</p>
{% endfor %}
{% endblock %}

Переменные окружены двойными фигурными скобками. {{ article.headline }} означает «Вывести значение атрибута заголовка статьи».

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

Обратите внимание, что {{ article.pub_date|date:"F j, Y" }} использует «трубу» в стиле Unix (символ «|»). Это называется фильтром шаблона и служит для фильтрации значения переменной. В данном случае фильтр даты форматирует объект Python datetime в заданном формате (как в функции date PHP).

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

Наконец, Django использует концепцию «наследования шаблонов». Именно это делает {% extends "base.html" %}. Это означает «Сначала загрузите шаблон под названием «base», в котором определены несколько блоков, и заполните блоки следующими блоками». Короче говоря, это позволяет значительно сократить избыточность в шаблонах: каждый шаблон должен определять только то, что уникально для этого шаблона.

Вот как может выглядеть шаблон «base.html», включая использование статических файлов:

{% load static %}
<html>
<head>
    <title>{% block title %}{% endblock %}</title>
</head>
<body>
    <img src="{% static 'images/sitelogo.png' %}" alt="Logo">
    {% block content %}{% endblock %}
</body>
</html>

Проще говоря, он определяет внешний вид сайта (с логотипом сайта) и предоставляет «дыры» для заполнения дочерними шаблонами. Это означает, что переработку сайта можно выполнить, изменив всего один файл — базовый шаблон.

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

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

Это только поверхность

Это был лишь быстрый обзор функциональности Django. Некоторые дополнительные полезные возможности:

• Система кэширования, интегрируемая с memcached или другими бэкендами.
• Система создания RSS и Atom лент, реализованная в виде небольшого класса Python.
• Более привлекательные автоматически сгенерированные административные функции — этот обзор едва коснулся поверхности.

Следующие шаги — загрузить Django, прочитать туториал и присоединиться к сообществу. Спасибо за интерес!