Skip to main content

Django i18n:国际化与翻译指南

从 settings.py 到生产:配置 Django 翻译系统、编写 PO 文件、处理复数,并利用 AI 自动翻译。

1

安装并提取字符串

Django 内置 i18n 框架,只需启用即可。安装 django-locale-chain 以实现智能语言回退,再使用 makemessages 将 Python 代码和模板中的可翻译字符串提取到 PO 文件。

Django 底层使用 GNU gettext。makemessages 命令会扫描代码中的 gettext 调用和模板标签,再生成 .po 文件。翻译后,compilemessages 会将其转换为二进制 .mo 文件,以便在运行时快速查找。
Terminal
pip install django-locale-chain
Terminal
# Extract all translatable strings from Python and template files
python manage.py makemessages -l de -l ja -l es -l fr

# After translating .po files, compile to .mo (binary)
python manage.py compilemessages

# Project structure after running makemessages:
# locale/
# ├── de/
# │   └── LC_MESSAGES/
# │       ├── django.po    <-- translate this
# │       └── django.mo    <-- compiled (auto-generated)
# ├── ja/
# │   └── LC_MESSAGES/
# │       ├── django.po
# │       └── django.mo
# └── es/
#     └── LC_MESSAGES/
#         ├── django.po
#         └── django.mo
2

配置设置和中间件

在 settings.py 中设置 USE_I18N = True、定义受支持的 LANGUAGES 列表,并将 LocaleMiddleware 添加到 MIDDLEWARE 栈,以启用国际化。LocaleMiddleware 会从 URL 前缀、会话、Cookie 或 Accept-Language 请求头检测用户语言。

settings.py
# settings.py

from django.utils.translation import gettext_lazy as _

# Default language
LANGUAGE_CODE = 'en'

# Enable i18n
USE_I18N = True
USE_L10N = True

# Languages your site supports
LANGUAGES = [
    ('en', _('English')),
    ('de', _('German')),
    ('ja', _('Japanese')),
    ('es', _('Spanish')),
    ('fr', _('French')),
    ('pt-br', _('Brazilian Portuguese')),
]

# Where Django looks for .po files
LOCALE_PATHS = [
    BASE_DIR / 'locale',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.locale.LocaleMiddleware',       # <-- enables i18n
    'locale_chain.middleware.LocaleChainMiddleware',    # <-- smart fallbacks
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
LocaleMiddleware 必须位于 SessionMiddleware 之后,因为它需要读取会话;同时应位于 CommonMiddleware 之前。顺序错误会让语言检测无提示失败,所有用户都会看到默认 LANGUAGE_CODE。

URL 国际化

使用 i18n_patterns() 自动为 URL 添加当前语言代码前缀。这样每种语言都拥有独立 URL 命名空间(/en/about/、/de/about/),更有利于 SEO,也方便用户分享特定语言链接。

urls.py
# urls.py
from django.conf.urls.i18n import i18n_patterns
from django.urls import path, include

urlpatterns = [
    # Non-localized URLs (API, admin, etc.)
    path('api/', include('api.urls')),
]

urlpatterns += i18n_patterns(
    # These get prefixed with the language code: /en/about/, /de/about/
    path('', include('myapp.urls')),
    path('admin/', admin.site.urls),
    prefix_default_language=False,  # Skip prefix for default language
)
3

标记待翻译字符串

Django 提供两个主要翻译函数:请求时求值的 gettext()(别名 _()),以及导入时求值的 gettext_lazy()。模板中使用 {% trans %} 和 {% blocktrans %} 标签。

在视图中(Python 代码)

views.py
from django.utils.translation import gettext as _
from django.utils.translation import ngettext
from django.http import HttpResponse

def greeting_view(request):
    # Simple translation
    welcome = _("Welcome to our site")

    # Translation with variables (Python string formatting)
    user_greeting = _("Hello, %(name)s!") % {"name": request.user.username}

    # Plurals
    count = request.user.order_set.count()
    order_text = ngettext(
        "You have %(count)d order.",
        "You have %(count)d orders.",
        count,
    ) % {"count": count}

    return HttpResponse(f"{welcome}<br>{user_greeting}<br>{order_text}")

在模板中

templates/myapp/index.html
{# Load the i18n template tags #}
{% load i18n %}

{# Simple translation #}
<h1>{% trans "Welcome to our site" %}</h1>

{# Translation with variables #}
{% blocktrans with name=user.username %}
  Hello, {{ name }}!
{% endblocktrans %}

{# Plurals in templates #}
{% blocktrans count count=order_count %}
  You have {{ count }} order.
{% plural %}
  You have {{ count }} orders.
{% endblocktrans %}

{# Mark strings as translatable but don't output them (for attributes, etc.) #}
{% trans "Submit" as submit_label %}
<button type="submit">{{ submit_label }}</button>

在模型和表单中

models.py
from django.db import models
from django.utils.translation import gettext_lazy as _

class Product(models.Model):
    name = models.CharField(_("product name"), max_length=200)
    description = models.TextField(_("description"), blank=True)

    class Meta:
        verbose_name = _("product")
        verbose_name_plural = _("products")

    def __str__(self):
        return self.name

# IMPORTANT: Use gettext_lazy (_) for anything evaluated at import time:
# - Model field labels, verbose_name, help_text
# - Form field labels
# - Class-level attributes
# Use gettext for anything evaluated at request time:
# - View functions, template tags
在模型字段、表单标签或类级属性中误用 gettext() 而非 gettext_lazy(),会让字符串在导入时(服务器启动时)只翻译一次,而不是按请求翻译。译文会固定为导入时的当前语言,通常就是默认 LANGUAGE_CODE。

PO 文件格式

运行 makemessages 后,Django 会为每种语言生成 .po(Portable Object)文件,其中包含 msgid/msgstr 对。翻译 msgstr 值,再运行 compilemessages,生成 Django 在运行时读取的二进制 .mo 文件。

locale/de/LC_MESSAGES/django.po
# locale/de/LC_MESSAGES/django.po

msgid "Welcome to our site"
msgstr "Willkommen auf unserer Seite"

msgid "Hello, %(name)s!"
msgstr "Hallo, %(name)s!"

#, python-format
msgid "You have %(count)d order."
msgid_plural "You have %(count)d orders."
msgstr[0] "Sie haben %(count)d Bestellung."
msgstr[1] "Sie haben %(count)d Bestellungen."

msgid "product name"
msgstr "Produktname"

msgid "description"
msgstr "Beschreibung"

msgid "product"
msgstr "Produkt"

msgid "products"
msgstr "Produkte"

msgid "Submit"
msgstr "Absenden"
4

处理复数和变量

Django 使用 ngettext() 处理复数,并遵守 GNU gettext 复数规则。每种语言都定义复数形式数量和选择正确形式的公式,PO 文件通过 Plural-Forms 请求头声明这些规则。

Plural forms by language
# English: 2 forms (singular, plural)
msgid "%(count)d item"
msgid_plural "%(count)d items"
msgstr[0] "%(count)d item"
msgstr[1] "%(count)d items"

# German: 2 forms (singular, plural)
msgstr[0] "%(count)d Artikel"
msgstr[1] "%(count)d Artikel"

# Russian: 3 forms (one, few, many)
msgstr[0] "%(count)d товар"        # 1 item
msgstr[1] "%(count)d товара"       # 2-4 items
msgstr[2] "%(count)d товаров"      # 5+ items

# Arabic: 6 forms (zero, one, two, few, many, other)
msgstr[0] "لا عناصر"               # 0
msgstr[1] "عنصر واحد"              # 1
msgstr[2] "عنصران"                 # 2
msgstr[3] "%(count)d عناصر"        # 3-10
msgstr[4] "%(count)d عنصرًا"       # 11-99
msgstr[5] "%(count)d عنصر"         # 100+

# Japanese: 1 form (no plural distinction)
msgstr[0] "%(count)d個のアイテム"

# In Python code, always use ngettext:
from django.utils.translation import ngettext

msg = ngettext(
    "%(count)d item",
    "%(count)d items",
    count,
) % {"count": count}
切勿在 gettext 调用内使用 Python f-string 或 .format(),翻译提取器无法解析。请使用旧式 %() 格式:_('Hello, %(name)s!') % {'name': name}。这样也能确保译员在 PO 编辑器中看到变量占位符。

自动保证翻译质量

使用 i18n-validate 在发布前发现缺失键和损坏的占位符。真实译文完成前,可使用 i18n-pseudo 生成伪译文来测试 UI。

常见问题

混淆 gettext() 与 gettext_lazy()

模型字段、表单标签和任何导入时求值的类级属性应使用 gettext_lazy()(导入为 _)。视图函数和请求时代码使用 gettext()。混用两者会把译文固定在服务器启动时的语言。

忘记运行 compilemessages

Django 读取的是 .mo(编译)文件,而不是 .po 文件。如果编辑 .po 后未运行 'python manage.py compilemessages',更改不会显示。请将 compilemessages 加入部署脚本。

未配置 LOCALE_PATHS

如果 LOCALE_PATHS 为空或指向错误目录,makemessages 会把 .po 文件创建在错误位置,Django 在运行时也无法找到。请始终设置 LOCALE_PATHS = [BASE_DIR / 'locale'],并确认目录存在。

URL 中缺少 i18n_patterns

没有 i18n_patterns() 时,URL 不带语言前缀,Django 只能依赖 Cookie 或请求头检测语言。这不利于 SEO,因为没有特定语言 URL,也会破坏通过 URL 切换语言。请用 i18n_patterns() 包装面向用户的 URL 模式。

使用 django-locale-chain 实现智能语言回退

区域变体缺失时,Django 翻译系统会直接回退到 LANGUAGE_CODE。即使已有 pt-PT 译文,pt-BR 用户仍会看到英语。django-locale-chain 通过安装 gettext 回退链修复此问题:pt-BR 会先尝试 pt-PT,再尝试 pt,最后才使用默认语言。

settings.py
# settings.py -- Smart fallback with django-locale-chain
# pip install django-locale-chain

MIDDLEWARE = [
    # ...
    'django.middleware.locale.LocaleMiddleware',
    'locale_chain.middleware.LocaleChainMiddleware',  # after LocaleMiddleware
    # ...
]

# That's it! 75 built-in fallback chains are now active:
# pt-BR user → tries pt-PT → tries pt → falls back to LANGUAGE_CODE
# es-MX user → tries es-419 → tries es → falls back to LANGUAGE_CODE
# fr-CA user → tries fr → falls back to LANGUAGE_CODE

# Optional: customize specific chains
LOCALE_FALLBACK_CHAINS = {
    "pt-BR": ["pt-PT", "pt"],
    "es-MX": ["es-419", "es"],
    "fr-CA": ["fr"],
}

# Or configure programmatically in AppConfig.ready():
from locale_chain import configure

class MyAppConfig(AppConfig):
    name = "myapp"

    def ready(self):
        configure(overrides={"zh-Hant-HK": ["zh-Hant-TW", "zh-Hant"]})

推荐的项目结构

Project Structure
myproject/
├── myproject/
│   ├── settings.py          # i18n config, MIDDLEWARE, LANGUAGES
│   ├── urls.py              # i18n_patterns for URL prefixing
│   └── wsgi.py
├── myapp/
│   ├── models.py            # gettext_lazy for field labels
│   ├── views.py             # gettext for request-time strings
│   └── templates/
│       └── myapp/
│           └── index.html   # {% load i18n %}, {% trans %}, {% blocktrans %}
├── locale/                  # Created by makemessages
│   ├── de/
│   │   └── LC_MESSAGES/
│   │       ├── django.po    # German translations
│   │       └── django.mo    # Compiled binary
│   ├── ja/
│   │   └── LC_MESSAGES/
│   │       ├── django.po
│   │       └── django.mo
│   └── es/
│       └── LC_MESSAGES/
│           ├── django.po
│           └── django.mo
├── manage.py
└── requirements.txt

立即试用 i18n Agent

将翻译文件拖放到此处

JSON, YAML, PO, XML, CSV, Markdown, Properties

或点击选择文件

目标语言

无需注册即时估价

使用 django-locale-chain 实现语言回退

如果 pt-BR 等区域语言缺少翻译键,Django 会直接跳到模板语言,而不会先检查父语言 pt。

Terminal
pip install django-locale-chain
Configuration
# settings.py
LOCALE_CHAINS = {
    'pt-BR': ['pt', 'es', 'en'],
    'zh-Hant-HK': ['zh-Hant', 'zh', 'en'],
}

MIDDLEWARE = [
    ...
    'django_locale_chain.middleware.LocaleChainMiddleware',
    ...
]

查看语言回退指南,了解受支持框架的完整列表和 75 条内置回退链。 Learn more →

常见问题