Merge pull request #54 from maykinmedia/53-handle-localized-defaults-…

…in-example-generator

🐛 Handle gettext wrapped default values in example generator

django_setup_configuration/documentation/setup_config_example.py

@@ -17,6 +17,8 @@
     get_origin,
 )
 
+from django.utils.functional import Promise
+
 import ruamel.yaml
 from docutils import nodes
 from docutils.parsers.rst import Directive
@@ -68,11 +70,16 @@ def _get_default_from_field_info(field_info: FieldInfo) -> Any:
     """
     if field_info.default_factory:
         return field_info.default_factory()
-    return (
-        field_info.default.value
-        if isinstance(field_info.default, Enum)
-        else field_info.default
-    )
+
+    match field_info.default:
+        case Promise():
+            # Effectively a callable -- call the lazy function, e.g. gettext(), so we're
+            # left with a simple value, not a complex object which is hard to serialize
+            return field_info.default._proxy____cast()
+        case Enum():
+            return field_info.default.value
+        case _:
+            return field_info.default
 
 
 def _yaml_set_wrapped_comment(

testapp/models.py

@@ -1,5 +1,7 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
+from django.utils.functional import lazy
+from django.utils.translation import gettext_lazy as _
 
 
 class StrChoices(models.TextChoices):
@@ -60,3 +62,7 @@ class DjangoModel(models.Model):
         models.JSONField(), default=lambda: [{"foo": "bar"}, {"foo": "baz"}]
     )
     array_field = ArrayField(models.JSONField(), null=True, blank=True)
+    str_with_localized_default = models.TextField(default=_("Localized default"))
+    int_with_lazy_default = models.IntegerField(
+        default=lazy(lambda: 42, int)(), verbose_name="int with lazy default"
+    )

tests/test_documentation.py

@@ -78,6 +78,8 @@ class Meta:
                 "json_with_default_factory",
                 "nullable_str",
                 "int_with_choices_and_blank_and_non_choice_default",
+                "str_with_localized_default",
+                "int_with_lazy_default",
             )
         }
         extra_kwargs = {
@@ -259,6 +261,14 @@ def test_directive_output(register_directive, docutils_document):
           # DEFAULT VALUE: 42
           # REQUIRED: false
           int_with_choices_and_blank_and_non_choice_default: 42
+
+          # DEFAULT VALUE: "Localized default"
+          # REQUIRED: false
+          str_with_localized_default: Localized default
+
+          # DEFAULT VALUE: 42
+          # REQUIRED: false
+          int_with_lazy_default: 42
     """
     )