Merge pull request #59 from maykinmedia/issue/58-setup-config-example-uuid

🐛 [#58] Add example for UUID field in directive

Author: swrichards

django_setup_configuration/documentation/setup_config_example.py

@@ -16,7 +16,9 @@
     get_args,
     get_origin,
 )
+from uuid import UUID
 
+from django.core.serializers.json import DjangoJSONEncoder
 from django.utils.functional import Promise
 
 import ruamel.yaml
@@ -123,6 +125,8 @@ def _insert_example_with_comments(
     """
     if isinstance(example, str) and "\n" in example:
         example = LiteralScalarString(example)
+    if isinstance(example, UUID):
+        example = str(example)
 
     example_data[field_name] = example
     example_data.yaml_set_comment_before_after_key(field_name, before="\n")
@@ -140,14 +144,14 @@ def _insert_example_with_comments(
         _yaml_set_wrapped_comment(
             example_data,
             field_name,
-            f"POSSIBLE VALUES: {json.dumps(values)}",
+            f"POSSIBLE VALUES: {json.dumps(values, cls=DjangoJSONEncoder)}",
             80,
             indent=depth * 2,
         )
 
     if (default := _get_default_from_field_info(field_info)) is not PydanticUndefined:
         if not (isinstance(example, str) and "\n" in example):
-            default = json.dumps(default)
+            default = json.dumps(default, cls=DjangoJSONEncoder)
 
         example_data.yaml_set_comment_before_after_key(
             field_name, f"DEFAULT VALUE: {default}", indent=depth * 2
@@ -343,6 +347,7 @@ def _generate_basic_example(field_type: Any, field_info: FieldInfo) -> Any:
         float: 123.45,
         list: [],
         dict: {},
+        UUID: "02907e89-1ba8-43e9-a86c-d0534d461316",
     }
     return example_map.get(field_type, NO_EXAMPLE)
 

testapp/models.py

@@ -1,3 +1,5 @@
+from uuid import UUID
+
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from django.utils.functional import lazy
@@ -14,6 +16,10 @@ class DjangoModel(models.Model):
     int_with_default = models.IntegerField(default=42)
     nullable_int = models.IntegerField(null=True)
     nullable_int_with_default = models.IntegerField(default=42)
+    uuid_field = models.UUIDField()
+    uuid_field_with_default = models.UUIDField(
+        default=UUID("125a77ef-d158-4bea-b036-8dcdbdde428d")
+    )
 
     nullable_str = models.CharField(null=True, blank=False, max_length=1)
     nullable_and_blank_str = models.CharField(null=True, blank=False, max_length=1)

tests/test_documentation.py

@@ -8,7 +8,7 @@
 from docutils.frontend import get_default_settings
 from docutils.parsers.rst import Parser, directives
 from docutils.utils import new_document
-from pydantic import Field, ValidationError
+from pydantic import UUID4, Field, ValidationError
 
 from django_setup_configuration.configuration import BaseConfigurationStep
 from django_setup_configuration.documentation.setup_config_example import (
@@ -69,6 +69,7 @@ class ConfigModel(ConfigurationModel):
     sequence_of_primitives: list[int] = Field()
     literal: Literal["foo", "bar", "bar"] = Field()
     literal_block_scalar: str = Field(default='{\n  "foo":"bar",\n  "bar":"baz"\n}')
+    uuid_field: UUID4 = Field()
 
     class Meta:
         django_model_refs = {
@@ -81,6 +82,7 @@ class Meta:
                 "str_with_localized_default",
                 "int_with_lazy_default",
                 "blank_str",
+                "uuid_field_with_default",
             )
         }
         extra_kwargs = {
@@ -225,6 +227,9 @@ def test_directive_output(register_directive, docutils_document):
               "bar":"baz"
             }
 
+          # REQUIRED: true
+          uuid_field: 02907e89-1ba8-43e9-a86c-d0534d461316
+
           # REQUIRED: true
           required_int: 1234
 
@@ -274,6 +279,10 @@ def test_directive_output(register_directive, docutils_document):
           # DEFAULT VALUE: ""
           # REQUIRED: false
           blank_str: example_string
+
+          # DEFAULT VALUE: "125a77ef-d158-4bea-b036-8dcdbdde428d"
+          # REQUIRED: false
+          uuid_field_with_default: 125a77ef-d158-4bea-b036-8dcdbdde428d
     """
     )