- 1. PostBase
- 2. PostBaseAdmin
После проведения рефакторинга на сайте, было выделено четыре основных сущности, у которых были выделены общие свойства, а именно:
- Article - Статьи
- Comment - Комментарии
- ForumTopic - Темы форума (они же вопросы)
- ForumPost - Ответы к темам форума
Конечно, и так было ясно, что эти сущности могут иметь одинаковые поля данных, одинаковые методы и т.д. Но при разработке данного сайта я и сам одновременно изучаю Python и Django. Поэтому проект носит характер хаотичного внесение небольших ToDo с последующим рефакторингом при изучении лучших подходов. Поэтому после изучения возможностей наследования моделей в Django, была выделена одна общая абстрактная модель данных PostBase , которая имеет четыре поля, которые повторяются во всех выше перечиcленных моделях.
Здесь есть один важный момент: Модель, которая объявляется абстрактной, не будет создавать таблицу в базе данных.
Чтобы создать абстрактную модель необходимо установить переменную 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 .
