Приложение flatpages

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

Существует несколько способов включения страниц flatpages в ваш URLconf. Вы можете выделить определённый путь для flatpages:

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

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

from django.contrib.flatpages import views

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

Ещё один распространённый способ — использовать flatpages для ограниченного набора известных страниц и жестко закодировать URL, чтобы вы могли ссылаться на них с помощью тега шаблона url:

from django.contrib.flatpages import views

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

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

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

class FlatpageFallbackMiddleware [source]

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

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

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

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

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

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

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

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

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

Если вы активировали автоматический админский интерфейс Django, вы должны увидеть раздел «Flatpages» на главной странице администрирования. Редактируйте 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 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)

Через Python-API

class FlatPage [source]

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

Отображение registration_required flatpages

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

Например:

{% get_flatpages for someuser as about_pages %}

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

Ограничение flatpages по базовому URL

Необязательный аргумент starts_with может быть применен для ограничения возвращаемых страниц теми, которые начинаются с определенного базового 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",
    ),
]