feat: add ability to set a custom verbose name (#770)

Co-authored-by: Serhii Tereshchenko <[email protected]>

Author: coreyar

docs/modeltranslation/installation.rst

@@ -376,3 +376,18 @@ Default: ``True``
 .. versionadded:: 0.6
 
 Control if :ref:`fallback <fallback>` (both language and value) will occur.
+
+
+``MODELTRANSLATION_BUILD_LOCALIZED_VERBOSE_NAME``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``lambda verbose_name, lang: f"{verbose_name} [{lang}]"``
+
+.. versionadded:: 0.19
+
+Define a method to build localized verbose name.
+The verbose name by default is the field name followed by a space and the language code in brackets.
+
+        def get_verbose_name(verbose_name: str, lang: str):
+            return f"{lang} - {verbose_name}"
+        MODELTRANSLATION_BUILD_LOCALIZED_VERBOSE_NAME = get_verbose_name

modeltranslation/settings.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+from typing import Callable
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
@@ -76,6 +77,12 @@
 
 LOADDATA_RETAIN_LOCALE: bool = getattr(settings, "MODELTRANSLATION_LOADDATA_RETAIN_LOCALE", True)
 
+BUILD_LOCALIZED_VERBOSE_NAME: Callable[[str, str], str] = getattr(
+    settings,
+    "MODELTRANSLATION_BUILD_LOCALIZED_VERBOSE_NAME",
+    lambda verbose_name, lang: f"{verbose_name} [{lang}]",
+)
+
 JQUERY_URL: str = getattr(
     settings,
     "JQUERY_URL",

modeltranslation/tests/tests.py

@@ -270,6 +270,16 @@ 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):
+        def get_verbose_name(verbose_name, language):
+            return f"({language}) {verbose_name}"
+
+        with reload_override_settings(
+            MODELTRANSLATION_BUILD_LOCALIZED_VERBOSE_NAME=get_verbose_name
+        ):
+            verbose_name = models.TestModel._meta.get_field("title_de").verbose_name
+            assert verbose_name == "(de) title"
+
     def test_descriptor_introspection(self):
         # See Django #8248
         assert isinstance(models.TestModel.title.__doc__, str), (

modeltranslation/utils.py

@@ -5,7 +5,6 @@
 from typing import Any, TypeVar
 from collections.abc import Generator, Iterable, Iterator
 from django.db import models
-from django.utils.encoding import force_str
 from django.utils.functional import lazy
 from django.utils.translation import get_language as _get_language
 from django.utils.translation import get_language_info
@@ -72,7 +71,7 @@ def build_localized_fieldname(field_name: str, lang: str) -> str:
 def _build_localized_verbose_name(verbose_name: Any, lang: str) -> str:
     if lang == "id":
         lang = "ind"
-    return force_str("%s [%s]") % (force_str(verbose_name), lang)
+    return settings.BUILD_LOCALIZED_VERBOSE_NAME(verbose_name, lang)
 
 
 build_localized_verbose_name = lazy(_build_localized_verbose_name, str)