django-linguist 0.1.0

Models

In three steps:

1. Add linguist.metaclasses.ModelMeta to your model as metaclass

2. Add linguist.mixins.ManagerMixin to your model manager

3. Add linguist settings in your model’s Meta

Don’t worry, it’s fairly simple:

from django.db import models
from django.utils.translation import ugettext_lazy as _

from linguist.metaclasses import ModelMeta as LinguistMeta
from linguist.mixins import ManagerMixin as LinguistManagerMixin


class PostManager(LinguistManagerMixin, models.Manager):
    pass


class Post(models.Model):

    __metaclass__ = LinguistMeta

    title = models.CharField(max_length=255)
    body = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    objects = PostManager()

    class Meta:
        verbose_name = _('post')
        verbose_name_plural = _('posts')
        linguist = {
            'identifier': 'can-be-anything-you-want',
            'fields': ('title', 'body'),
            'default_language': 'fr',
        }

The linguist meta requires:

• identifier: a unique identifier for your model (can be anything you want)

• fields: list or tuple of model fields to translate

And optionally requires:

• default_language: the default language to use

• default_language_field: the field that contains the default language to use (see below)

• decider: the translation model to use instead of the default one (see below)

That’s all. You’re ready.

Default language per instance

Sometimes, you need to define default language at instance level. Linguist supports this feature via the default_language_field option. Add a field in your model that will store the default language then simply give the field name to Linguist.

Let’s take an example:

from django.db import models
from django.utils.translation import ugettext_lazy as _

from linguist.metaclasses import ModelMeta as LinguistMeta
from linguist.mixins import ManagerMixin as LinguistManagerMixin


class PostManager(LinguistManagerMixin, models.Manager):
    pass


class Post(models.Model):

    __metaclass__ = LinguistMeta

    title = models.CharField(max_length=255)
    body = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    lang = models.CharField(max_length=5, default='en')

    objects = PostManager()

    class Meta:
        verbose_name = _('post')
        verbose_name_plural = _('posts')
        linguist = {
            'identifier': 'can-be-anything-you-want',
            'fields': ('title', 'body'),
            'default_language': 'en',
            'default_language_field': 'lang',
        }

Custom table for translations

By default, Linguist stores translations into linguist.models.Translation table. So in a single one table. If you need to use another table for a specific model, Linguist provides a way to override this behavior: use deciders.

That’s really easy to implement.

You can do it in three steps:

• Create a model that inherits from linguist.models.base.Translation

• Don’t forget to define it as concrete (abstract = False in Meta)

• Give this model to Linguist meta decider option

This example will show you the light:

from django.db import models
from django.utils.translation import ugettext_lazy as _

from linguist.metaclasses import ModelMeta as LinguistMeta
from linguist.mixins import ManagerMixin as LinguistManagerMixin
from linguist.models.base import Translation


# Our Post model decider
class PostTranslation(Translation):
    class Meta:
        abstract = False


class PostManager(LinguistManagerMixin, models.Manager):
    pass


class Post(models.Model):

    __metaclass__ = LinguistMeta

    title = models.CharField(max_length=255)
    body = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    objects = PostManager()

    class Meta:
        verbose_name = _('post')
        verbose_name_plural = _('posts')
        linguist = {
            'identifier': 'can-be-anything-you-want',
            'fields': ('title', 'body'),
            'default_language': 'fr',
            'decider': PostTranslation,
        }

django.contrib.admin

Simply use linguist.admin.ModelTranslationAdmin class:

from django.contrib import admin
from linguist.admin import ModelTranslationAdmin
from .models import Post


class PostAdmin(ModelTranslationAdmin):
    list_display = ('title', 'body', 'created_at')


admin.site.register(Post, PostAdmin)

Bonus! You can display instance’s languages in list_display via the languages_column property provided by the admin class:

from django.contrib import admin
from linguist.admin import ModelTranslationAdmin
from .models import Post


class PostAdmin(ModelTranslationAdmin):
    list_display = ('title', 'body', 'languages_column', 'created_at')


admin.site.register(Post, PostAdmin)