Приложение flatpages

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

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

urlpatterns = [
    path("pages/", include("django.contrib.flatpages.urls")),
]

Также можно настроить шаблон «catchall». В этом случае важно поместить его в конец остальных шаблонов urlpatterns:

from django.contrib.flatpages import views

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

Ещё один распространённый вариант — использовать плоские страницы для ограниченного набора известных страниц и явно указать их URL в URLconf:

from django.contrib.flatpages import views

urlpatterns += [
    path("about-us/", views.flatpage, kwargs={"url": "/about-us/"}, name="about"),
    path("license/", views.flatpage, kwargs={"url": "/license/"}, name="license"),
]

Аргумент kwargs задаёт значение url, используемое для поиска модели FlatPage в представлении плоской страницы.

Аргумент name позволяет выполнять обратное разрешение URL в шаблонах, например с помощью шаблонного тега url.

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

FlatpageFallbackMiddleware может выполнить всю необходимую работу.

class FlatpageFallbackMiddleware [исходный код]

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

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

• Если для плоской страницы задан собственный шаблон, загружается этот шаблон. В противном случае загружается шаблон flatpages/default.html.
• В шаблон передаётся одна переменная контекста — flatpage, содержащая объект плоской страницы. Для рендеринга шаблона используется RequestContext.

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

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

Middleware активируется только при ошибках 404 — не при ошибках 500 и не при ответах с любым другим кодом состояния.

Обратите внимание, что порядок элементов в MIDDLEWARE имеет значение. Обычно FlatpageFallbackMiddleware можно поместить в конец списка. Это означает, что при обработке ответа middleware запустится первым и позволит другим middleware, обрабатывающим ответы, увидеть настоящий ответ плоской страницы, а не ошибку 404.

Подробнее о middleware читайте в документации по middleware.

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

Если вы активировали автоматический интерфейс администратора Django, на главной странице администратора должен отображаться раздел «Плоские страницы». Редактируйте плоские страницы так же, как и любые другие объекты в системе.

У модели 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 gettext_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)

Через API на Python

Плоские страницы представлены стандартной моделью Django FlatPage. Доступ к объектам плоских страниц можно получить через API базы данных Django.

Поля

У объектов FlatPage есть следующие поля:

classmodels.FlatPage

url

Обязательное поле. Не более 100 символов. Индексируется для ускорения поиска.

title

Обязательное поле. Не более 200 символов.

content

Необязательное поле (blank=True). TextField, обычно содержащее HTML-контент страницы.

enable_comments

Логическое значение. По умолчанию это поле не используется приложением flatpages и не отображается в интерфейсе администратора. Подробное объяснение см. в разделе об интерфейсе администратора для плоских страниц.

template_name

Необязательное поле (blank=True). Не более 70 символов. Указывает шаблон, используемый для отображения страницы. Если значение не задано, используется flatpages/default.html.

sites

Связь «многие ко многим» с Site, определяющая, на каких сайтах доступна плоская страница.

Методы

classmodels.FlatPage

get_absolute_url()

Возвращает относительный путь URL страницы на основе атрибута url.

Отображение плоских страниц registration_required

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

Например:

{% get_flatpages for someuser as about_pages %}

Если передать анонимного пользователя, get_flatpages будет работать так же, как если бы пользователь не был указан, — то есть будет отображать только общедоступные плоские страницы.

Ограничение плоских страниц по базовому URL

Необязательный аргумент starts_with позволяет ограничить возвращаемые страницы теми, URL которых начинается с указанного базового URL. Этот аргумент можно передать в виде строки или переменной, значение которой будет получено из контекста.

Например:

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

Пример

Вот пример URLconf, использующего FlatPageSitemap:

from django.contrib.flatpages.sitemaps import FlatPageSitemap
from django.contrib.sitemaps.views import sitemap
from django.urls import path

urlpatterns = [
    # ...
    # the sitemap
    path(
        "sitemap.xml",
        sitemap,
        {"sitemaps": {"flatpages": FlatPageSitemap}},
        name="django.contrib.sitemaps.views.sitemap",
    ),
]