如何在Django独立应用内部提供多语言翻译支持

1. 初始化应用翻译目录 #

在你的独立应用根目录（包含apps.py的目录）下新建locale文件夹，所有翻译文件都会存放在这个目录下，随应用一起打包分发。

2. 应用内执行makemessages生成翻译模板 #

不需要依赖父项目的manage.py，你可以在应用根目录下创建一个最小的临时Django配置文件，命名为minimal_settings.py，内容如下：

INSTALLED_APPS = [
    'your_app_name', # 替换为你的独立应用名
]
USE_I18N = True
LOCALE_PATHS = [
    'locale',
]

随后在应用根目录执行命令生成po翻译模板文件：

• 生成多语言翻译模板：
  django-admin makemessages -l zh_Hans -l en -d django -i "minimal_settings.py" --settings=minimal_settings
  参数说明：
  • -l 后接需要支持的语言编码，可添加多个
  • -d django 指定翻译域为django，对应Python代码和模板中的翻译字符串
  • -i 用于屏蔽不需要扫描的文件

3. 编写并编译翻译内容 #

生成的po文件会存放在locale/对应语言/LC_MESSAGES/django.po路径下，直接在对应po文件中填写msgstr字段的翻译内容即可，编写完成后执行编译命令：
django-admin compilemessages --settings=minimal_settings
编译后生成的mo文件就是最终生效的翻译文件。

4. 配置应用自动加载翻译 #

不需要父项目做额外配置，只需在应用的AppConfig中指定翻译路径即可，在apps.py中添加如下配置：

from django.apps import AppConfig
from django.utils.translation import gettext_lazy as _

class YourAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'your_app_name'
    verbose_name = _('你的应用名称')
    
    def ready(self):
        from django.conf import settings
        import os
        # 将应用自身的locale路径插入全局翻译路径的最优先级
        settings.LOCALE_PATHS.insert(0, os.path.join(os.path.dirname(__file__), 'locale'))

父项目只要将你的应用加入INSTALLED_APPS、开启USE_I18N，就会自动加载应用内置的翻译，无需做任何额外翻译相关操作。

注意事项 #

• 你现有的from django.utils.translation import gettext写法不需要修改，正常使用即可，模板中的翻译标签也可照常使用
• 后续更新翻译字符串时，只需在应用目录重新执行makemessages、编写翻译、compilemessages三个步骤，所有使用该应用的父项目都会自动生效新翻译，不需要在父项目做任何操作
• 打包应用发布时，记得把locale目录包含在MANIFEST.in中，避免翻译文件被漏掉，可在MANIFEST.in中添加一行：
  recursive-include your_app_name/locale *

内容的提问来源于stack exchange，提问作者Viljami