Ticket #19066: 0001-Allow-overriding-help_text-default-message-on-ManyTo.patch

django/db/models/fields/related.py

@@ -1162 +1162 @@
 
         Field.__init__(self, **kwargs)
 
-        msg = _('Hold down "Control", or "Command" on a Mac, to select more than one.')
-        self.help_text = string_concat(self.help_text, ' ', msg)
+        # Only display "Hold down..." message if an empty string is passed.
+        if not str(self.help_text):
+            self.help_text = _('Hold down "Control", or "Command" on a Mac, to select more than one.')
 
     def get_choices_default(self):
         return Field.get_choices(self, include_blank=False)

tests/modeltests/model_forms/models.py

@@ -272 +272 @@
     slug = models.CharField(max_length=50, unique_for_year='posted', blank=True)
     subtitle = models.CharField(max_length=50, unique_for_month='posted', blank=True)
     posted = models.DateField(blank=True, null=True)
+
+class M2MDefaultHelpText(models.Model):
+    ref = models.ManyToManyField("self", blank=True)
+
+class M2MNoHelpText(models.Model):
+    ref = models.ManyToManyField("self", blank=True, help_text=None)
+
+class M2MCustomHelpText(models.Model):
+    ref = models.ManyToManyField("self", blank=True, help_text="Help")
+
+class M2MEmptyHelpText(models.Model):
+    ref = models.ManyToManyField("self", blank=True, help_text="")

tests/modeltests/model_forms/tests.py

@@ -17 +17 @@
     Category, CommaSeparatedInteger, CustomFieldForExclusionModel, DerivedBook,
     DerivedPost, ExplicitPK, FlexibleDatePost, ImprovedArticle,
     ImprovedArticleWithParentLink, Inventory, PhoneNumber, Post, Price,
-    Product, TextFile, Writer, WriterProfile, test_images)
+    Product, TextFile, Writer, WriterProfile, test_images, M2MDefaultHelpText,
+    M2MNoHelpText, M2MCustomHelpText, M2MEmptyHelpText)
 
 if test_images:
     from .models import ImageFile, OptionalImageFile
@@ -176 +177 @@
         model = Price
         exclude = ('quantity',)
 
-
 class ModelFormBaseTest(TestCase):
     def test_base_form(self):
         self.assertEqual(list(BaseCategoryForm.base_fields),
@@ -330 +330 @@
         self.assertEqual(list(OrderFields2.base_fields),
                          ['slug', 'name'])
 
+    def test_default_M2M_helptext(self):
+        class DefaultHelpText(forms.ModelForm):
+            class Meta:
+                model = M2MDefaultHelpText
+
+        self.assertHTMLEqual(
+            str(DefaultHelpText()),
+            """<tr><th><label for="id_ref">Ref:</label></th><td><select id="id_ref" multiple="multiple" name="ref" /><br /><span class="helptext">
+            Hold down "Control", or "Command" on a Mac, to select more than one.</span></td></tr>"""
+            )
+
+    def test_override_M2M_helptext(self):
+        class NoHelpText(forms.ModelForm):
+            class Meta:
+                model = M2MNoHelpText
+
+        self.assertHTMLEqual(
+            str(NoHelpText()),
+            """<tr><th><label for="id_ref">Ref:</label></th><td><select id="id_ref" multiple="multiple" name="ref" /></td></tr>"""
+            )
+
+
+    def test_custom_M2M_helptext(self):
+        class CustomHelpText(forms.ModelForm):
+            class Meta:
+                model = M2MCustomHelpText
+
+        self.assertHTMLEqual(
+            str(CustomHelpText()),
+            """<tr><th><label for="id_ref">Ref:</label></th><td><select id="id_ref" multiple="multiple" name="ref" /><br /><span class="helptext">Help</span></td></tr>"""
+            )
+
+    def test_empty_M2M_helptext(self):
+        class EmptyHelpText(forms.ModelForm):
+            class Meta:
+                model = M2MEmptyHelpText
+
+        self.assertHTMLEqual(
+            str(EmptyHelpText()),
+            """<tr><th><label for="id_ref">Ref:</label></th><td><select id="id_ref" multiple="multiple" name="ref" /><br /><span class="helptext">
+            Hold down "Control", or "Command" on a Mac, to select more than one.</span></td></tr>"""
+            )
+
 
 class TestWidgetForm(forms.ModelForm):
     class Meta: