Traduction

Aperçu

Dans le but de rendre traduisible un projet Django, il est nécessaire d’ajouter un minimum de marqueurs dans le code Python et les gabarits. Ces marqueurs s’appellent des chaînes de traduction. Ils indiquent à Django que « ce texte doit être traduit dans la langue de l’utilisateur pour autant qu’il existe une traduction de ce texte dans cette langue ». Il est de votre responsabilité de marquer les chaînes de caractères traduisibles ; le système ne peut traduire que les éléments qu’on lui a indiqués.

Django fournit ensuite des utilitaires pour extraire les chaînes à traduire dans un fichier de messages. Ce fichier sert ensuite aux traducteurs qui pourront faire leur travail en rédigeant les équivalences des chaînes à traduire dans leur langue. Lorsque que ce travail est terminé, le fichier doit être compilé. Ce processus se base sur les outils GNU gettext.

Quand tout cela est fait, Django s’occupe de traduire les applications Web à la volée dans chacune des langues disponibles, en accord avec les préférences linguistiques des utilisateurs.

Le système d’internationalisation de Django est activé par défaut, ce qui peut générer un petit surplus de travail à certains endroits du système. Si vous n’utilisez pas l’internationalisation, prenez les deux secondes nécessaires à définir USE_I18N = False dans votre fichier de réglages. Django pourra alors effectuer certaines optimisations en ne chargeant pas tout le mécanisme d’internationalisation.

Note

Il existe également un réglage différent mais lié nommé USE_L10N qui contrôle l’activation ou non des formats de régionalisation. Voir Régionalisation des formats pour plus de détails.

Note

Vérifiez si la traduction est activée dans votre projet (la manière la plus rapide est de contrôler la présence de django.middleware.locale.LocaleMiddleware dans MIDDLEWARE_CLASSES). Si ce n’est pas encore fait, lisez Processus de découverte de la préférence de langue par Django.

Internationalisation : dans le code Python

Traduction standard

Définissez une chaîne à traduire en utilisant la fonction ugettext(). Par convention, il est fréquent de l’importer par un alias plus court, _, pour s’économiser des frappes au clavier.

Note

Le module gettext de la bibliothèque Python standard installe _() dans l’espace de noms global comme alias de gettext(). Dans Django, nous avons choisi de ne pas suivre cette pratique, pour plusieurs raisons :

  1. Pour la prise en charge des jeux de caractères internationaux (Unicode), ugettext() est plus utile que gettext(). Parfois, il est préférable d’utiliser ugettext_lazy() comme méthode de traduction par défaut dans un certain fichier. En l’absence de _() dans l’espace de noms global, le développeur doit réfléchir à ce qui est le plus approprié comme fonction de traduction.

  2. Le caractère soulignement (_) est utilisé pour représenter le « résultat précédent » dans le shell interactif de Python et les tests doctest. L’installation globale de _() interfère avec le précédent. L’importation explicite de ugettext() comme _() évite ce problème.

Dans cet exemple, le texte "Welcome to my site." est marqué comme chaîne à traduire :

from django.utils.translation import ugettext as _
from django.http import HttpResponse

def my_view(request):
    output = _("Welcome to my site.")
    return HttpResponse(output)

On aurait pu évidemment écrire cela sans employer l’alias. Cet exemple est identique au précédent :

from django.utils.translation import ugettext
from django.http import HttpResponse

def my_view(request):
    output = ugettext("Welcome to my site.")
    return HttpResponse(output)

La traduction fonctionne sur des valeurs calculées. Cet exemple est identique aux deux précédents :

def my_view(request):
    words = ['Welcome', 'to', 'my', 'site.']
    output = _(' '.join(words))
    return HttpResponse(output)

La traduction fonctionne avec des variables. Encore une fois, voici un exemple identique :

def my_view(request):
    sentence = 'Welcome to my site.'
    output = _(sentence)
    return HttpResponse(output)

(L’inconvénient avec l’utilisation de variables ou de valeurs calculées comme dans les deux exemples précédents, c’est que l’utilitaire de détection des chaînes à traduire de Django, django-admin makemessages, ne sera pas capable de trouver ces chaînes. Plus de détails sur makemessages un peu plus tard.)

Les chaînes que vous placez dans _() ou ugettext() acceptent des substituants sous la forme de la syntaxe d’interpolation par paramètres nommés standard de Python. Exemple :

def my_view(request, m, d):
    output = _('Today is %(month)s %(day)s.') % {'month': m, 'day': d}
    return HttpResponse(output)

Cette technique permet aux différentes traductions de modifier l’ordre des substituants. Par exemple, pour un texte anglais "Today is November 26.", la traduction espagnole pourrait être "Hoy es 26 de Noviembre.", avec les substituants mois et jour intervertis.

Pour cette raison, il est recommandé d’utiliser l’interpolation par paramètre nommé (ex : %(day)s) au lieu de l’interpolation par position (ex : %s ou %d) chaque fois qu’il y a plus d’un paramètre. Avec l’interpolation par position, les traductions ne peuvent pas changer l’ordre des substituants.

Commentaires pour les traducteurs

Si vous souhaitez donner des indications aux traducteurs à propos d’une chaîne à traduire, vous pouvez ajouter un commentaire préfixé par le mot-clé Translators à la ligne précédant la chaîne ; par exemple :

def my_view(request):
    # Translators: This message appears on the home page only
    output = ugettext("Welcome to my site.")

Le commentaire apparaîtra alors dans le fichier .po résultant de l’extraction des chaînes, juste avant le bloc de la chaîne à traduire, et la plupart des outils de traduction l’affichent également dans leur interface.

Note

Pour les curieux, voici le fragment correspondant dans le fichier .po résultant :

#. Translators: This message appears on the home page only
# path/to/python/file.py:123
msgid "Welcome to my site."
msgstr ""

Cela fonctionne aussi dans les gabarits. Voir Commentaires pour les traducteurs dans les gabarits pour plus de détails.

Marquage des chaînes « en blanc »

La fonction django.utils.translation.ugettext_noop() permet de marquer une chaîne comme chaîne à traduire, mais sans la traduire réellement. La traduction effective peut se faire plus tard à partir d’une variable.

Cette technique est utile pour des chaînes constantes devant être stockées dans la langue source parce qu’elles sont échangées entre systèmes ou utilisateurs, comme des chaînes en base de données, mais qu’elles devraient être traduites le plus tard possible, juste avant d’être affichées pour un utilisateur.

Pluriels

La fonction django.utils.translation.ungettext() permet de marquer des messages contenant un pluriel.

ungettext accepte trois paramètres : la chaîne à traduire au singulier, la chaîne à traduire au pluriel et le nombre d’objets.

Cette fonction est utile lorsque vous voulez traduire votre application Django dans des langues où le nombre et la complexité des formes plurielles sont plus grands que les deux formes utilisées en anglais (« object » pour le singulier et « objects » dans tous les cas où count est différent de un, quelle que soit sa valeur).

Par exemple :

from django.utils.translation import ungettext
from django.http import HttpResponse

def hello_world(request, count):
    page = ungettext(
        'there is %(count)d object',
        'there are %(count)d objects',
    count) % {
        'count': count,
    }
    return HttpResponse(page)

Dans cet exemple, le nombre d’objets est communiqué à la langue de traduction par la variable count.

Notez que les pluriels sont compliqués et fonctionnent différemment pour chaque langue. La comparaison de count avec 1 n’est pas toujours la règle correcte. Ce code semble sophistiqué, mais produira des résultats incorrects pour certaines langues :

from django.utils.translation import ungettext
from myapp.models import Report

count = Report.objects.count()
if count == 1:
    name = Report._meta.verbose_name
else:
    name = Report._meta.verbose_name_plural

text = ungettext(
    'There is %(count)d %(name)s available.',
    'There are %(count)d %(name)s available.',
    count
) % {
    'count': count,
    'name': name
}

N’essayez pas d’implémenter votre propre logique de singulier/pluriel, vous n’y arriverez pas. Dans un cas comme celui-ci, pensez plutôt à faire quelque chose comme :

text = ungettext(
    'There is %(count)d %(name)s object available.',
    'There are %(count)d %(name)s objects available.',
    count
) % {
    'count': count,
    'name': Report._meta.verbose_name,
}

Note

En utilisant ungettext(), prenez soin de toujours utiliser le même nom pour chaque variable extrapolée incluse dans la chaîne. Dans les exemples ci-dessus, notez comment nous avons utilisé la variable Python name dans les deux chaînes à traduire. Cet exemple, en plus d’être faux pour certaines langues comme nous l’avons mentionné, ne fonctionnera pas :

text = ungettext(
    'There is %(count)d %(name)s available.',
    'There are %(count)d %(plural_name)s available.',
    count
) % {
    'count': Report.objects.count(),
    'name': Report._meta.verbose_name,
    'plural_name': Report._meta.verbose_name_plural
}

Vous obtiendriez une erreur lors du lancement de django-admin compilemessages:

a format specification for argument 'name', as in 'msgstr[0]', doesn't exist in 'msgid'

Note

Pluriel et fichiers po

Django ne supporte pas l’utilisation de pluriels personnalisés dans les fichiers po. Comme tous les catalogues de traduction sont fusionnés, seule la forme plurielle du fichier po principal de Django (dans django/conf/locale/<lang_code>/LC_MESSAGES/django.po) est pris en compte. Les formes plurielles dans tous les autres fichiers po sont ignorées. Par conséquent, vous ne devriez pas utiliser différentes formes de pluriels dans les fichiers po de votre projet ou de votre application.

Marqueurs contextuels

Il peut arriver que des mots ont plusieurs significations, comme "May" en anglais, qui peut se référer à un nom de mois ou à un verbe. Pour permettre aux traducteurs de traduire correctement ces mots dans des contextes différents, il est possible d’utiliser la fonction django.utils.translation.pgettext(), ou django.utils.translation.npgettext() si la chaîne contient des pluriels. Les deux acceptent une chaîne de contexte comme premier paramètre.

Dans le fichier .po résultant, la même chaîne apparaîtra aussi souvent qu’il y a de marqueurs contextuels différents (le contexte apparaît à la ligne msgctxt), permettant ainsi au traducteur d’attribuer des traductions différentes à chacune d’elles.

Par exemple :

from django.utils.translation import pgettext

month = pgettext("month name", "May")

ou :

from django.db import models
from django.utils.translation import pgettext_lazy

class MyThing(models.Model):
    name = models.CharField(help_text=pgettext_lazy(
        'help text for MyThing model', 'This is the help text'))

apparaîtra dans le fichier .po comme :

msgctxt "month name"
msgid "May"
msgstr ""

Les marqueurs contextuels sont également pris en charge par les balises de gabarit trans et blocktrans.

Traduction différée

Les versions différées des fonctions de traduction dans django.utils.translation (facilement reconnaissables par le suffixe lazy dans leur nom) permettent de traduire du texte en différé, au moment où la chaîne est réellement utilisée plutôt qu’au moment où la fonction est appelée.

Ces fonctions stockent une référence différée à la chaîne originale, et non pas la traduction réelle. La traduction en tant que telle est effectuée lorsque le texte est utilisé dans un contexte textuel, par exemple dans le rendu d’un gabarit.

Ce procédé est essentiel lorsque les appels à ces fonctions sont situés dans des endroits du code qui sont exécutés lors du chargement des modules.

Ceci peut facilement se produire lors de la définition des modèles, des formulaires et des formulaires de modèle, car la manière dont Django les implémente fait que leurs champs sont des attributs de classe. C’est pour cette raison qu’il faut utiliser des traductions différées dans les cas suivants :

Valeurs d’options verbose_name et help_text des champs et relations de modèle

Par exemple, pour traduire le texte d’aide du champ name dans le modèle suivant, faites comme ceci :

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

class MyThing(models.Model):
    name = models.CharField(help_text=_('This is the help text'))

Vous pouvez marquer les noms des relations ForeignKey, ManyToManyField ou OneToOneField comme chaînes à traduire en utilisant leur option verbose_name:

class MyThing(models.Model):
    kind = models.ForeignKey(
        ThingKind,
        on_delete=models.CASCADE,
        related_name='kinds',
        verbose_name=_('kind'),
    )

Comme vous le feriez pour verbose_name, le texte de nom verbeux de la relation devrait être en minuscules, car Django s’occupe de mettre les majuscules dans les situations appropriées.

Valeurs de noms verbeux de modèle

Il est recommandé de toujours fournir les options explicites verbose_name et verbose_name_plural plutôt que de vous rabattre sur la version anglo-centrique et déterminée de manière quelque peu naïve du nom verbeux que Django crée en se basant sur le nom de classe du modèle :

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

class MyThing(models.Model):
    name = models.CharField(_('name'), help_text=_('This is the help text'))

    class Meta:
        verbose_name = _('my thing')
        verbose_name_plural = _('my things')

Valeurs d’attribut short_description des méthodes de modèle

Pour les méthodes de modèle, vous pouvez indiquer à Django et au site d’administration des descriptions traduisibles dans l’attribut short_description:

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

class MyThing(models.Model):
    kind = models.ForeignKey(
        ThingKind,
        on_delete=models.CASCADE,
        related_name='kinds',
        verbose_name=_('kind'),
    )

    def is_mouse(self):
        return self.kind.type == MOUSE_TYPE
    is_mouse.short_description = _('Is it a mouse?')

Manipulation des objets de traduction différée

Le résultat d’un appel ugettext_lazy() peut être utilisé à tous les endroits où peut se trouver une chaîne unicode (objet de type unicode) dans du code Python. Si vous essayez de l’utiliser là où une chaîne d’octets (objet de type str) est attendue, les choses ne vont pas fonctionner comme prévu, car un objet ugettext_lazy() ne sait pas comment se convertir lui-même en chaîne d’octets (« bytestring »). Il n’est pas non plus possible de placer une chaîne unicode dans une chaîne d’octets, cela reste donc cohérent par rapport au comportement Python normal. Par exemple :

# This is fine: putting a unicode proxy into a unicode string.
"Hello %s" % ugettext_lazy("people")

# This will not work, since you cannot insert a unicode object
# into a bytestring (nor can you insert our unicode proxy there)
b"Hello %s" % ugettext_lazy("people")

Dans le cas où vous voyez un contenu ressemblant à "hello <django.utils.functional...>", c’est que vous avez essayé d’insérer le résultat de ugettext_lazy() dans une chaîne d’octets. Il s’agit d’un bogue dans le code.

Si vous n’aimez pas le long nom de ugettext_lazy, vous pouvez simplement en faire un alias _ (soulignement), comme ceci :

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

class MyThing(models.Model):
    name = models.CharField(help_text=_('This is the help text'))

L’utilisation de ugettext_lazy() et ungettext_lazy() pour marquer des chaînes dans des modèles et des fonctions utilitaires est une opération courante. Lorsque que vous manipulez ces objets ailleurs dans votre code, vous devriez prendre soin de ne jamais les convertir accidentellement en chaînes de caractères, car ils devraient être convertis le plus tard possible (afin que la langue correcte soit active). Ceci nécessite l’emploi de la fonction utilitaire décrite ci-après.

Traductions différées et pluriels

Lors de l’utilisation de traductions différées avec une chaîne contenant des pluriels ([u]n[p]gettext_lazy), vous ne connaissez généralement pas le paramètre number au moment de la définition de la chaîne. C’est pourquoi vous êtes autorisé dans ce cas à passer un nom de clé au lieu d’un nombre comme paramètre number. Ensuite, cette clé number sera cherchée dans le dictionnaire durant l’extrapolation de la chaîne. Voici un exemple :

from django import forms
from django.utils.translation import ungettext_lazy

class MyForm(forms.Form):
    error_message = ungettext_lazy("You only provided %(num)d argument",
        "You only provided %(num)d arguments", 'num')

    def clean(self):
        # ...
        if error:
            raise forms.ValidationError(self.error_message % {'num': number})

Si la chaîne contient un seul substituant non nommé, vous pouvez directement interpoler avec le paramètre number:

class MyForm(forms.Form):
    error_message = ungettext_lazy(
        "You provided %d argument",
        "You provided %d arguments",
    )

    def clean(self):
        # ...
        if error:
            raise forms.ValidationError(self.error_message % number)

Concaténation de chaînes : string_concat()

Les concaténations de chaînes habituelles de Python (''.join([...])) ne fonctionnent pas avec des listes contenant des objets de traduction différée. Il faut utiliser django.utils.translation.string_concat() à la place, ce qui va créer un objet différé qui se chargera de concaténer son contenu et de le convertir en chaîne au moment où ce contenu sera inclus dans une chaîne. Par exemple :

from django.utils.translation import string_concat
from django.utils.translation import ugettext_lazy
...
name = ugettext_lazy('John Lennon')
instrument = ugettext_lazy('guitar')
result = string_concat(name, ': ', instrument)

Dans ce cas, les traductions différées dans result ne seront converties en chaînes qu’au moment où result sera elle-même utilisée dans une chaîne (habituellement au moment du rendu du gabarit).

Autres usages de traductions différées avec lazy

Dans tout autre situation où il serait utile de différer la traduction mais qu’il est nécessaire de passer la chaîne à traduire comme paramètre d’une autre fonction, il est possible d’envelopper vous-même cette fonction à l’intérieur d’un appel à lazy. Par exemple :

from django.utils import six  # Python 3 compatibility
from django.utils.functional import lazy
from django.utils.safestring import mark_safe
from django.utils.translation import ugettext_lazy as _

mark_safe_lazy = lazy(mark_safe, six.text_type)

Puis, plus tard :

lazy_string = mark_safe_lazy(_("<p>My <strong>string!</strong></p>"))

Noms de langues régionalisés

get_language_info()[source]

La fonction get_language_info() fournit des informations détaillées sur les langues :

>>> from django.utils.translation import activate, get_language_info
>>> activate('fr')
>>> li = get_language_info('de')
>>> print(li['name'], li['name_local'], li['name_translated'], li['bidi'])
German Deutsch Allemand False

The name, name_local, and name_translated attributes of the dictionary contain the name of the language in English, in the language itself, and in your current active language respectively. The bidi attribute is True only for bi-directional languages.

La source des informations sur les langues se trouve dans le module django.conf.locale. Ces informations sont également accessibles dans le code des gabarits. Voir ci-dessous.

Changed in Django 1.9:

The 'name_translated' attribute was added.

Internationalisation : dans le code des gabarits

Les traductions dans les gabarits Django utilisent deux balises de gabarit et une syntaxe légèrement différente que dans le code Python. Pour donner accès à ces balises dans vos gabarits, ajoutez {% load i18n %} au sommet de votre gabarit. Comme pour toutes les balises de gabarit, cette balise doit être chargée dans tous les gabarits qui utilisent les traductions, même pour les gabarits qui étendent d’autres gabarits ayant déjà chargé la bibliothèque i18n.

Balise de gabarit trans

La balise de gabarit {% trans %} traduit soit une chaîne constante (entourée de guillemets simples ou doubles) ou un contenu de variable :

<title>{% trans "This is the title." %}</title>
<title>{% trans myvar %}</title>

Si l’option noop est présente, l’accès à la variable se fait toujours mais la traduction est omise. C’est utile pour marquer du contenu qui devra être traduit à un moment ultérieur :

<title>{% trans "myvar" noop %}</title>

En interne, cette technique de traduction fait appel à ugettext().

Dans le cas où une variable de gabarit (myvar ci-dessus) est passée à la balise, celle-ci résout en premier la variable en chaîne au moment de l’exécution puis consulte les catalogues de messages pour trouver une traduction.

Il n’est pas possible de mélanger du texte littéral et des variables dans {% trans %}. si vos traductions nécessitent des chaînes contenant des variables (substituants), utilisez plutôt {% blocktrans %}.

Si vous aimeriez récupérer une chaîne traduite sans l’afficher, vous pouvez utiliser la syntaxe suivante :

{% trans "This is the title" as the_title %}

<title>{{ the_title }}</title>
<meta name="description" content="{{ the_title }}">

En pratique, vous utiliserez cela pour obtenir une chaîne utilisée à plusieurs endroits dans un gabarit ou qui doit être passée comme paramètre à d’autres balises ou filtres de gabarit :

{% trans "starting point" as start %}
{% trans "end point" as end %}
{% trans "La Grande Boucle" as race %}

<h1>
  <a href="/" title="{% blocktrans %}Back to '{{ race }}' homepage{% endblocktrans %}">{{ race }}</a>
</h1>
<p>
{% for stage in tour_stages %}
    {% cycle start end %}: {{ stage }}{% if forloop.counter|divisibleby:2 %}<br />{% else %}, {% endif %}
{% endfor %}
</p>

{% trans %} prend aussi en charge les marqueurs contextuels à l’aide du mot-clé context:

{% trans "May" context "month name" %}

Balise de gabarit

Contrairement à la balise trans, la balise blocktrans permet de marquer comme chaînes à traduire des phrases complexes contenant à la fois du texte littéral et des variables par le moyen des substituants :

{% blocktrans %}This string will have {{ value }} inside.{% endblocktrans %}

Pour traduire une expression de gabarit, par exemple un accès aux attributs d’un objet ou une utilisation de filtre de gabarit, il est nécessaire de lier l’expression à une variable locale pour l’utiliser ensuite dans le bloc à traduire. Exemple :

{% blocktrans with amount=article.price %}
That will cost $ {{ amount }}.
{% endblocktrans %}

{% blocktrans with myvar=value|filter %}
This will have {{ myvar }} inside.
{% endblocktrans %}

Vous pouvez utiliser plusieurs expressions à l’intérieur d’une seule balise blocktrans:

{% blocktrans with book_t=book|title author_t=author|title %}
This is {{ book_t }} by {{ author_t }}
{% endblocktrans %}

Note

L’ancien format plus verbeux est toujours accepté : {% blocktrans with book|title as book_t and author|title as author_t %}`

D’autres balises de bloc (par exemple {% for %} ou {% if %}) ne sont pas autorisées à l’intérieur des balises blocktrans.

Si la résolution d’un des paramètres du bloc échoue, blocktrans se rabat sur la langue par défaut en désactivant temporairement la langue actuelle avec la fonction deactivate_all().

Cette balise permet également l’utilisation de pluriels. Pour l’utiliser :

  • Désignez et liez une valeur de compteur nommée count. Cette valeur sera celle utilisée pour choisir la bonne forme de pluriel.

  • Indiquez à la fois les formes au singulier et au pluriel en les séparant par la balise {% plural %} à l’intérieur des balises {% blocktrans %} et {% endblocktrans %}.

Un exemple :

{% blocktrans count counter=list|length %}
There is only one {{ name }} object.
{% plural %}
There are {{ counter }} {{ name }} objects.
{% endblocktrans %}

Un exemple plus complexe :

{% blocktrans with amount=article.price count years=i.length %}
That will cost $ {{ amount }} per year.
{% plural %}
That will cost $ {{ amount }} per {{ years }} years.
{% endblocktrans %}

Lorsque vous utilisez à la fois la fonction de pluriel et l’attribution de valeurs à des variables locales en plus de la valeur de compteur, il faut savoir qu’en interne, blocktrans est converti en un appel ungettext. Cela signifie que les notes concernant les variables ungettext s’appliquent également.

La résolution inverse d’URL ne peut pas se faire à l’intérieur de blocktrans et doit donc être effectuée au préalable :

{% url 'path.to.view' arg arg2 as the_url %}
{% blocktrans %}
This is a URL: {{ the_url }}
{% endblocktrans %}

Si vous aimeriez récupérer une chaîne traduite sans l’afficher, vous pouvez utiliser la syntaxe suivante :

{% blocktrans asvar the_title %}The title is {{ title }}.{% endblocktrans %}
<title>{{ the_title }}</title>
<meta name="description" content="{{ the_title }}">

En pratique, vous utiliserez cela pour obtenir une chaîne utilisée à plusieurs endroits dans un gabarit ou qui doit être passée comme paramètre à d’autres balises ou filtres de gabarit.

Changed in Django 1.9:

La syntaxe asvar a été ajoutée.

{% blocktrans %} prend aussi en charge les marqueurs contextuels à l’aide du mot-clé context:

{% blocktrans with name=user.username context "greeting" %}Hi {{ name }}{% endblocktrans %}

Une autre fonctionnalité prise en charge par la balise {% blocktrans %} est l’option trimmed. Cette option supprime les caractères de nouvelle ligne au début et à la fin du contenu de la balise {%blocktrans%}, remplace les espaces blancs au début et à la fin d’une ligne et fusionne toutes les lignes en une seule via l’utilisation d’un espace pour les séparer. Ceci est très utile pour l’indentation du contenu d’une balise {% blocktrans%} sans avoir les caractères d’indentation qui se retrouvent dans l’entrée correspondante du fichier PO, rendant le processus de traduction plus facile.

Par exemple, la balise {% blocktrans %} suivante :

{% blocktrans trimmed %}
  First sentence.
  Second paragraph.
{% endblocktrans %}

donne comme résultat "First sentence. Second paragraph." dans le fichier PO, comparé à "\n First sentence.\n Second sentence.\n" si l’option trimmed n’avait pas été utilisée.

Texte littéral transmis aux balises et aux filtres

Vous pouvez traduire le texte littéral transmis comme paramètre à des balises et des filtres en utilisant la syntaxe familière _():

{% some_tag _("Page not found") value|yesno:_("yes,no") %}

Dans ce cas, aussi bien la balise que le filtre recevra la chaîne traduite, ils n’ont donc pas besoin de se préoccuper des traductions.

Note

Dans cet exemple, l’infrastructure de traduction recevra la chaîne "yes,no", et non pas les chaînes individuelles "yes" et "no". La chaîne à traduire devra contenir la virgule afin que le code d’analyse du filtre sache où séparer les paramètres. Par exemple, un traducteur allemand pourrait traduire la chaîne "yes,no" comme "ja,nein" (en préservant la virgule).

Commentaires pour les traducteurs dans les gabarits

Tout comme avec le code Python, ces notes à l’intention des traducteurs peuvent être indiquées en utilisant des commentaires, soit avec la balise comment:

{% comment %}Translators: View verb{% endcomment %}
{% trans "View" %}

{% comment %}Translators: Short intro blurb{% endcomment %}
<p>{% blocktrans %}A multiline translatable
literal.{% endblocktrans %}</p>

ou avec la syntaxe de commentaire sur une seule ligne {# ... #}:

{# Translators: Label of a button that triggers search #}
<button type="submit">{% trans "Go" %}</button>

{# Translators: This is a text of the base template #}
{% blocktrans %}Ambiguous translatable block of text{% endblocktrans %}

Note

Pour les curieux, voici les fragments correspondant dans le fichier .po résultant :

#. Translators: View verb
# path/to/template/file.html:10
msgid "View"
msgstr ""

#. Translators: Short intro blurb
# path/to/template/file.html:13
msgid ""
"A multiline translatable"
"literal."
msgstr ""

# ...

#. Translators: Label of a button that triggers search
# path/to/template/file.html:100
msgid "Go"
msgstr ""

#. Translators: This is a text of the base template
# path/to/template/file.html:103
msgid "Ambiguous translatable block of text"
msgstr ""

Changement de langue dans les gabarits

Si vous avez besoin de changer de langue à l’intérieur d’un gabarit, vous pouvez utiliser la balise de gabarit language:

{% load i18n %}

{% get_current_language as LANGUAGE_CODE %}
<!-- Current language: {{ LANGUAGE_CODE }} -->
<p>{% trans "Welcome to our page" %}</p>

{% language 'en' %}
    {% get_current_language as LANGUAGE_CODE %}
    <!-- Current language: {{ LANGUAGE_CODE }} -->
    <p>{% trans "Welcome to our page" %}</p>
{% endlanguage %}

Alors que la première occurrence de “Welcome to our page” utilise la langue active, la seconde sera toujours en anglais.

Autres balises

Ces balises nécessitent aussi le chargement {% load i18n %}.

get_available_languages

{% get_available_languages as LANGUAGES %} renvoie une liste de tuples dont le premier élément est le code de langue et le second est le nom de la langue (traduit dans la langue actuellement active).

get_current_language

{% get_current_language as LANGUAGE_CODE %} renvoie la langue préférée de l’utilisateur actuel sous forme textuelle. Exemple : en-us. Voir Processus de découverte de la préférence de langue par Django.

get_current_language_bidi

{% get_current_language_bidi as LANGUAGE_BIDI %} renvoie la direction du texte de la langue actuelle. Si True, il s’agit d’une langue s’écrivant de droite à gauche, comme l’hébreu ou l’arabe. Si False, il s’agit d’une langue s’écrivant de gauche à droite, comme l’anglais, le français, l’allemand, etc.

Si vous activez le processeur de contexte django.template.context_processors.i18n, chaque RequestContext aura accès à LANGUAGES, LANGUAGE_CODE et LANGUAGE_BIDI tels que décrits ci-dessus.

Changed in Django 1.8:

Le processeur de contexte i18n n’est pas activé par défaut dans les nouveaux projets.

get_language_info

Vous pouvez aussi récupérer toute information à propos des langues disponibles en utilisant des balises et des filtres intégrés. Pour obtenir des informations sur une seule langue, utilisez la balise {% get_language_info %}:

{% get_language_info for LANGUAGE_CODE as lang %}
{% get_language_info for "pl" as lang %}

Vous pouvez ensuite accéder à ces informations :

Language code: {{ lang.code }}<br />
Name of language: {{ lang.name_local }}<br />
Name in English: {{ lang.name }}<br />
Bi-directional: {{ lang.bidi }}
Name in the active language: {{ lang.name_translated }}
New in Django 1.9:

L’attribut name_translated a été ajouté.

get_language_info_list

Vous pouvez aussi utiliser la balise de gabarit {% get_language_info_list %} pour obtenir les informations d’une liste de langues (par ex. les langues actives figurant dans LANGUAGES). Consultez la section sur la vue de redirection set_language pour trouver un exemple sur la manière d’afficher un sélecteur de langue avec {% get_language_info_list %}.

En plus du style liste de tuples de LANGUAGES, {% get_language_info_list %} accepte de simples listes de codes de langue. Si vous faites ceci dans votre vue :

context = {'available_languages': ['en', 'es', 'fr']}
return render(request, 'mytemplate.html', context)

vous pouvez faire une boucle sur ces langues dans le gabarit :

{% get_language_info_list for available_languages as langs %}
{% for lang in langs %} ... {% endfor %}

Filtres de gabarit

Il existe aussi des filtres simples pour votre confort :

  • {{ LANGUAGE_CODE|language_name }} (“German”)
  • {{ LANGUAGE_CODE|language_name_local }} (“Deutsch”)
  • {{ LANGUAGE_CODE|language_bidi }} (False)
  • {{ LANGUAGE_CODE|language_name_translated }} (“německy”, lorsque la langue actuelle est le tchèque)

New in Django 1.9:

Le filtre language_name_translated a été ajouté.

Internationalisation : dans le code JavaScript

L’ajout de traductions en Javascript pose quelques problèmes :

  • Le code JavaScript n’a pas d’accès à une implémentation de gettext.

  • Le code JavaScript n’a pas accès à des fichiers .po ou .mo; ils doivent être fournis par le serveur.

  • Les catalogues de traduction pour JavaScript doivent être aussi compacts que possible.

Django fournit une solution intégrée pour ces problèmes : il transpose les traductions dans JavaScript afin que vous puissiez appeler les fonctions de type gettext dans votre code JavaScript.

La vue javascript_catalog

javascript_catalog(request, domain='djangojs', packages=None)[source]

La solution principale à ces problèmes est la vue django.views.i18n.javascript_catalog() qui renvoie une bibliothèque de code JavaScript avec des fonctions qui simulent l’interface gettext, ainsi qu’un tableau de chaînes de traduction. Celles-ci proviennent des applications ou du cœur Django, en fonction de ce que vous indiquez dans la structure info_dict ou dans l’URL. Les chemins énumérés dans LOCALE_PATHS sont aussi inclus.

Voici comment l’intégrer :

from django.views.i18n import javascript_catalog

js_info_dict = {
    'packages': ('your.app.package',),
}

urlpatterns = [
    url(r'^jsi18n/$', javascript_catalog, js_info_dict, name='javascript-catalog'),
]

Chaque chaîne dans packages doit respecter la syntaxe pointée des paquets Python (même format que les chaînes dans INSTALLED_APPS) et doit faire référence à un module contenant un répertoire locale. Si vous indiquez plusieurs modules, tous les catalogues sont fusionnés en un seul. C’est utile si vous avez du code JavaScript qui utilise des chaînes provenant de plusieurs applications.

La priorité des traductions se fait par ordre d’apparition des modules dans le paramètre packages; ceux qui apparaissent en dernier ont la priorité sur les premiers, ce qui est important dans le cas où une même chaîne est traduite différemment dans plusieurs catalogues.

Par défaut, la vue utilise le domaine gettext djangojs. Cela peut être changé en modifiant le paramètre domain.

Vous pouvez rendre la vue dynamique en fournissant le paramètre packages dans le motif d’URL :

urlpatterns = [
    url(r'^jsi18n/(?P<packages>\S+?)/$', javascript_catalog, name='javascript-catalog'),
]

Avec ceci, vous indiquez les paquets sous forme d’une liste de noms de paquets délimités par le caractère « + » dans l’URL. C’est particulièrement utile quand vos pages utilisent du code de différentes applications, qu’elles changent souvent et que vous ne voulez pas simplement produire un gros fichier de traductions. Par mesure de sécurité, ces valeurs sont limitées à django.conf ou tout autre paquet figurant dans le réglage INSTALLED_APPS.

Vous pouvez aussi partager les catalogues en plusieurs URL et les charger au besoin dans vos sites :

js_info_dict_app = {
    'packages': ('your.app.package',),
}

js_info_dict_other_app = {
    'packages': ('your.other.app.package',),
}

urlpatterns = [
    url(r'^jsi18n/app/$', javascript_catalog, js_info_dict_app),
    url(r'^jsi18n/other_app/$', javascript_catalog, js_info_dict_other_app),
]

Si vous utilisez plus d’un javascript_catalog sur un site et que plusieurs définissent les mêmes chaînes, les chaînes du catalogue chargé en dernier ont la priorité.

Changed in Django 1.9:

Avant Django 1.9, les catalogues s’écrasaient complètement les uns les autres et on ne pouvait en utiliser qu’un seul à la fois.

Les traductions JavaScript extraites des chemins figurant dans le réglage LOCALE_PATHS sont aussi toujours incluses. Pour rester cohérent avec l’algorithme d’ordre de recherche des traductions dans le code Python et les gabarits, les répertoires mentionnés dans LOCALE_PATHS ont la priorité, les premiers dans la liste ayant priorité sur les suivants.

Emploi du catalogue des traductions JavaScript

Pour utiliser le catalogue, insérez le script généré dynamiquement comme ceci :

<script type="text/javascript" src="{% url 'javascript-catalog' %}"></script>

Nous utilisons la résolution inverse d’URL pour trouver l’URL de la vue du catalogue JavaScript. Lorsque le catalogue est chargé, votre code JavaScript peut utiliser les méthodes suivantes :

  • gettext
  • ngettext
  • interpolate
  • get_format
  • gettext_noop
  • pgettext
  • npgettext
  • pluralidx

gettext

La fonction gettext fonctionne de manière similaire à l’interface gettext standard accessible depuis le code Python :

document.write(gettext('this is to be translated'));

ngettext

La fonction ngettext fournit une interface pour mettre au pluriel des mots et des phrases :

var object_count = 1 // or 0, or 2, or 3, ...
s = ngettext('literal for the singular case',
        'literal for the plural case', object_count);

interpolate

La fonction interpolate permet de remplir dynamiquement une chaîne de mise en forme. La syntaxe d’interpolation est empruntée à Python ; ainsi, la fonction interpolate prend en charge à la fois les paramètres nommés et les paramètres positionnels :

  • Interpolation positionnelle : obj contient un objet Array JavaScript dont les valeurs d’éléments sont interpolées dans l’ordre d’apparition de leur substituant fmt correspondant. Par exemple :

    fmts = ngettext('There is %s object. Remaining: %s',
            'There are %s objects. Remaining: %s', 11);
    s = interpolate(fmts, [11, 20]);
    // s is 'There are 11 objects. Remaining: 20'
    
  • Interpolation nommée : ce mode est sélectionné en passant true dans le paramètre booléen facultatif named. obj contient un objet JavaScript ou un tableau associatif. Par exemple :

    d = {
        count: 10,
        total: 50
    };
    
    fmts = ngettext('Total: %(total)s, there is %(count)s object',
    'there are %(count)s of a total of %(total)s objects', d.count);
    s = interpolate(fmts, d, true);
    

Il ne faut cependant pas abuser de l’interpolation de chaînes : c’est toujours du JavaScript, le code effectue donc des substitutions répétées par expression régulière. Ce n’est pas aussi rapide que l’interpolation de chaînes en Python, il s’agit donc de réserver cet usage pour les cas où c’est vraiment nécessaire (par exemple conjointement avec``ngettext`` pour générer des pluriels corrects).

get_format

La fonction get_format accède aux réglages de mise en forme régionalisée et peut obtenir la chaîne de format d’un nom de réglage donné :

document.write(get_format('DATE_FORMAT'));
// 'N j, Y'

Elle peut accéder aux réglages suivants :

C’est bien utile pour conserver une cohérence de mise en forme en lien avec les valeurs produites par le code Python.

gettext_noop

Ceci émule la fonction gettext, mais ne fait rien d’autre que de renvoyer le contenu qui lui est transmis :

document.write(gettext_noop('this will not be translated'));

C’est utile pour identifier des portions de code qui vont avoir besoin d’être traduites plus tard.

pgettext

La fonction pgettext fonctionne de manière similaire à son équivalent Python (pgettext()), fournissant un contenu traduit en fonction d’un contexte :

document.write(pgettext('month name', 'May'));

npgettext

La fonction npgettext fonctionne également comme son équivalent Python (npgettext()), fournissant un contenu pluriel traduit en fonction d’un contexte

document.write(npgettext('group', 'party', 1));
// party
document.write(npgettext('group', 'party', 2));
// parties

pluralidx

La fonction pluralidx fonctionne de manière semblable au filtre de gabarit pluralize, déterminant si un nombre count donné doit utiliser une forme plurielle d’un mot ou pas :

document.write(pluralidx(0));
// true
document.write(pluralidx(1));
// false
document.write(pluralidx(2));
// true

Dans le cas le plus simple, si aucune mise au pluriel n’est nécessaire, cette fonction renvoie false pour le nombre 1 et true pour tous les autres nombres.

Cependant, la mise au pluriel n’est pas si simple dans toutes les langues. Si la langue ne gère pas les pluriels, une valeur vide est renvoyée.

De plus, si les pluriels se basent sur des règles complexes, la vue du catalogue produit une expression conditionnelle. Son résultat aboutit soit à une valeur true (pluriel nécessaire), soit à une valeur false (pluriel non nécessaire).

La vue json_catalog

New in Django 1.9.
json_catalog(request, domain='djangojs', packages=None)[source]

Pour pouvoir utiliser une autre bibliothèque côté client pour la gestion des traductions, il peut être avantageux de profiter de la vue json_catalog(). Le résultat est proche de javascript_catalog() mais le contenu est renvoyé sous forme de réponse JSON.

L’objet JSON contient des réglages de mise en forme internationalisée (ceux disponibles pour get_format), une règle de pluriel (comme la partie plural d’une expression Plural-Forms de GNU gettext) ainsi que des chaînes traduites. Celles-ci sont tirées des traductions de Django ou des applications, en fonction de ce qui est indiqué dans les paramètres urlpatterns ou dans les paramètres de requête. Les chemins figurant dans LOCALE_PATHS sont également inclus.

La vue est branchée sur votre application et configurée de la même façon que javascript_catalog() (c’est-à-dire que les paramètres domain et packages se comportent pareillement) :

from django.views.i18n import json_catalog

js_info_dict = {
    'packages': ('your.app.package',),
}

urlpatterns = [
    url(r'^jsoni18n/$', json_catalog, js_info_dict),
]

Le format de la réponse est le suivant :

{
    "catalog": {
        # Translations catalog
    },
    "formats": {
        # Language formats for date, time, etc.
    },
    "plural": "..."  # Expression for plural forms, or null.
}

Note sur les performances

La vue javascript_catalog() génère le catalogue depuis les fichiers .mo à chaque requête. Comme le résultat est constant, au moins pour une version donnée du site, c’est une bonne occasion d’utiliser le cache.

Le cache côté serveur réduit la charge sur le processeur. Le décorateur cache_page() permet de le faire facilement. Pour provoquer l’invalidation du cache lorsque les traductions ont changé, ajoutez un préfixe de clé dépendant de la version, comme le montre l’exemple ci-dessous, ou faites correspondre la vue à une URL dépendant de la version :

from django.views.decorators.cache import cache_page
from django.views.i18n import javascript_catalog

# The value returned by get_version() must change when translations change.
@cache_page(86400, key_prefix='js18n-%s' % get_version())
def cached_javascript_catalog(request, domain='djangojs', packages=None):
    return javascript_catalog(request, domain, packages)

Le cache côté client économise de la bande passante et accélère le chargement de votre site. Si vous utilisez les ETags (USE_ETAGS = True), il n’y a rien à faire de plus. Sinon, vous pouvez appliquer des décorateurs conditionnels. Dans l’exemple qui suit, le cache est invalidé chaque fois que vous relancez le serveur d’applications :

from django.utils import timezone
from django.views.decorators.http import last_modified
from django.views.i18n import javascript_catalog

last_modified_date = timezone.now()

@last_modified(lambda req, **kw: last_modified_date)
def cached_javascript_catalog(request, domain='djangojs', packages=None):
    return javascript_catalog(request, domain, packages)

Il est même possible de pré-générer le catalogue JavaScript dans le cadre de votre procédure de déploiement et le servir comme fichier statique. Cette technique radicale est implémentée dans django-statici18n.

Internationalisation : dans les motifs d’URL

Django fournit deux mécanismes pour internationaliser les motifs d’URL :

Avertissement

L’utilisation de chacune de ces techniques exige qu’une langue active soit définie pour chaque requête ; en d’autres termes, votre réglage MIDDLEWARE_CLASSES doit contenir django.middleware.locale.LocaleMiddleware.

Préfixe de langue dans les motifs d’URL

i18n_patterns(prefix, pattern_description, ...)[source]

Obsolète depuis la version 1.8: Le paramètre prefix de i18n_patterns() a été rendu obsolète et ne sera plus pris en charge dans Django 1.10. À la place, passez simplement une liste d’instance django.conf.urls.url().

This function can be used in your root URLconf and Django will automatically prepend the current active language code to all URL patterns defined within i18n_patterns(). Example URL patterns:

from django.conf.urls import include, url
from django.conf.urls.i18n import i18n_patterns

from about import views as about_views
from news import views as news_views
from sitemap.views import sitemap

urlpatterns = [
    url(r'^sitemap\.xml$', sitemap, name='sitemap-xml'),
]

news_patterns = ([
    url(r'^$', news_views.index, name='index'),
    url(r'^category/(?P<slug>[\w-]+)/$', news_views.category, name='category'),
    url(r'^(?P<slug>[\w-]+)/$', news_views.details, name='detail'),
], 'news')

urlpatterns += i18n_patterns(
    url(r'^about/$', about_views.main, name='about'),
    url(r'^news/', include(news_patterns, namespace='news')),
)

Après la définition de ces motifs d’URL, Django ajoute automatiquement le préfixe de langue dans les motifs d’URL qui ont été ajoutés avec la fonction i18n_patterns. Exemple :

>>> from django.core.urlresolvers import reverse
>>> from django.utils.translation import activate

>>> activate('en')
>>> reverse('sitemap-xml')
'/sitemap.xml'
>>> reverse('news:index')
'/en/news/'

>>> activate('nl')
>>> reverse('news:detail', kwargs={'slug': 'news-slug'})
'/nl/news/news-slug/'

Avertissement

i18n_patterns() ne peut figurer que dans la configuration d’URL racine. Si vous essayez de l’utiliser dans une configuration d’URL incluse, vous obtiendrez une exception ImproperlyConfigured.

Avertissement

Assurez-vous de ne pas avoir de motifs d’URL non préfixés qui pourraient être confondus avec des motifs contenant le préfixe de langue automatique.

Traduction de motifs d’URL

Les motifs d’URL peuvent aussi être signalés comme traduisibles en utilisant la fonction ugettext_lazy(). Exemple :

from django.conf.urls import include, url
from django.conf.urls.i18n import i18n_patterns
from django.utils.translation import ugettext_lazy as _

from about import views as about_views
from news import views as news_views
from sitemaps.views import sitemap

urlpatterns = [
    url(r'^sitemap\.xml$', sitemap, name='sitemap-xml'),
]

news_patterns = ([
    url(r'^$', news_views.index, name='index'),
    url(_(r'^category/(?P<slug>[\w-]+)/$'), news_views.category, name='category'),
    url(r'^(?P<slug>[\w-]+)/$', news_views.details, name='detail'),
], 'news')

urlpatterns += i18n_patterns(
    url(_(r'^about/$'), about_views.main, name='about'),
    url(_(r'^news/'), include(news_patterns, namespace='news')),
)

Après avoir effectué les traductions, la fonction reverse() renverra l’URL dans la langue active. Exemple :

>>> from django.core.urlresolvers import reverse
>>> from django.utils.translation import activate

>>> activate('en')
>>> reverse('news:category', kwargs={'slug': 'recent'})
'/en/news/category/recent/'

>>> activate('nl')
>>> reverse('news:category', kwargs={'slug': 'recent'})
'/nl/nieuws/categorie/recent/'

Avertissement

Dans la plupart des cas, il est recommandé de n’utiliser des URL traduites que dans des blocs de motifs avec préfixe de code de langue (utilisant i18n_patterns()), pour éviter l’éventualité qu’une URL mal traduite entre en conflit avec un motif d’URL non traduit.

Résolution inverse dans les gabarits

Lors de la résolution d’URL régionalisées dans les gabarits, c’est toujours la langue active qui sera utilisée. Pour créer un lien vers une URL dans une autre langue, utilisez la balise de gabarit language. Elle active la langue indiquée à l’intérieur de la section de gabarit concernée :

{% load i18n %}

{% get_available_languages as languages %}

{% trans "View this category in:" %}
{% for lang_code, lang_name in languages %}
    {% language lang_code %}
    <a href="{% url 'category' slug=category.slug %}">{{ lang_name }}</a>
    {% endlanguage %}
{% endfor %}

La balise language n’accepte que le code de langue comme paramètre.

Régionalisation : comment créer les fichiers de langues

Après avoir marqué les chaînes à traduire dans le code d’une application, il s’agit d’effectuer les traductions elles-mêmes. Voici comment ça fonctionne.

Fichiers de messages

La première étape est de créer un fichier de messages pour la nouvelle langue. Il s’agit d’un simple fichier texte correspondant à une seule langue et contenant toutes les chaînes à traduire disponibles ainsi que leur traduction dans la langue cible. Les fichiers de messages possèdent l’extension de fichier .po.

Django est livré avec un outil, django-admin makemessages, qui automatise la création et la maintenance de ces fichiers.

Utilitaires gettext

La commande makemessages (ainsi que compilemessages présentée plus bas) utilise des commandes de la suite d’outils GNU gettext : xgettext, msgfmt, msgmerge et msguniq.

La version minimale prise en charge des utilitaires gettext est la version 0.15.

Pour créer ou mettre à jour un fichier de messages, exécutez cette commande :

django-admin makemessages -l de

…où de est le nom de locale du fichier de messages que vous souhaitez créer. Par exemple, le portugais du Brésil est représenté par pt_BR, l’allemand d’Autriche par de_AT ou encore id pour l’indonésien.

Le script doit être lancé depuis l’un des deux endroits suivants :

  • Le répertoire racine de votre projet Django (celui qui contient manage.py).

  • Le répertoire racine de l’une de vos applications Django.

Le script parcourt l’arborescence des sources de votre projet ou de votre application et extrait toutes les chaînes marquées pour la traduction (consultez Processus de découverte des traductions par Django et assurez-vous que LOCALE_PATHS est correctement configuré). Il crée (ou met à jour) un fichier de messages dans le répertoire locale/LANG/LC_MESSAGES. Dans l’exemple avec de, le fichier équivaudra à locale/de/LC_MESSAGES/django.po.

Lorsque vous exécutez makemessages à partir du dossier racine de votre projet, les chaînes extraites sont automatiquement distribuées dans les fichiers de messages appropriés. C’est-à-dire qu’une chaîne extraite d’un fichier d’une application contenant un répertoire locale sera placée dans un fichier de messages sous ce répertoire. Une chaîne extraite d’un fichier d’une application sans répertoire locale sera placée dans un fichier de messages sous le répertoire apparaissant en premier dans LOCALE_PATHS ou générera une erreur si le réglage LOCALE_PATHS est vide.

Par défaut, django-admin makemessages examine chaque fichier ayant une extension .html ou .txt. Dans le cas où vous souhaitez modifier cela, utilisez l’option --extension ou -e pour indiquer les extensions de fichiers à examiner :

django-admin makemessages -l de -e txt

Séparez plusieurs extensions par une virgule ou utilisez plusieurs occurrences de -e ou --extension:

django-admin makemessages -l de -e html,txt -e xml

Avertissement

Lors de la création de fichiers de messages à partir de code JavaScript, vous devez utiliser le domaine particulier djangojs, et non pas -e js.

Utilisation de gabarits Jinja2

makemessages ne comprend pas la syntaxe des gabarits Jinja2. Pour extraire les chaînes d’un projet contenant des gabarits Jinja2, utilisez plutôt l’extraction de messages de Babel.

Voici un exemple de fichier de configuration babel.cfg:

# Extraction from Python source files
[python: **.py]

# Extraction from Jinja2 templates
[jinja2: **.jinja]
extensions = jinja2.ext.with_

Prenez soin de bien mentionner toutes les extensions que vous utilisez ! Sinon, Babel ne reconnaîtra pas les balises définies par ces extensions et ignorera complètement les gabarits Jinja2 contenant de telles balises.

Babel fournit des fonctionnalités similaires à makemessages et peut généralement le remplacer. Il ne dépend pas de gettext. Pour plus d’informations, lisez sa documentation au sujet de sa gestion des catalogues de messages.

Pas de gettext ?

Si les utilitaires gettext ne sont pas installés, makemessages crée des fichiers vides. Dans ce cas, installez les utilitaires gettext ou copiez simplement le fichier de messages anglais (locale/en/LC_MESSAGES/django.po) s’il y en a un et utilisez-le comme point de départ ; ce n’est qu’un fichier de traductions vides.

Vous utilisez Windows ?

Si vous utilisez Windows et que vous avez besoin d’installer les utilitaires GNU gettext pour le fonctionnement de makemessages, consultez gettext et Windows pour plus d’informations.

Le format des fichiers .po est assez simple. Chaque fichier .po contient quelques métadonnées telles que les informations de contact du mainteneur de la traduction, mais la partie principale du fichier est composée d’une liste de messages, de simples correspondances entre les chaînes à traduire et les textes de la traduction dans la langue cible.

Par exemple, si votre application Django contient une chaîne à traduire pour le texte "Welcome to my site.", comme ceci :

_("Welcome to my site.")

…alors django-admin makemessages créera un fichier .po contenant l’extrait (message) suivant :

#: path/to/python/module.py:23
msgid "Welcome to my site."
msgstr ""

Une rapide explication :

  • msgid est la chaîne à traduire apparaissant dans la source. N’y touchez pas.

  • msgstr est l’emplacement devant recevoir la traduction dans la langue cible. Il est vide au début, il est donc de votre responsabilité d’y ajouter le contenu traduit. Prenez soin de ne pas enlever les guillemets autour de la traduction.

  • Chaque message contient des indications utiles sous la forme d’une ligne de commentaire préfixée par # et située au-dessus de la ligne msgid; ce commentaire contient le nom de fichier et le numéro de ligne correspondant au fichier duquel cette chaîne à traduire a été extraite.

Les longs messages sont des cas spéciaux. La première expression juste après msgstr (ou msgid) est une chaîne vide. Le contenu lui-même est écrit dans les lignes suivantes sur plusieurs lignes qui seront concaténées au moment de la récupération de la traduction. N’oubliez donc pas les espaces en fin de ligne à l’intérieur du texte, sinon les lignes seront mises bout à bout sans espace !

Attention au codage des caractères

En raison du fonctionnement interne des outils gettext et de la volonté du cœur de Django d’accepter dans les chaînes source des caractères hors de l’ensemble ASCII, vous devez utiliser UTF-8 comme codage pour vos fichiers PO (valeur par défaut lorsque les fichiers PO sont créés). Cela signifie que tout le monde utilise le même codage de caractères, ce qui est important pour Django lorsqu’il traite les fichiers PO.

Pour réexaminer tout le code source et les gabarits à la recherche de nouvelles chaînes à traduire et pour mettre à jour tous les fichiers de messages pour toutes les langues, exécutez ceci :

django-admin makemessages -a

Compilation des fichiers de messages

Après avoir créé un fichier de messages et lors de chaque modification à ce fichier, il est nécessaire de le compiler dans un format plus efficace utilisable par gettext. Ceci se fait à l’aide de la commande django-admin compilemessages.

Cet outil parcourt tous les fichiers .po disponibles et crée des fichiers .mo qui sont des fichiers binaires optimisés pour gettext. Dans le même répertoire à partir duquel vous avez lancé django-admin makemessages, exécutez django-admin compilemessages comme ceci :

django-admin compilemessages

C’est tout. Vos traductions sont prêtes à l’emploi.

Changed in Django 1.9:

compilemessages se comporte maintenant comme makemessages en parcourant l’arborescence du projet à la recherche de fichiers .po à compiler.

Vous utilisez Windows ?

Si vous utilisez Windows et que vous avez besoin d’installer les utilitaires GNU gettext pour le fonctionnement de django-admin compilemessages, consultez gettext et Windows pour plus d’informations.

Fichiers .po : codage et présence du BOM

Django ne gère que les fichiers .po codés en UTF-8 et sans BOM (Byte Order Mark) ; si votre éditeur de texte ajoute par défaut de telles marques au début des fichiers, il vous faudra le reconfigurer.

Création de fichiers de messages à partir de code JavaScript

La création et la mise à jour des fichiers de messages se fait de la même manière que les autres fichiers de messages de Django, à l’aide de l’outil django-admin makemessages. La seule différence est que vous devez explicitement définir ce que le jargon gettext appelle un domaine, dans ce cas le domaine djangojs, en indiquant le paramètre -d djangojs comme ceci :

django-admin makemessages -d djangojs -l de

Ceci va créer ou mettre à jour le fichier de messages JavaScript en allemand. Après la mise à jour des fichiers de messages, il suffit de lancer django-admin compilemessages sur le même principe que pour les autres fichiers de messages de Django.

gettext et Windows

Ceci n’est nécessaire que pour les personnes qui doivent extraire des messages à traduire ou compiler des fichiers de messages (.po). Le travail de traduction en soi ne requiert que de modifier des fichiers de ce type, mais si vous souhaitez créer vos propres fichiers de messages ou que vous vouliez tester ou compiler un fichier de messages modifié, téléchargez un installeur binaire précompilé.

Il est aussi possible d’utiliser des binaires gettext obtenus par une autre source, tant que la commande xgettext --version fonctionne correctement. N’essayez pas d’utiliser les utilitaires de traduction de Django avec un paquet gettext si la commande xgettext --version saisie dans une invite de commande Windows produit une fenêtre contenant un message du genre « xgettext.exe a produit des erreurs et sera fermé par Windows ».

Personnalisation de la commande makemessages

Si vous souhaitez passer des paramètres supplémentaires à xgettext, vous devez créer une commande makemessages personnaliséeet surcharger son attribut xgettext_options:

from django.core.management.commands import makemessages

class Command(makemessages.Command):
    xgettext_options = makemessages.Command.xgettext_options + ['--keyword=mytrans']

Si vous avez besoin de plus de souplesse, vous pouvez aussi ajouter un nouveau paramètre à votre commande makemessages personnalisée :

from django.core.management.commands import makemessages

class Command(makemessages.Command):

    def add_arguments(self, parser):
        super(Command, self).add_arguments(parser)
        parser.add_argument(
            '--extra-keyword',
            dest='xgettext_keywords',
            action='append',
        )

    def handle(self, *args, **options):
        xgettext_keywords = options.pop('xgettext_keywords')
        if xgettext_keywords:
            self.xgettext_options = (
                makemessages.Command.xgettext_options[:] +
                ['--keyword=%s' % kwd for kwd in xgettext_keywords]
            )
        super(Command, self).handle(*args, **options)

Divers

La vue de redirection set_language

set_language(request)[source]

Par commodité, Django fournit une vue, django.views.i18n.set_language(), qui définit la préférence de langue d’un utilisateur et redirige vers une URL donnée ou, par défaut, revient à la page précédente.

Activez la vue en ajoutant la ligne suivante dans votre configuration d’URL :

url(r'^i18n/', include('django.conf.urls.i18n')),

(Notez que cet exemple rend la vue disponible par /i18n/setlang/.)

Avertissement

Vérifiez que l’URL ci-dessus ne soit pas ajoutée au moyen de i18n_patterns(), car elle doit être elle-même indépendante de la langue pour fonctionner correctement.

La vue s’attend à être appelée par la méthode POST, avec un paramètre language défini dans la requête. Si la prise en charge des sessions est active, la vue enregistre le choix de langue dans la session de l’utilisateur. Sinon, elle enregistre le choix de langue dans un cookie nommé par défaut django_language (le nom peut être modifié par le réglage LANGUAGE_COOKIE_NAME).

Après avoir défini le choix de la langue, Django redirige l’utilisateur en suivant cet algorithme :

  • Django cherche un paramètre next dans les données POST.

  • S’il n’existe pas ou qu’il est vide, Django cherche l’URL dans l’en-tête Referer.

  • Si c’est toujours vide, par exemple dans le cas où le navigateur de l’utilisateur supprime cet en-tête, l’utilisateur sera redirigé vers / (la racine du site) en dernier recours.

Voici un exemple de code de gabarit HTML :

{% load i18n %}

<form action="{% url 'set_language' %}" method="post">{% csrf_token %}
    <input name="next" type="hidden" value="{{ redirect_to }}" />
    <select name="language">
        {% get_current_language as LANGUAGE_CODE %}
        {% get_available_languages as LANGUAGES %}
        {% get_language_info_list for LANGUAGES as languages %}
        {% for language in languages %}
            <option value="{{ language.code }}"{% if language.code == LANGUAGE_CODE %} selected="selected"{% endif %}>
                {{ language.name_local }} ({{ language.code }})
            </option>
        {% endfor %}
    </select>
    <input type="submit" value="Go" />
</form>

Dans cet exemple, Django cherche l’URL de la page vers laquelle l’utilisateur sera redirigé dans la variable de contexte redirect_to.

Définition explicite de la langue active

Il peut être souhaitable de définir la langue active de la session en cours de manière explicite. On peut par exemple imaginer que la préférence de langue d’une utilisatrice est récupérée à partir d’un autre système. La fonction django.utils.translation.activate() vous a déjà été présentée. Celle-ci s’applique seulement au fil d’exécution en cours. Si l’on veut modifier plus durablement la langue pour toute la session, il faut aussi modifier LANGUAGE_SESSION_KEY dans la session :

from django.utils import translation
user_language = 'fr'
translation.activate(user_language)
request.session[translation.LANGUAGE_SESSION_KEY] = user_language

Il est généralement utile d’utiliser les deux : django.utils.translation.activate() modifie la langue pour le fil d’exécution en cours et la modification de la session valide cette préférence en vue des requêtes suivantes.

Si vous n’utilisez pas de sessions, la langue est stockée dans un cookie dont le nom est défini par LANGUAGE_COOKIE_NAME. Par exemple :

from django.utils import translation
from django import http
from django.conf import settings
user_language = 'fr'
translation.activate(user_language)
response = http.HttpResponse(...)
response.set_cookie(settings.LANGUAGE_COOKIE_NAME, user_language)

Traductions en dehors des vues et des gabarits

Django contient un ensemble d’outils d’internationalisation bien fourni pour être utilisé dans les vues et les gabarits, mais leur usage n’est pas limité au code spécifique à Django. Les mécanismes de traduction de Django peuvent être utilisés pour traduire n’importe quel texte vers toutes les langues prises en charge par Django (pour autant qu’un catalogue de traductions correspondant existe, bien sûr). Vous pouvez charger un catalogue de traductions, l’activer et traduire du texte dans la langue de votre choix, mais n’oubliez pas de restaurer la langue initiale, car l’activation d’un catalogue de traductions est valable pour tout un fil d’exécution (thread) et une telle modification affecte le code s’exécutant dans le même fil.

Par exemple :

from django.utils import translation

def welcome_translated(language):
    cur_language = translation.get_language()
    try:
        translation.activate(language)
        text = translation.ugettext('welcome')
    finally:
        translation.activate(cur_language)
    return text

L’appel de cette fonction avec la valeur « de » produira "Willkommen", quelle que soit la valeur de LANGUAGE_CODE ou la langue définie par un intergiciel.

Quelques fonctions dignes d’intérêt sont django.utils.translation.get_language() qui renvoie la langue utilisée dans le fil d’exécution actuel, django.utils.translation.activate() qui active un catalogue de traductions pour le fil d’exécution en cours et django.utils.translation.check_for_language() qui vérifie si la langue indiquée est prise en charge par Django.

Pour aider à écrire du code plus concis, il existe également un gestionnaire de contexte django.utils.translation.override() qui stocke la langue en cours en entrée et la restaure en sortie. Avec ceci, l’exemple ci-dessus devient :

from django.utils import translation

def welcome_translated(language):
    with translation.override(language):
        return translation.ugettext('welcome')

Notes d’implémentation

Spécialités des traductions Django

Le mécanisme de traduction de Django utilise le module standard gettext livré avec Python. Si vous connaissez gettext, vous allez peut-être constater ces particularités dans la manière dont Django gère les traductions :

  • Le texte du domaine est django ou djangojs. Ce texte sert à distinguer les divers programmes qui stockent leurs données dans un endroit commun aux fichiers de messages (normalement /usr/share/locale/). Le domaine django est utilisé pour les chaînes de traduction du code Python et des gabarits et est chargé dans les catalogues de traductions globaux. Le domaine djangojs n’est utilisé que pour les catalogues de traductions JavaScript afin qu’ils restent aussi petits que possible.

  • Django n’utilise pas directement xgettext, mais des adaptateurs Python autour de xgettext et msgfmt. Ceci essentiellement pour des raisons pratiques.

Processus de découverte de la préférence de langue par Django

Après avoir préparé les traductions, ou si vous voulez simplement utiliser les traductions qui proviennent de Django, il suffit d’activer les traductions pour votre application.

En arrière-plan, Django utilise un modèle très souple pour décider de la langue à activer, de manière globale, pour un utilisateur particulier ou les deux.

Pour configurer une préférence de langue générale du projet, définissez LANGUAGE_CODE. Django utilise cette langue comme traduction par défaut, c’est-à-dire le choix final si aucune autre traduction correspondante n’est découverte par l’une des méthodes employées par l’intergiciel de langue (voir ci-dessous).

Si vous souhaitez simplement faire fonctionner Django dans votre langue maternelle, la seule chose est faire est de définir LANGUAGE_CODE et de vérifier que les fichiers de messages correspondants ainsi que leur version compilée (.mo) existent.

Si vous voulez que chaque utilisateur puisse indiquer sa langue préférée, il est alors nécessaire d’utiliser LocaleMiddleware. Cet intergiciel active le choix de la langue en fonction des données de la requête. Il personnalise le contenu pour chaque utilisateur.

Pour utiliser LocaleMiddleware, ajoutez 'django.middleware.locale.LocaleMiddleware' à votre réglage MIDDLEWARE_CLASSES. Les intergiciels sont sensibles à leur ordre d’apparition, il est donc recommandé de suivre ces instructions :

  • Assurez-vous qu’il figure parmi les premiers intergiciels installés.

  • Il devrait figurer après SessionMiddleware, parce que LocaleMiddleware emploie des données de session. Et il devrait figurer avant CommonMiddleware, parce que CommonMiddleware a besoin d’une langue active pour la résolution de l’URL demandée.

  • Si vous utilisez CacheMiddleware, placez-le avant LocaleMiddleware.

Par exemple, voici à quoi pourrait ressembler votre réglage MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = [
   'django.contrib.sessions.middleware.SessionMiddleware',
   'django.middleware.locale.LocaleMiddleware',
   'django.middleware.common.CommonMiddleware',
]

(Pour plus d’informations sur les intergiciels, consultez la documentation sur les intergiciels.)

LocaleMiddleware essaie de déterminer la préférence de langue de l’utilisateur en suivant cet algorithme :

  • Premièrement, il cherche un préfixe de langue dans l’URL demandée. Ceci n’est valable que lorsque vous utilisez la fonction i18n_patterns dans votre configuration d’URL racine. Voir Internationalisation : dans les motifs d’URL pour plus d’informations sur les préfixes de langue et sur la manière d’internationaliser les motifs d’URL.

  • S’il ne trouve rien, il cherche la clé LANGUAGE_SESSION_KEY dans la session de l’utilisateur actuel.

  • S’il ne trouve rien, il cherche un cookie.

    Le nom de ce cookie est défini par le réglage LANGUAGE_COOKIE_NAME (la valeur par défaut est django_language).

  • S’il ne trouve rien, il examine l’en-tête HTTP Accept-Language. Cet en-tête est envoyé par le navigateur et indique au serveur les langues préférées de l’utilisateur, triées par ordre de préférence. Django prend en compte chaque langue de cet en-tête jusqu’à ce qu’il en trouve une dont les traductions sont disponibles.

  • S’il ne trouve rien, il utilise le réglage global LANGUAGE_CODE.

Notes :

  • À chacun de ces endroits, la préférence de langue est supposée être dans le format de langue standard, sous forme textuelle. Par exemple, le portugais brésilien est représenté par pt-br.

  • Si une langue de base est disponible mais que la variante indiquée ne l’est pas, Django utilise la langue de base. Par exemple, si un utilisateur indique fr-be (français de Belgique) mais que Django ne connaît que fr, il utilisera fr.

  • Seules les langues présentes dans le réglage LANGUAGES peuvent être choisies. Si vous souhaitez restreindre le choix possible des langues à un sous-ensemble des langues disponibles (parce que votre application ne fournit pas toutes ces langues), définissez LANGUAGES à une liste de langues. Par exemple :

    LANGUAGES = [
      ('de', _('German')),
      ('en', _('English')),
    ]
    

    Cet exemple limite les langues disponibles lors de la sélection automatique à l’allemand et à l’anglais (et à toute variante, du genre de-ch ou en-us).

  • Si vous définissez un réglage LANGUAGES personnalisé comme expliqué au point ci-dessus, il est possible de marquer les noms de langues comme chaînes à traduire, mais utilisez alors ugettext_lazy() au lieu de ugettext() pour éviter une importation circulaire.

    Voici un exemple de fichier de réglages :

    from django.utils.translation import ugettext_lazy as _
    
    LANGUAGES = [
        ('de', _('German')),
        ('en', _('English')),
    ]
    

Lorsque LocaleMiddleware a déterminé la préférence de langue de l’utilisateur, il rend disponible cette préférence dans la variable request.LANGUAGE_CODE de chaque HttpRequest. Cette valeur est à votre disposition dans le code de vos vues. Voici un exemple simple :

from django.http import HttpResponse

def hello_world(request, count):
    if request.LANGUAGE_CODE == 'de-at':
        return HttpResponse("You prefer to read Austrian German.")
    else:
        return HttpResponse("You prefer to read another language.")

Remarquez qu’avec la traduction statique (sans intergiciel), la langue se trouve dans settings.LANGUAGE_CODE alors qu’avec la traduction dynamique (avec intergiciel), elle se trouve dans request.LANGUAGE_CODE.

Processus de découverte des traductions par Django

Au moment de l’exécution, Django construit un catalogue consolidé en mémoire des chaînes de traduction. Pour faire cela, il cherche des traductions selon l’algorithme suivant concernant l’ordre dans lequel il examine les différents chemins de fichiers en vue du chargement des fichiers de messages compilés (.mo) et de la priorité d’éventuelles traductions différentes de la même chaîne :

  1. Les répertoires énumérés dans LOCALE_PATHS ont la plus haute priorité, ceux apparaissant en premier ayant priorité sur les suivants.

  2. Puis, il recherche et utilise le cas échéant un répertoire locale dans chacune des applications installées figurant dans INSTALLED_APPS. Celles apparaissant en premier ayant priorité sur les suivantes.

  3. Et finalement, la traduction de base fournie par Django dans django/conf/locale est utilisée en dernier recours.

Voir aussi

Les traductions de chaînes contenues dans des fichiers JavaScript sont parcourues par un algorithme semblable mais pas identique. Consultez la documentation de la vue javascript_catalog pour plus de détails.

Dans tous les cas, le nom du répertoire contenant une traduction doit respecter le format de nommage avec la notation de nom de locale. Par ex. : de, pt_BR, es_AR, etc.

De cette façon, vous pouvez écrire des applications incluant leurs propres traductions et il est possible de surcharger les traductions de base par celles de votre projet. Ou, vous pouvez construire un gros projet composé de plusieurs applications et placer toutes les traductions dans un seul gros fichier de messages commun spécifique au projet que vous mettez en place. C’est à vous de choisir.

Tous les dépôts de fichiers de messages sont structurés de la même façon. C’est-à-dire :

  • Django parcourt tous les chemins mentionnés dans LOCALE_PATHS de votre fichier de réglages à la recherche de <code_de_langue>/LC_MESSAGES/django.(po|mo)

  • $CHEMIN_APP/locale/<code_de_langue>/LC_MESSAGES/django.(po|mo)

  • $PYTHONPATH/django/conf/locale/<code_de_langue>/LC_MESSAGES/django.(po|mo)

Pour créer des fichiers de messages, il faut utiliser l’outil django-admin makemessages. Et pour produire les fichiers binaires .mo utilisés par gettext, il faut utiliser django-admin compilemessages.

Vous pouvez aussi exécuter django-admin compilemessages --settings=chemin.vers.settings pour que le compilateur s’occupe de tous les répertoires énumérés dans le réglage LOCALE_PATHS.

Back to Top