Merge pull request #37 from community-of-python/fix-merging-arbitrary-types-in-pydantic-configs

Make sure `Any` types are not converted to dict if applicable when merging Pydantic configs

Author: vrslev

microbootstrap/helpers.py

@@ -36,12 +36,13 @@ def merge_pydantic_configs(
     config_to_merge: PydanticConfigT,
     config_with_changes: PydanticConfigT,
 ) -> PydanticConfigT:
-    config_class: typing.Final = config_to_merge.__class__
-    resulting_dict_config: typing.Final = merge_dict_configs(
-        config_to_merge.model_dump(exclude_defaults=True, exclude_unset=True),
-        config_with_changes.model_dump(exclude_defaults=True, exclude_unset=True),
-    )
-    return config_class(**resulting_dict_config)
+    initial_fields: typing.Final = dict(config_to_merge)
+    changed_fields: typing.Final = {
+        one_field_name: getattr(config_with_changes, one_field_name)
+        for one_field_name in config_with_changes.model_fields_set
+    }
+    merged_fields: typing.Final = merge_dict_configs(initial_fields, changed_fields)
+    return config_to_merge.model_copy(update=merged_fields)
 
 
 def merge_dataclasses_configs(

tests/instruments/test_swagger.py

@@ -4,6 +4,7 @@
 import litestar
 from httpx import AsyncClient
 from litestar import openapi, status_codes
+from litestar.openapi import spec as litestar_openapi
 from litestar.openapi.plugins import ScalarRenderPlugin
 from litestar.static_files import StaticFilesConfig
 from litestar.testing import AsyncTestClient
@@ -52,7 +53,7 @@ def test_litestar_swagger_bootstrap_online_docs(minimal_swagger_config: SwaggerC
     assert "static_files_config" not in bootstrap_result
 
 
-def test_litestar_swagger_bootstrap_with_overriden_render_plugins(minimal_swagger_config: SwaggerConfig) -> None:
+def test_litestar_swagger_bootstrap_with_overridden_render_plugins(minimal_swagger_config: SwaggerConfig) -> None:
     new_render_plugins: typing.Final = [ScalarRenderPlugin()]
     minimal_swagger_config.swagger_extra_params["render_plugins"] = new_render_plugins
 
@@ -64,6 +65,21 @@ def test_litestar_swagger_bootstrap_with_overriden_render_plugins(minimal_swagge
     assert bootstrap_result["openapi_config"].render_plugins is new_render_plugins
 
 
+def test_litestar_swagger_bootstrap_extra_params_have_correct_types(minimal_swagger_config: SwaggerConfig) -> None:
+    swagger_instrument: typing.Final = LitestarSwaggerInstrument(minimal_swagger_config)
+    new_components: typing.Final = litestar_openapi.Components(
+        security_schemes={"Bearer": litestar_openapi.SecurityScheme(type="http", scheme="Bearer")}
+    )
+    swagger_instrument.configure_instrument(
+        minimal_swagger_config.model_copy(update={"swagger_extra_params": {"components": new_components}})
+    )
+    bootstrap_result: typing.Final = swagger_instrument.bootstrap_before()
+
+    assert "openapi_config" in bootstrap_result
+    assert isinstance(bootstrap_result["openapi_config"], openapi.OpenAPIConfig)
+    assert type(bootstrap_result["openapi_config"].components) is litestar_openapi.Components
+
+
 def test_litestar_swagger_bootstrap_offline_docs(minimal_swagger_config: SwaggerConfig) -> None:
     minimal_swagger_config.swagger_offline_docs = True
     swagger_instrument: typing.Final = LitestarSwaggerInstrument(minimal_swagger_config)

tests/test_helpers.py

@@ -49,6 +49,11 @@ class PydanticConfig(pydantic.BaseModel):
     dict_field: dict[str, typing.Any] = pydantic.Field(default_factory=dict)
 
 
+@dataclasses.dataclass
+class InnerDataclass:
+    string_field: str
+
+
 @pytest.mark.parametrize(
     ("first_model", "second_model", "result"),
     [
@@ -76,6 +81,19 @@ class PydanticConfig(pydantic.BaseModel):
                 dict_field={"value1": 1, "value2": 2, "value3": 4},
             ),
         ),
+        (
+            PydanticConfig(string_field="value1", array_field=[1, 2], dict_field={"value1": 1, "value3": 3}),
+            PydanticConfig(
+                string_field="value2",
+                array_field=[InnerDataclass(string_field="hi")],
+                dict_field={"value1": 1, "value2": 2, "value3": InnerDataclass(string_field="there")},
+            ),
+            PydanticConfig(
+                string_field="value2",
+                array_field=[1, 2, InnerDataclass(string_field="hi")],
+                dict_field={"value1": 1, "value2": 2, "value3": InnerDataclass(string_field="there")},
+            ),
+        ),
     ],
 )
 def test_merge_pydantic_configs(