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

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

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

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

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 ошибку, это промежуточный слой проверяет базу данных статических страниц на наличие запрашиваемого URL. Точнее выполняется поиск простой страницы с текущим URL и ID сайта из настройки SITE_ID.

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

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

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

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

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

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

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

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

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

Если вы активировали интерфейс администратора 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 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¶

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

Поля¶

Объекты FlatPage имеют следующие поля:

class models.FlatPage

url¶

Необходимый. 100 символов или меньше. Индексируется для более быстрого поиска.

title¶

Необходимый. 200 символов или меньше.

content¶

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

enable_comments¶

Логическое значение. Это поле не используется flatpages по умолчанию и не отображается в интерфейсе администратора. Подробное объяснение см. в разделе интерфейса администратора Flatpages <flatpages-admin>`.

template_name¶

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

sites¶

Отношение «многие ко многим» к Site, которое определяет сайты, на которых доступна одностраничная страница.

Методы¶

class models.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-адреса. Этот аргумент может быть передан как строка или как переменная, которую необходимо разрешить из контекста.

Например:

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

Пример¶

Вот пример конфигурации URL с использованием 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",
    ),
]