Django - Урок 050. Створення динамічних налаштувань сайту за допомогою SingletonModel

SingletonModel, Model, Django, singleton

Припустимо, ви створюєте сайт з CMS на основі Django, у якого повинні бути якісь динамічні налаштування сайту, які будуть доступні користувачеві. Наприклад, назва сайту, якась спеціалізована інформація, при цьому ви враховуєте можливість багатомовності. Те що тоді можна використовувати для цього? Мені спало на думку використовувати базу даних.

Для реалізації цього зверніть увагу на таке:

1. Створення моделі даних, яка завжди буде містити тільки один об'єкт, тобто тільки один запис. Тобто це буде Singleton Model.
2. Заборонити видаляти даний запис і створювати нові в панелі адміністрування Django
3. Можливість використання иноформацию з цієї моделі прямо в шаблоні, без завантаження налаштувань сайту в view функції.

Давайте розберемося по порядку, як це реалізувати.

1. SingletonModel

Я знайшов на GitHub код абстрактної SingletonModel, який був написаний ще в 2012 році. Ось посилання на gist .

Ось програмний код даної SingletonModel

class SingletonModel(models.Model):
    class Meta:
        abstract = True

    def save(self, *args, **kwargs):
        self.__class__.objects.exclude(id=self.id).delete()
        super(SingletonModel, self).save(*args, **kwargs)

    @classmethod
    def load(cls):
        try:
            return cls.objects.get()
        except cls.DoesNotExist:
            return cls()

Модель в методі save при збереженні об'єкта автоматично видаляє всі інші, що дозволяє тримати в базее даних завжди тільки один екземпляр даної моделі.

Метод load бере з бази даних то єдиний об'єкт налаштувань, якщо ж об'єкт не існує в базі даних, то повертає новий інстанси цієї моделі, який потрібно буде потім зберегти.

Створимо кастомний клас налаштувань, щоб в подальшому використовувати його для наших потреб.

# -*- coding: utf-8 -*-

from django.db import models
from django.utils.translation import ugettext_lazy as _

from my_app.singleton_model import SingletonModel


class SiteSettings(SingletonModel):
    site_url = models.URLField(verbose_name=_('Website url'), max_length=256)
    title = models.CharField(verbose_name=_('Title'), max_length=256)

    def __str__(self):
        return 'Configuration'

2. Налаштування панелі адміністрування

Тепер потрібно заборонити видаляти даний запис і створювати нові в панелі адміністрування Django.

# -*- coding: utf-8 -*-

from django.contrib import admin
from django.db.utils import ProgrammingError

from my_app.models import SiteSettings


class SiteSettingsAdmin(admin.ModelAdmin):
    # Створимо об'єкт за замовчуванням при першому сторінки SiteSettingsAdmin зі списком налаштувань
    def __init__(self, model, admin_site):
        super().__init__(model, admin_site)
        # обов'язково оберніть завантаження і збереження SiteSettings в try catch,
        # Щоб можна було виконати створення міграцій бази даних
        try:
            SiteSettings.load().save()
        except ProgrammingError:
            pass

    # забороняємо додавання нових налаштувань
    def has_add_permission(self, request, obj=None):
        return False

    # а також видалення існуючих
    def has_delete_permission(self, request, obj=None):
        return False


admin.site.register(SiteSettings, SiteSettingsAdmin)

Тепер налаштування можна використовувати в Python коді

3. Створення context processor для завантаження налаштувань в шаблон

context_proccessors.py

# -*- coding: utf-8 -*-

from evileg_settings.models import SiteSettings


def load_settings(request):
    return {'site_settings': SiteSettings.load()}

settings.py

Після чого підключаємо load_settings

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                # Загружаем наши настройки при каждом рендеринге шаблона с контекстом
                'my_app.context_processors.load_settings', 
            ],
        },
    },
]

Використання в шаблоні

<h1>{{ site_settings.title }}</h1>

Висновок

Ось так швидко і просто можна впровадити в Django прості динамічні налаштування сайту і потім прив'язувати їх до все цікавлять нас параметрам сайту.
Перевагою такого підходу буде можливість використання зовнішніх ключів на якісь спеціальні дані на сайту, а також використання django modeltranslation, а значить не буде проблем з багатомовна.