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 .