Мен ұзақ уақыт бойы Django жобасы үшін өрісті автоматты толтыру функционалдығын қалай жазу керектігі туралы мақала жазғым келді. Бұл автоматты толтыруды пайдаланатын өріске мән орнату арқылы Django бағдарламасындағы басқа үлгі өрістерінің мазмұнын өзгертуге мүмкіндік беретін өте пайдалы мүмкіндік.
Біріншіден, бұл не үшін қажет? - Мұндай функционалдылық объектінің басқа өрістерін өзгерткен кезде қайта жазу қажет жерлерде код өлшемін азайтуға мүмкіндік береді. Яғни, мысалы, нысанның басқа өрістері өзгерген жағдайда кейбір өрісті қайта жазу үшін сақтау әдісін әр жолы қайта анықтаудың қажеті жоқ. Сондай-ақ, автоматты толтыруды пайдалану негізінен Django-да деректер үлгілерін басқарудың жетілдірілген және ұқыпты тәсілі болып табылады.
Сондай-ақ ұқсас тәсіл кейбір мәселелерді шеше алады және сайтты жақсартады.
Мысал ретінде белгілеу өрістерін қолданатын тәсілдің сипаттамасы
Мысалы, мен осы сайтта түсініктемелер мен мақалалардың мазмұнын жазу үшін және жалпы markdown синтаксисі қолданылатын барлық өрістерде осы тәсілді қолданамын.
Бұл қалай жұмыс істейді?
- Барлық деректер үлгілерінің екі өрісі мазмұн және content_markdown болады. content_markdown өрісі мазмұн өрісінің мазмұнын басқарады. Яғни, қалыпты жағдайда пайдаланушының мазмұн өрісінің мазмұнын өңдеуге рұқсаты жоқ, ол әрқашан тек content_markdown өрісін өңдейді.
- Пайдаланушы хабарлама жасаған кезде content_markdown өрісін өңдейді, ол markdown белгілеуінен html кодын автоматты түрде жасайды және content өрісіне html жазады. .
Бұл не үшін қажет?
Неліктен автоматты толтыруды пайдалану керектігін әркім өзі таңдайды. Мысалы, бастапқы кескіннен нобай кескінін автоматты түрде жасауға болады. Мұндай функционалдылық мұндай әрекеттер үшін өте қолайлы.
Нақтырақ айтсам, мен markdown-дан html құру үшін қолайлы функционалдылықты таппадым. Мен сол кезде таптым, үлгі тегтері арқылы әрбір бет жүктелуінде орындалу уақытында html жасайтын кітапханалар болды. Және бұл тәсіл сайттың өнімділігін айтарлықтай төмендетеді. Сондықтан мен веб-сайттың өнімділігі үшін дискілік кеңістікті құрбан етуге дайынмын деп шештім. Ақыр соңында, бетті жүктеу жылдамдығын он есе арттыру кейбір жағдайларда дискілік кеңістіктің көлемін екі есе ұлғайтқан дұрыс.
Іске асыру
Мен сіздің веб-сайтыңызда қолдануға болатын жеңілдетілген MarkdownField кодын ұсынамын.
Белгілеу өрісі
MarkdownField стандартты TextField мұрагері болады және html мазмұны үшін пайдаланылатын өріс атауын аргумент ретінде қабылдайды. Бұл html_өріс аргументі.
Бұл өрісте markdown белгілеуінен html жасауға және мазмұнның html өрісінде мәнді орнатуға жауап беретін set_html әдісі бар.
Маңызды мәселе - set_html әдісін class_to_contribute әдісіндегі алдын ала_сақтау сигналына қосу. Мен әзірлеген бұрынғы нұсқаның кемшілігі болды, бұл нысан сұралған сайын html-генерациялау әдісі шақырылады. Бұл қате болды, мен кейінірек дәл осылай түзеттім. Енді мазмұн нысан сақталған жағдайда ғана жасалады.
# -*- coding: utf-8 -*-
from django.db import models
from django.db.models.signals import pre_save
from .utils import MarkdownWorker
class MarkdownField(models.TextField):
"""
This field save markdown text with auto-populate text to html field.
This field must be used with second text field for html content.
"""
def set_html(self, instance=None, update_fields=None, **kwargs):
value = getattr(instance, self.attname)
if value and len(value) > 0:
instance.__dict__[self.html_field] = MarkdownWorker(value).get_text()
def contribute_to_class(self, cls, name, **kwargs):
super().contribute_to_class(cls, name, **kwargs)
pre_save.connect(self.set_html, sender=cls)
def __init__(self, html_field=None, *args, **kwargs):
self.html_field = html_field
super().__init__(*args, **kwargs)
MarkdownWorker
Бұл сынып белгілеу белгілеуінен html мазмұнын жасауға жауапты. Бұл сыныпта қажетті нәтижені алу үшін html-ден өңдеудің кез келген қосымша түрлерін қосуға болады. Мысалы, пайдаланушы қоса алмайды деп ойлайтын сілтемелерді немесе кескіндерді жоюға болады.
MarkdownWorker класының объектісін құру кезінде өңделетін мәтін орнатылады, содан кейін мәтінді html-ге түрлендіретін әдіс шақырылады.
Сондай-ақ менің жағдайда кеңейтімдер мыналар үшін пайдаланылады:
- Кестені құру
- Кодты қолдау
- Трансферттік толықтырулар
- Жоғарғы және төменгі синтаксис
# -*- coding: utf-8 -*-
import markdown
class MarkdownWorker:
"""
Markdown converter. It will convert markdown text to html text
"""
def __init__(self, text):
self.pre_markdown_text = text
self.markdown_text = None
self.make_html_from_markdown()
def make_html_from_markdown(self):
if self.pre_markdown_text:
self.markdown_text = markdown.markdown(
self.pre_markdown_text,
extensions=['markdown.extensions.attr_list',
'markdown.extensions.tables',
'markdown.extensions.fenced_code',
'markdown.extensions.nl2br',
'superscript',
'subscript'],
output_format='html5'
)
def get_text(self):
return self.markdown_text
Барлық осы функцияларды қолдау үшін сізге кітапханаларды орнату қажет:
- Белгілеу
- MarkdownSubscript
- MarkdownSuperscript
Сондай-ақ beautifulsoup4 болуы мүмкін немесе ол тәуелділікте орнатылады, бірақ шынымды айтсам, есімде жоқ.
Қолдану
Ал енді осы өрісті деректер үлгісінде қолданайық.
Бізде өрістерді қамтитын Post үлгісі бар:
- пайдаланушы - әр пайдаланушыға арналған сыртқы кілт
- мазмұн - html мазмұнын қамтитын өріс
- content_markdown - html мәтінінің кейінгі генерациясымен бірге белгілеу мәтіні сақталатын өріс. Бұл ретте html_field='content' аргументі оған жіберілгенін көре аласыз, ол MarkdownField қай өріспен жұмыс істеу керектігін айтады.
# -*- coding: utf-8 -*-
from django.conf import settings
from django.db import models
from django.utils.translation import gettext_lazy as _
from .fields import MarkdownField
class Post(models.Model):
user = models.ForeignKey(to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
content = models.TextField(verbose_name=_('Description'))
content_markdown = MarkdownField(verbose_name=_('Description - Markdown'), html_field='content')
Қорытынды
Осылайша сіз html мазмұнын автоматты түрде жасайтын сайтқа белгілеу өрістерін қоса аласыз.
Енді сіздің сайтыңызда html мазмұнын автоматты түрде жасайтын сәнді белгілеу синтаксисіне қолдау көрсетіледі.
