feat: add ability to set a custom verbose name

docs/modeltranslation/registration.rst

@@ -344,6 +344,12 @@ Classes inheriting from ``TranslationOptions`` can have following attributes def
         required_languages = ('en', 'de')
         required_languages = {'de': ('title','text'), 'default': ('title',)}
 
+.. attribute:: TranslationOptions.get_verbose_name
+
+    The verbose name by default is the field name followed by a space and the language code in brackets. This can be customized by implementing the ``get_verbose_name`` method.
+
+        def get_verbose_name(self, field_name, language):
+            return f"{language} - {field_name}"
 
 .. _supported_field_matrix:
 

modeltranslation/fields.py

@@ -16,7 +16,6 @@
 from modeltranslation.utils import (
     build_localized_fieldname,
     build_localized_intermediary_model,
-    build_localized_verbose_name,
     get_language,
     resolution_order,
 )
@@ -172,7 +171,7 @@ def __init__(
 
         # Copy the verbose name and append a language suffix
         # (will show up e.g. in the admin).
-        self.verbose_name = build_localized_verbose_name(translated_field.verbose_name, language)
+        self.verbose_name = trans_opts.get_verbose_name(translated_field.verbose_name, language)
 
         if self.remote_field:
             clear_ForeignObjectRel_caches(self.remote_field)

modeltranslation/tests/migrations/0001_initial.py

@@ -677,6 +677,20 @@ class Migration(migrations.Migration):
                 ("title_en", models.CharField(max_length=255, null=True, unique=True)),
             ],
         ),
+        migrations.CreateModel(
+            name="CustomVerboseNameModel",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, null=True, unique=True)),
+                ("title_de", models.CharField(max_length=255, null=True, unique=True)),
+                ("title_en", models.CharField(max_length=255, null=True, unique=True)),
+            ],
+        ),
         migrations.CreateModel(
             name="MultitableConflictModelB",
             fields=[

modeltranslation/tests/models.py

@@ -22,6 +22,10 @@ class UniqueNullableModel(models.Model):
     title = models.CharField(null=True, unique=True, max_length=255)
 
 
+class CustomVerboseNameModel(models.Model):
+    title = models.CharField(null=True, unique=True, max_length=255)
+
+
 # ######### Proxy model testing
 
 

modeltranslation/tests/tests.py

@@ -43,7 +43,7 @@
 request = None
 
 # How many models are registered for tests.
-TEST_MODELS = 40
+TEST_MODELS = 41
 
 
 class reload_override_settings(override_settings):
@@ -276,6 +276,14 @@ def test_verbose_name(self):
         verbose_name = models.TestModel._meta.get_field("title_de").verbose_name
         assert verbose_name == "title [de]"
 
+    def test_custom_verbose_name(self):
+        verbose_name = models.CustomVerboseNameModel._meta.get_field("title_de").verbose_name
+        assert verbose_name == "(de) title"
+
+    def test_custom_verbose_name_plural(self):
+        verbose_name = models.CustomVerboseNameModel._meta.get_field("title_de").verbose_name_plural
+        assert verbose_name == "(de) title"
+
     def test_descriptor_introspection(self):
         # See Django #8248
         assert isinstance(

modeltranslation/tests/translation.py

@@ -225,6 +225,15 @@ class CustomManagerTestModelTranslationOptions(TranslationOptions):
     fields = ("title",)
 
 
+# # ######### TranslationOptions verbose name
+@register(models.CustomVerboseNameModel)
+class CustomVerboseNameModelTranslationOptions(TranslationOptions):
+    fields = ("title",)
+
+    def get_verbose_name(self, verbose_name, language):
+        return f"({language}) {verbose_name}"
+
+
 # ######### TranslationOptions field inheritance testing
 
 

modeltranslation/translator.py

@@ -38,6 +38,7 @@
     build_localized_fieldname,
     parse_field,
     get_language,
+    build_localized_verbose_name,
 )
 
 # Re-export the decorator for convenience
@@ -170,6 +171,9 @@ def get_field_names(self) -> list[str]:
         """
         return list(self.all_fields.keys()) + self.related_fields
 
+    def get_verbose_name(self, verbose_name, language):
+        return build_localized_verbose_name(verbose_name, language)
+
     def __str__(self) -> str:
         local = tuple(self.local_fields.keys())
         inherited = tuple(set(self.all_fields.keys()) - set(local))