Django中动态模型选择项的国际化与翻译实践（化与.模型.实践.翻译.选择...）

Django中动态模型选择项的国际化与翻译实践

本文详细介绍了在Django项目中如何正确实现模型动态选择项（如状态字段）的国际化与翻译。核心策略是利用TextChoices定义可翻译的字段标签，并通过gettext_lazy标记字符串，最终在模板中使用get_FOO_display()方法来渲染已翻译的文本，从而解决{% blocktranslate %}无法直接翻译动态变量内容的难题。理解Django中动态内容翻译的挑战

在django开发多语言网站时，我们经常会遇到需要翻译模型字段中动态值（例如，charfield的choices选项）的情况。一个常见的误区是尝试直接在模板中使用{% blocktranslate %}{{ object.field }}{% endblocktranslate %}来翻译这些动态变量。然而，django的翻译系统在解析模板时，blocktranslate标签无法识别{{ object.field }}内部的具体值，因此在生成.po文件时，它只会生成一个包含占位符的通用msgid，而不是具体的、可翻译的字符串。这导致无法针对每个具体的选择项值进行单独翻译。

例如，对于以下模型和模板代码：

models.py

from django.db import models

class Order_product(models.Model):
    name = models.CharField(max_length=255)
    note = models.TextField()
    status = models.CharField(max_length=255, choices=[
        ('Pending', 'Pending'),
        ('Need-Delivery', 'Need-Delivery'),
        ('Delivery', 'Delivery'),
        ('Success', 'Success'),
        ('Return-Order', 'Return-Order'),
        ('Cancel', 'Cancel')
    ])

template.html

{% for each_order in get_order %}
   <p>
       {% blocktranslate %}
           {{ each_order.status }}
       {% endblocktranslate %}
   </p>
{% endfor %}

运行python manage.py makemessages后，.po文件中可能会生成类似msgid "\n %(each_order.status)s\n "的条目，这显然无法进行有效的翻译。

解决方案：利用TextChoices与get_FOO_display()

Django提供了一种更优雅、更有效的方法来处理模型字段选择项的国际化：结合使用TextChoices和模型实例的get_FOO_display()方法。

1. 使用TextChoices定义可翻译的字段选项

TextChoices是Django 3.0及以后版本引入的一种枚举类型，它使得定义模型字段的choices变得更加清晰和强大。最重要的是，它允许我们直接在定义时标记选择项的显示文本（human-readable label）为可翻译字符串。

修改后的models.py

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

class Order_product(models.Model):
    # 定义订单状态的TextChoices枚举
    class StatusChoices(models.TextChoices):
        PENDING = "Pending", _("Pending")
        NEED_DELIVERY = "Need-Delivery", _("Need Delivery")
        DELIVERY = "Delivery", _("Delivery")
        SUCCESS = "Success", _("Success")
        RETURN_ORDER = "Return-Order", _("Return Order")
        CANCEL = "Cancel", _("Cancel")

    name = models.CharField(max_length=255)
    note = models.TextField()
    # 将status字段的choices属性设置为StatusChoices枚举
    status = models.CharField(
        max_length=255,
        choices=StatusChoices.choices,
        default=StatusChoices.PENDING
    )

    def __str__(self):
        return f"Order {self.id} - {self.get_status_display()}"

在上述代码中：

我们定义了一个嵌套类StatusChoices，继承自models.TextChoices。
每个枚举成员都包含两个部分：实际存储在数据库中的值（例如"Pending"）和用户可见的、可翻译的标签（例如_("Pending")）。
gettext_lazy as _ 用于标记这些标签字符串，以便makemessages工具能够识别它们并将其添加到.po文件中。

2. 生成并翻译.po文件

完成models.py的修改后，需要重新生成翻译文件：

python manage.py makemessages -l zh_Hans  # 或你的目标语言代码

此时，Django的makemessages工具会扫描你的代码，识别出所有被_()（或gettext_lazy()）标记的字符串，并将它们添加到对应的.po文件中。例如，zh_Hans/LC_MESSAGES/django.po中将包含类似以下条目：

msgid "Pending"
msgstr "待处理"

msgid "Need Delivery"
msgstr "待发货"

msgid "Success"
msgstr "已完成"
# ... 其他状态

接下来，你可以使用文本编辑器或专业的翻译工具（如Poedit）来翻译这些msgid对应的msgstr。翻译完成后，编译消息文件：

Teleporthq

一体化AI网站生成器，能够快速设计和部署静态网站

182 查看详情 Teleporthq

python manage.py compilemessages

这将把.po文件编译成.mo文件，供Django运行时使用。

3. 在模板中使用get_FOO_display()

TextChoices与Django模型字段的一个强大结合点是get_FOO_display()方法。对于任何定义了choices属性的字段FOO，Django模型实例都会自动获得一个get_FOO_display()方法。这个方法会返回该字段当前值的人类可读标签，并且这个标签会根据当前激活的语言环境自动进行翻译。

修改后的template.html

{% for each_order in get_order %}
   <p>
       <!-- 直接使用 get_status_display() 方法 -->
       {{ each_order.get_status_display }}
   </p>
{% endfor %}

现在，当用户访问网站时，{{ each_order.get_status_display }}会根据用户的语言设置，显示“待处理”、“已完成”等翻译后的状态文本，而不是原始的英文值。

注意事项

LocaleMiddleware配置：确保你的settings.py中已正确配置并启用了LocaleMiddleware，这是Django实现国际化和语言切换的基础。

# settings.py
MIDDLEWARE = [
    # ...
    'django.middleware.locale.LocaleMiddleware',
    # ...
]

LANGUAGES = [
    ('en', _('English')),
    ('vi', _('Vietnamese')),
    ('zh-hans', _('Simplified Chinese')),
]

LOCALE_PATHS = [
    BASE_DIR / 'locale',
]

compilemessages的重要性：每次修改.po文件后，务必运行python manage.py compilemessages，否则你的翻译将不会生效。
非模型字段的动态翻译：如果需要翻译的动态值并非来自模型字段的choices，而是其他动态生成或从外部获取的字符串，那么你需要确保这些字符串在代码中被_()或gettext()标记，并在模板中直接使用{% translate variable_with_marked_string %}或{{ variable_with_marked_string }}（前提是variable_with_marked_string本身就是一个gettext_lazy对象）。然而，对于模型字段的选择项，TextChoices和get_FOO_display()是最佳实践。

总结

在Django中翻译动态模型字段的选择项，最佳实践是：

使用models.TextChoices：清晰地定义字段的选项，并使用gettext_lazy (_) 标记其显示标签。
运行makemessages和compilemessages：生成并编译翻译文件。
在模板中使用get_FOO_display()：直接渲染已翻译的标签，无需blocktranslate。

通过遵循这些步骤，你可以有效地为你的Django应用实现模型字段选择项的国际化，提供更友好的多语言用户体验。

以上就是Django中动态模型选择项的国际化与翻译实践的详细内容，更多请关注知识资源分享宝库其它相关文章！

相关标签： python html go 工具多语言 django Python django html Object 枚举类型字符串继承对象数据库大家都在看：如何在Python中检测单词是否包含元音 python中如何清空一个列表_Python清空列表的正确方法 Python怎么格式化字符串_Python字符串格式化方法详解 python如何实现尾递归优化_python尾递归优化的原理与实现检测字符串中是否包含元音字母的 Python 方法