Django及Web开发中全局资源变量的单源管理方案咨询

我正在为一个Django教程项目开发测试框架，发现需要重复复制粘贴表单的字段标签、帮助文本以验证有效性，修改时要同步改动多处，违反了DRY（Don't Repeat Yourself）编程原则。示例代码如下：

表单定义（models.py） #

class MyForm(ModelForm):
    def clean_field(self):
        data = self.cleaned_data['my_field']
        # 字段验证逻辑
        return data

    class Meta:
        model = MyModel
        fields = ['field_a', 'field_b'] # 复制粘贴内容
        labels = {'field_a': '字段A标签', ...} # 复制粘贴内容
        help_texts = {'field_a': '字段A帮助文本', ...} # 复制粘贴内容

测试代码（test_forms.py） #

class MyFormTest(SimpleTestCase):
    def setUp(self):
        self.form = MyForm()

    def test_field_a_form_label(self):
        expected = '字段A标签' # 复制粘贴内容
        fl = self.form.fields['field_a'].label # 复制粘贴内容

        self.assertTrue(fl is None or fl == expected)

对比Android中通过资源目录统一管理静态文本的方案，请问Web开发中（特指Django场景），针对标签、帮助文本这类资源变量，推荐的单源管理方案是什么？

1. 复用Django模型的原生字段定义 #

Django Model的字段本身支持verbose_name（对应表单标签）和help_text属性，ModelForm会自动继承这些配置，无需在表单Meta中重复定义：

模型定义 #

# models.py
from django.db import models

class MyModel(models.Model):
    field_a = models.CharField(
        max_length=50,
        verbose_name="字段A标签",  # 表单自动复用该标签
        help_text="字段A帮助文本"   # 表单自动复用该帮助文本
    )
    field_b = models.IntegerField(
        verbose_name="字段B标签",
        help_text="字段B帮助文本"
    )

表单定义 #

# forms.py
from django.forms import ModelForm
from .models import MyModel

class MyForm(ModelForm):
    def clean_field(self):
        data = self.cleaned_data['field_a']
        # 字段验证逻辑
        return data

    class Meta:
        model = MyModel
        fields = ['field_a', 'field_b']
        # 无需手动编写labels和help_texts！

测试代码 #

直接从模型字段获取预期值，避免硬编码：

# test_forms.py
from django.test import SimpleTestCase
from .forms import MyForm
from .models import MyModel

class MyFormTest(SimpleTestCase):
    def setUp(self):
        self.form = MyForm()

    def test_field_a_form_label(self):
        # 从模型字段获取预期标签
        expected_label = MyModel._meta.get_field('field_a').verbose_name
        actual_label = self.form.fields['field_a'].label
        self.assertEqual(actual_label, expected_label)

    def test_field_a_help_text(self):
        expected_help = MyModel._meta.get_field('field_a').help_text
        actual_help = self.form.fields['field_a'].help_text
        self.assertEqual(actual_help, expected_help)

2. 集中定义资源常量文件 #

如果需要脱离模型单独管理（比如多表单共用同一套文本），可以创建专门的常量文件统一维护：

常量文件（constants/form_resources.py） #

# 按表单分类管理标签和帮助文本
FORM_RESOURCES = {
    'MyForm': {
        'labels': {
            'field_a': '字段A标签',
            'field_b': '字段B标签'
        },
        'help_texts': {
            'field_a': '字段A帮助文本',
            'field_b': '字段B帮助文本'
        }
    }
}

表单引用 #

# forms.py
from django.forms import ModelForm
from .models import MyModel
from .constants.form_resources import FORM_RESOURCES

class MyForm(ModelForm):
    class Meta:
        model = MyModel
        fields = ['field_a', 'field_b']
        labels = FORM_RESOURCES['MyForm']['labels']
        help_texts = FORM_RESOURCES['MyForm']['help_texts']

测试引用 #

# test_forms.py
from django.test import SimpleTestCase
from .forms import MyForm
from .constants.form_resources import FORM_RESOURCES

class MyFormTest(SimpleTestCase):
    def setUp(self):
        self.form = MyForm()

    def test_field_a_form_label(self):
        expected_label = FORM_RESOURCES['MyForm']['labels']['field_a']
        actual_label = self.form.fields['field_a'].label
        self.assertEqual(actual_label, expected_label)

3. 使用Django国际化（i18n）框架 #

如果项目需要多语言支持，Django的i18n框架是天然的单源文本管理方案：

1. 启用国际化配置（settings.py） #

USE_I18N = True
LOCALE_PATHS = [BASE_DIR / 'locale'] # 翻译文件存放目录

2. 定义翻译文本 #

在locale/zh_Hans/LC_MESSAGES/django.po中添加翻译条目：

msgid "字段A标签"
msgstr "字段A标签"

msgid "字段A帮助文本"
msgstr "字段A帮助文本"

执行django-admin compilemessages编译翻译文件。

3. 模型/表单中使用翻译函数 #

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

class MyModel(models.Model):
    field_a = models.CharField(
        max_length=50,
        verbose_name=_("字段A标签"),
        help_text=_("字段A帮助文本")
    )

4. 测试代码中获取翻译文本 #

# test_forms.py
from django.test import SimpleTestCase
from django.utils.translation import gettext as _
from .forms import MyForm

class MyFormTest(SimpleTestCase):
    def setUp(self):
        self.form = MyForm()

    def test_field_a_form_label(self):
        expected_label = _("字段A标签")
        actual_label = self.form.fields['field_a'].label
        self.assertEqual(actual_label, expected_label)

4. 封装表单基类简化重复逻辑 #

如果多个表单需要统一的资源管理逻辑，可以封装基类自动加载资源：

# forms.py
from django.forms import ModelForm
from .constants.form_resources import FORM_RESOURCES

class BaseResourceForm(ModelForm):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 根据表单类名自动加载对应资源
        form_name = self.__class__.__name__
        if form_name in FORM_RESOURCES:
            # 设置标签
            for field, label in FORM_RESOURCES[form_name]['labels'].items():
                if field in self.fields:
                    self.fields[field].label = label
            # 设置帮助文本
            for field, help_text in FORM_RESOURCES[form_name]['help_texts'].items():
                if field in self.fields:
                    self.fields[field].help_text = help_text

# 继承基类使用
class MyForm(BaseResourceForm):
    class Meta:
        model = MyModel
        fields = ['field_a', 'field_b']

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