Djangoで複数言語対応を実現する： utils.translation.activate() の使い方

Django の utils.translation.activate() の解説

用途

activate() は、以下のような状況で役立ちます。

• 複数言語対応の Web サイトやアプリケーションを開発する場合
• 特定の言語でメールやその他のメッセージを送信する場合
• テストコードで特定の言語設定を検証する場合

使用方法

activate() の使い方は以下のとおりです。

from django.utils import translation

# 日本語に切り替え
translation.activate('ja')

# 翻訳されたテキストを取得
translated_text = _("Hello, world!")

# 元の言語設定に戻す
translation.activate('en')

activate() は、引数として 言語コード を受け取ります。言語コードは、2文字の文字列で表されます (例: 'en' は英語、'ja' は日本語)。

注意点

• activate() は、スレッド単位で設定を切り替えます。つまり、異なるスレッドでは異なる言語設定が有効になる可能性があります。
• activate() を呼び出した後は、必ず元の言語設定に戻す必要があります。戻さないと、その後の処理で意図しない言語設定が使用される可能性があります。

activate() 以外にも、Django にはいくつかの翻訳関連の機能があります。詳細は、以下のドキュメントを参照してください。

例

以下は、activate() を使用して特定の言語で翻訳されたテキストを取得する例です。

from django.utils import translation

def get_greeting(language):
  """指定された言語で挨拶を返す関数"""

  translation.activate(language)
  greeting = _("Hello, world!")
  translation.activate('en')

  return greeting

# 日本語で挨拶を取得
greeting = get_greeting('ja')
print(greeting)  # 出力: こんにちは、世界！

# 英語で挨拶を取得
greeting = get_greeting('en')
print(greeting)  # 出力: Hello, world!

この例では、get_greeting() 関数は、引数として渡された言語コードを使用して activate() を呼び出し、その言語で翻訳されたテキストを取得します。

django.utils.translation.activate() は、Django で複数言語対応を実現するための重要な機能です。この関数を理解することで、より柔軟で使いやすい Web サイトやアプリケーションを開発することができます。

Django utils.translation.activate サンプルコード

複数言語対応のテンプレート

{% load i18n %}

<h1>{% trans "Welcome to my website!" %}</h1>

<p>
  {% trans "This website is available in:" %}
  <ul>
    <li><a href="{% url 'home' language_code='en' %}">English</a></li>
    <li><a href="{% url 'home' language_code='ja' %}">日本語</a></li>
  </ul>
</p>

{% for language in LANGUAGES %}
  <p>
    {% trans "Hello in %s!" language=language.code %}
  </p>
{% endfor %}

• {% load i18n %} タグは、テンプレート内で翻訳機能を使用可能にするために必要です。
• {% trans "Welcome to my website!" %} タグは、"Welcome to my website!" という文字列を現在の言語で翻訳します。
• {% trans "This website is available in:" %} タグは、"This website is available in:" という文字列を現在の言語で翻訳し、その後に言語リストを出力します。
• {% for language in LANGUAGES %} ループは、設定されているすべての言語に対して処理を行います。
• {% trans "Hello in %s!" language=language.code %} タグは、"Hello in %s!" という文字列を language.code で指定された言語で翻訳します。

複数言語対応のビュー

from django.utils import translation

def home(request, language_code):
  """言語を切り替えてトップページを表示するビュー"""

  translation.activate(language_code)
  context = {
    'greeting': _("Welcome to my website!"),
  }
  return render(request, 'home.html', context)

説明:

• language_code は、URL から取得した言語コードです。
• translation.activate(language_code) で、現在のスレッドにおける言語設定を language_code に切り替えます。
• context に翻訳結果を格納し、テンプレートにレンダリングします。

テストコードにおける言語設定

from django.test import TestCase
from django.utils import translation

class MyTestCase(TestCase):
  def test_my_view(self):
    """特定の言語設定で my_view をテストする"""

    with translation.activate('ja'):
      # my_view をテストするコード

    with translation.activate('en'):
      # my_view をテストするコード

説明:

• with translation.activate('ja') で、テストコードの実行中に言語設定を日本語に切り替えます。

Djangoで言語を切り替えるその他の方法

ミドルウェア

django.middleware.locale.LocaleMiddleware ミドルウェアを使用すると、リクエストごとに言語設定を切り替えることができます。このミドルウェアは、リクエストヘッダーから Accept-Language 情報を取得し、それに基づいて言語設定を決定します。

設定方法:

MIDDLEWARE = [
  ...
  'django.middleware.locale.LocaleMiddleware',
  ...
]

テンプレートタグ

{% language %} テンプレートタグを使用すると、テンプレート内で特定の言語で翻訳されたテキストを取得することができます。

例:

<h1>{% language 'ja' %}ようこそ！{% endlanguage %}</h1>

<p>
  {% language 'en' %}This is a paragraph in English.{% endlanguage %}
</p>

get_text() 関数

django.utils.text.get_text() 関数を使用すると、特定の言語で翻訳されたテキストを取得することができます。

例:

from django.utils import text

greeting = text.get_text("Hello, world!", language='ja')
print(greeting)  # 出力: こんにちは、世界！

自分で翻訳関数を作る

上記のいずれの方法にも当てはまらない場合は、自分で翻訳関数を作ることができます。

例:

def my_translation_function(text, language):
  # 翻訳処理を行うコード
  return translated_text

# 使用例
translated_text = my_translation_function("Hello, world!", language='ja')
print(translated_text)  # 出力: こんにちは、世界！

• 多くの場合、django.utils.translation.activate() を使うのが最も簡単で効率的な方法です。
• ミドルウェアを使うと、リクエストごとに自動的に言語設定を切り替えることができます。
• テンプレートタグを使うと、テンプレート内で簡単に翻訳されたテキストを取得することができます。
• get_text() 関数を使うと、コード内で簡単に翻訳されたテキストを取得することができます。
• 自分で翻訳関数を作る必要があるのは、上記のいずれの方法にも当てはまらない場合のみです。

Django には、言語を切り替えるための様々な方法があります。どの方法を使うべきかは、状況によって異なります。