Приложение для создания статических страниц

Django содержит приложения для создания статических страниц. Оно позволяет сохранять “статический” HTML и управлять ним через интерфейс администратора Django и Python API.

Статическая страница – это простой объект с URL, заголовком и содержимым. Используйте их для единичных не динамических страниц, например страницы “О нас” или “Политика конфиденциальности”, которые вы хотите хранить в базе данных, не создавая отдельное приложение Django.

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

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

Вот пример статических страниц сайтов, сделанных на Django:

Установка

Чтобы установить приложение статических страниц, выполните следующие действия:

  1. Установите фреймворк для сайтов, добавив 'django.contrib.sites' в настройку INSTALLED_APPS, если он еще не добавлен.

    Также убедитесь, что настройки содержат правильный SITE_ID. Обычно это 1 (то есть SITE_ID = 1, но если вы используете фреймверк для управления несколькими сайтами, ID может быть другим.

  2. Добавьте 'django.contrib.flatpages' в настройку INSTALLED_APPS.

Затем или:

  1. Добавьте запись в URLconf. Например:

    urlpatterns = [
        url(r'^pages/', include('django.contrib.flatpages.urls')),
    ]
    

или:

  1. Добавьте 'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware' в настройку MIDDLEWARE_CLASSES.

  2. Запустите команду manage.py migrate.

Как это работает

manage.py migrate создает две таблицы в вашей базе данных: django_flatpage и django_flatpage_sites. django_flatpage – это таблица, которая связывает URL и содержимое страницы. django_flatpage_sites связывает страницу с конкретным сайтом.

Использование URLconf

Есть несколько способов добавить статические страницы в ваш URLconf. Вы можете добавить их к конкретному путю:

urlpatterns = [
    url(r'^pages/', include('django.contrib.flatpages.urls')),
]

Или же использовать URL-шаблон, который будет перехватывать все запросы. В этом случае важно добавить его в самом конце:

from django.contrib.flatpages import views

# Your other patterns here
urlpatterns += [
    url(r'^(?P<url>.*/)$', views.flatpage),
]

Предупреждение

Если вы указали False в APPEND_SLASH, вам следует убрать косую черту в конце URL-шаблона.

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

from django.contrib.flatpages import views

urlpatterns += [
    url(r'^about-us/$', views.flatpage, {'url': '/about-us/'}, name='about'),
    url(r'^license/$', views.flatpage, {'url': '/license/'}, name='license'),
]

Использование промежуточного слоя(“middleware”)

FlatpageFallbackMiddleware обеспечивает работу статических страниц.

class FlatpageFallbackMiddleware

Каждый раз, когда приложение Django вызывает 404 ошибку, это промежуточный слой проверяет базу данных статических страниц на наличие запрашиваемого URL. Точнее выполняется поиск простой страницы с текущим URL и ID сайта из настройки SITE_ID.

Если страница найдена:

  • Загружается собственный шаблон для страницы, если такой указан, иначе загружается flatpages/default.html.

  • В шаблон передается одна переменная, flatpage, которая содержит объект страницы. При рендеринге шаблона используется RequestContext.

Промежуточный слой только добавляет слэш и перенаправляет (проверяя настройку APPEND_SLASH), если полученный URL указывает на статическую страницу. Перенаправление постоянные (301 код ответа).

Если страница не найдена, запрос обрабатывается как обычно.

Промежуточный слой активируется только при 404 ответе, 500 и прочие игнорируются.

К простым страницам не применяется process_view промежуточных слоев

Так как FlatpageFallbackMiddleware применяется после того, как поиск URL-а провалился и мы получили 404, ответ не будет обрабатываться методом process_view промежуточных слоев. Только при успешной обработке URL-а и вызове представления вызываются эти методы.

Обратите внимание, порядок MIDDLEWARE_CLASSES важен. В общем вы можете указать FlatpageFallbackMiddleware в конце списка. Он будет выполнен первым при обработке ответа, и все остальные промежуточные слои(middleware) увидят ответ со страницей, а не 404.

Подробнее смотрите в разделе о промежуточных слоях.

Убедитесь, что ваш 404 шаблон работает

Обратите внимание, FlatpageFallbackMiddleware выполняет, только если другое представление вернуло 404 ответ. Если другое представление или промежуточный слой попытается вернуть 404 и получит исключение, ответ будет HTTP 500 (“Internal Server Error”) и FlatpageFallbackMiddleware не будет выполнен.

Как добавить, изменить и удалить статические страницы

Через интерфейс администратора

Если вы активировали интерфейс администратора Django, вы увидите раздел “Flatpages” в админке. Редактируйте статические страницы как и другие объекты в базе данных.

Модель FlatPage содержит поле enable_comments, которое не используется contrib.flatpages, но может быть полезно для вашего проекта или приложений. Это поле не доступно через интерфейс администратора, но вы можете добавить его, зарегистрировав собственный ModelAdmin для FlatPage:

from django.contrib import admin
from django.contrib.flatpages.admin import FlatPageAdmin
from django.contrib.flatpages.models import FlatPage
from django.utils.translation import ugettext_lazy as _

# Define a new FlatPageAdmin
class FlatPageAdmin(FlatPageAdmin):
    fieldsets = (
        (None, {'fields': ('url', 'title', 'content', 'sites')}),
        (_('Advanced options'), {
            'classes': ('collapse', ),
            'fields': (
                'enable_comments',
                'registration_required',
                'template_name',
            ),
        }),
    )

# Re-register FlatPageAdmin
admin.site.unregister(FlatPage)
admin.site.register(FlatPage, FlatPageAdmin)
Изменено в Django 1.9:

Поле enable_comments было удалено из FlatPageAdmin.

Через Python API

class FlatPage

Статические страницы представлены моделью Django, которая находится в django/contrib/flatpages/models.py. Вы можете обратиться к объектам статических страницы через Django ORM API.

Проверка уникальности URL статической страницы.

Если вы добавляете или изменяете статические страницы, скорее всего вам необходимо проверять, что URL страницы уникален для сайта. Форма, которая используется в админке, выполняет такую проверку, и может быть импортирована из django.contrib.flatpages.forms.FlatpageForm для использование в ваших представлениях.

Шаблоны статических страниц

By default, flatpages are rendered via the template flatpages/default.html, but you can override that for a particular flatpage: in the admin, a collapsed fieldset titled “Advanced options” (clicking will expand it) contains a field for specifying a template name. If you’re creating a flat page via the Python API you can simply set the template name as the field template_name on the FlatPage object.

Creating the flatpages/default.html template is your responsibility; in your template directory, just create a flatpages directory containing a file default.html.

Flatpage templates are passed a single context variable, flatpage, which is the flatpage object.

Here’s a sample flatpages/default.html template:

<!DOCTYPE html>
<html>
<head>
<title>{{ flatpage.title }}</title>
</head>
<body>
{{ flatpage.content }}
</body>
</html>

Since you’re already entering raw HTML into the admin page for a flatpage, both flatpage.title and flatpage.content are marked as not requiring automatic HTML escaping in the template.

Getting a list of FlatPage objects in your templates

The flatpages app provides a template tag that allows you to iterate over all of the available flatpages on the current site.

Like all custom template tags, you’ll need to load its custom tag library before you can use it. After loading the library, you can retrieve all current flatpages via the get_flatpages tag:

{% load flatpages %}
{% get_flatpages as flatpages %}
<ul>
    {% for page in flatpages %}
        <li><a href="{{ page.url }}">{{ page.title }}</a></li>
    {% endfor %}
</ul>

Displaying registration_required flatpages

By default, the get_flatpages templatetag will only show flatpages that are marked registration_required = False. If you want to display registration-protected flatpages, you need to specify an authenticated user using a for clause.

For example:

{% get_flatpages for someuser as about_pages %}

If you provide an anonymous user, get_flatpages will behave the same as if you hadn’t provided a user – i.e., it will only show you public flatpages.

Limiting flatpages by base URL

An optional argument, starts_with, can be applied to limit the returned pages to those beginning with a particular base URL. This argument may be passed as a string, or as a variable to be resolved from the context.

For example:

{% get_flatpages '/about/' as about_pages %}
{% get_flatpages about_prefix as about_pages %}
{% get_flatpages '/about/' for someuser as about_pages %}

Integrating with django.contrib.sitemaps

class FlatPageSitemap

The sitemaps.FlatPageSitemap class looks at all publicly visible flatpages defined for the current SITE_ID (see the sites documentation) and creates an entry in the sitemap. These entries include only the location attribute – not lastmod, changefreq or priority.

Изменено в Django 1.8:

This class is available from django.contrib.sitemaps.FlatPageSitemap in older version of Django.

Example

Here’s an example of a URLconf using FlatPageSitemap:

from django.conf.urls import url
from django.contrib.flatpages.sitemaps import FlatPageSitemap
from django.contrib.sitemaps.views import sitemap

urlpatterns = [
    # ...

    # the sitemap
    url(r'^sitemap\.xml$', sitemap,
        {'sitemaps': {'flatpages': FlatPageSitemap}},
        name='django.contrib.sitemaps.views.sitemap'),
]