Django - Підручник 021. Наслідування моделі, абстрактна модель

model, Django, наследование

Після проведення рефакторингу на сайті було виділено чотири основні сутності, у яких були виділені загальні властивості, а саме:

• Article - Статті
• Comment - Коментарі
• ForumTopic - Теми форуму (вони ж питання)
• ForumPost - Відповіді до тем форуму

Звичайно, і так було ясно, що ці сутності можуть мати однакові поля даних, однакові методи тощо. Але при розробці даного сайту я сам одночасно вивчаю Python і Django. Тому проект носить характер хаотичного внесення невеликих ToDo з наступним рефакторингом щодо кращих підходів. Тому після вивчення можливостей успадкування моделей в Django була виділена одна загальна абстрактна модель даних PostBase , яка має чотири поля, які повторюються у всіх вище перерахованих моделях.

Тут є один важливий момент: Модель, яка оголошується абстрактною, не створюватиме таблицю в базі даних.

Щоб створити абстрактну модель необхідно встановити змінну abstract у значення True для класу Meta.

PostBase

PostBase – це буде базова абстрактна модель. У цій абстрактній моделі даних було виділено чотири поля, які є спільними для перелічених вище моделей:

• author - автор статті, коментаря, теми чи відповіді;
• content - зміст;
• pub_date - дата публікації;
• moderation - модерація, весь контент може мати чотири можливі варіанти:
• SPAM – без коментарів;
• NOT_MODERATED - Не перевірений запис, в даному випадку статті користувачів з цим статусом не будуть доступні іншим користувачам до модерації;
• POST_MODERATED – модерація після публікації, стаття користувача буде доступна іншим користувачам після публікації, але вона ще не пройшла модерацію;
• MODERATED – запис пройшов модерацію.

Оголошення даної абстрактної моделі буде наступне:

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

from django.db import models
from django.contrib.auth.models import User
from django.utils.translation import ugettext_lazy as _

from ckeditor_uploader.fields import RichTextUploadingField

class PostBase(models.Model):
    class Meta:
        abstract = True    # данное поле указывает, что класс абстрактный
                           # и что для него не нужно создавать таблицу

    SPAM = 'S'
    NOT_MODERATED = 'N'
    POST_MODERATED = 'P'
    MODERATED = 'M'
    MODERATION_CHOICES = (
        (SPAM, 'SPAM'),
        (NOT_MODERATED, 'Not Moderated'),
        (POST_MODERATED, 'Post Moderated'),
        (MODERATED, 'Moderated')
    )

    author = models.ForeignKey(User, verbose_name=_("Автор"))
    content = models.TextField(_('Содержание'), blank=True)
    pub_date = models.DateTimeField(_('Дата публикации'), blank=True, null=True)
    moderation = models.CharField(
        _('Модерация'),
        max_length=1,
        choices=MODERATION_CHOICES,
        default=NOT_MODERATED
    )

Таким чином є можливість скоротити програмний код проекту і додати можливість повторного використання коду, що повторюється.

Структура моделі, наприклад, для коментарів тепер може виглядати так:

class Comment(PostBase):
    class Meta:
        db_table = "comments"

    article = models.ForeignKey(Article)

Поля author , pub_date , content та moderation вже не потрібно вказувати, оскільки вони присутні у PostBase класі. Головне, не вводіть у свою модель поля з такими ж іменами, як моделі PostBase.

PostBaseAdmin

Також безперечним плюсом є те, що можна точно зробити одну загальну для всіх класів налаштування адмін панелі.

Зробимо, наприклад, відображення полів, налаштування пошуку та фільтрації контенту та можливість встановлення статусу модерації (тобто додамо відповідні actions ).

class PostBaseAdmin(admin.ModelAdmin):
    list_display = ('content', 'author', 'pub_date')
    search_fields = ('content', 'author__username')
    list_filter = ('moderation',)
    actions = ['make_spam', 'make_not_moderated', 'make_post_moderated', 'make_moderated']

    def moderate(self, request, rows_updated, choice_description):
        if rows_updated == 1:
            message_bit = "1 запись помечена, как %s" % choice_description
        else:
            message_bit = "%s записей отмечены, как %s." % (rows_updated, choice_description)
        self.message_user(request, "%s" % message_bit)

    def make_spam(self, request, queryset):
        self.moderate(
            request=request,
            rows_updated=queryset.update(moderation=PostBase.SPAM),
            choice_description="SPAM"
        )
    make_spam.short_description = "Отметить помеченные, как SPAM"

    def make_not_moderated(self, request, queryset):
        self.moderate(
            request=request,
            rows_updated=queryset.update(moderation=PostBase.NOT_MODERATED),
            choice_description="NOT_MODERATED"
        )
    make_not_moderated.short_description = "Отметить помеченные, как NOT_MODERATED"

    def make_post_moderated(self, request, queryset):
        self.moderate(
            request=request,
            rows_updated=queryset.update(moderation=PostBase.POST_MODERATED),
            choice_description="POST_MODERATED"
        )
    make_post_moderated.short_description = "Отметить помеченные, как POST_MODERATED"

    def make_moderated(self, request, queryset):
        self.moderate(
            request=request,
            rows_updated=queryset.update(moderation=PostBase.MODERATED),
            choice_description="MODERATED"
        )
    make_moderated.short_description = "Отметить помеченные, как MODERATED"

Якщо ви захочете розширити аркуші фільтрації або додати actions, для якоїсь моделі, то можна успадковуватися від PostBaseAdmin наступним чином:

class ArticleAdmin(PostBaseAdmin):
    # Либо полностью переопределить отображаемые поля или поля для поиска
    list_display = ('title', 'section', 'author', 'pub_date', 'views', 'moderation')
    search_fields = ('title', 'author__username', 'section__title')
    # Либо добавить к существующему списку дополнительные
    list_filter = PostBaseAdmin.list_filter + ('status', 'section')
    # В случае actions подобное объявление просто добавит новые actions к существующим
    actions = ['publish', 'unpublish']

Для Django рекомендую VDS-сервера хостера Timeweb .