Django - Урок 057. Підтримка мультимовності в MarkdownField з функціоналом auto populate

MarkdownField, markdown, modeltranslation, Django

У статті Як написати функціонал auto populate field було дано опис найпростішого функціоналу поля MarkdownField для підтримки markdown синтаксису на сайті з автоматичним генеруванням html контенту.

Я не став відразу показувати розширений функціонал, щоб було простіше зрозуміти, що являє собою подібне Markdown поле. Але тепер хотів би розширити цей функціонал, щоб додати підтримку мультимовності.

Постановка завдання

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

Реалізація

Для того, щоб це реалізувати, необхідно перевірити в налаштуваннях сайту (файл settings.py) наявність підключеного додатка modeltranslation , а потім виконати генерування HTML контенту у відповідному полі з обраною мовою.

Щоб правильно реалізувати підтримку даного функціоналу, виконаємо модифікацію методу set_html із статті Як написати функціонал auto populate field .

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

from django.conf import settings
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.
    This field support django-modeltranslation package.
    """

    def set_html(self, instance=None, update_fields=None, **kwargs):
        value = getattr(instance, self.attname)
        if value and len(value) > 0:
            languages = getattr(settings, "LANGUAGES", None)
            if 'modeltranslation' in settings.INSTALLED_APPS and self.name.endswith(tuple([code for code, language in languages])):
                instance.__dict__['{}_{}'.format(self.html_field, self.name[-2:])] = MarkdownWorker(value).get_text()
            else:
                instance.__dict__[self.html_field] = MarkdownWorker(value).get_text()

    # Program code from previoues article

Коли викликається метод set_html , ми перевіряємо наявність прило modeltranslation в налаштуваннях сайту, а також що ім'я markdown поля закінчується на код однієї з мов зареєстрованих на сайті.
Якщо умова виконується, ми встановлюємо згенерований html контент в html полі з кодом мови, який закінчується ім'я MarkdownField. Інакше встановлюємо контент у звичайне поле html_field.

Чому це працює?

Якщо ви ще не знайомі з modeltranslation , то коротко опишу принцип роботи даної батареї без докладного процесу використання даної батарейки. Бо офіційна документація мені видається вичерпною.

При реєстрації поля як мультимовного за допомогою modeltranslation , у таблиці моделі створюються ще додаткові поля з кодом усіх мов, які зареєстровані на сайті змінної LANGUAGES.

Тобто, якщо в моделі даних додано звичайне поле content та markdown поле content_markdown , то за підтримки російської та англійської мов будуть додані наступні поля:

• content_ru
• content_en
• content_markdown_ru
• content_markdown_en

Тому коли MarkdownField має ім'я content_markdown_en , то він бере значення html_field , яке дорівнює content і додає код мови з content_markdown_en , таким чином виходить content_en .

Тим самим підтримується мультимовність для MarkdownField .