Simplify generate() function signature using Unpack[GenerateConfigDict] (#2874)

koxudaxi · web-flow · commit 061011892c29 · 2025-12-30T18:44:07.000Z
* Simplify generate() function signature using Unpack[GenerateConfigDict]

* Fix aliases type to support list values (Mapping[str, str | list[str]])

* Add type and default value checks to test_generate_signature_matches_baseline
diff --git a/src/datamodel_code_generator/__init__.py b/src/datamodel_code_generator/__init__.py
diff --git a/src/datamodel_code_generator/_types/generate_config_dict.py b/src/datamodel_code_generator/_types/generate_config_dict.py
@@ -53,7 +53,7 @@ class GenerateConfigDict(TypedDict):
     field_constraints: NotRequired[bool]
     snake_case_field: NotRequired[bool]
     strip_default_none: NotRequired[bool]
-    aliases: NotRequired[Mapping[str, str] | None]
+    aliases: NotRequired[Mapping[str, str | list[str]] | None]
     disable_timestamp: NotRequired[bool]
     enable_version_header: NotRequired[bool]
     enable_command_header: NotRequired[bool]
diff --git a/src/datamodel_code_generator/_types/parser_config_dict.py b/src/datamodel_code_generator/_types/parser_config_dict.py
@@ -47,7 +47,7 @@ class ParserConfigDict(TypedDict):
     field_constraints: NotRequired[bool]
     snake_case_field: NotRequired[bool]
     strip_default_none: NotRequired[bool]
-    aliases: NotRequired[Mapping[str, str] | None]
+    aliases: NotRequired[Mapping[str, str | list[str]] | None]
     allow_population_by_field_name: NotRequired[bool]
     apply_default_values_for_required_fields: NotRequired[bool]
     allow_extra_fields: NotRequired[bool]
diff --git a/src/datamodel_code_generator/config.py b/src/datamodel_code_generator/config.py
@@ -86,7 +86,7 @@ class Config:
     field_constraints: bool = False
     snake_case_field: bool = False
     strip_default_none: bool = False
-    aliases: Mapping[str, str] | None = None
+    aliases: Mapping[str, str | list[str]] | None = None
     disable_timestamp: bool = False
     enable_version_header: bool = False
     enable_command_header: bool = False
@@ -222,7 +222,7 @@ class Config:
     field_constraints: bool = False
     snake_case_field: bool = False
     strip_default_none: bool = False
-    aliases: Mapping[str, str] | None = None
+    aliases: Mapping[str, str | list[str]] | None = None
     allow_population_by_field_name: bool = False
     apply_default_values_for_required_fields: bool = False
     allow_extra_fields: bool = False
diff --git a/src/datamodel_code_generator/parser/base.py b/src/datamodel_code_generator/parser/base.py
@@ -707,7 +707,7 @@ def __init__(  # noqa: PLR0912, PLR0913, PLR0915
         field_constraints: bool = False,
         snake_case_field: bool = False,
         strip_default_none: bool = False,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         allow_population_by_field_name: bool = False,
         apply_default_values_for_required_fields: bool = False,
         allow_extra_fields: bool = False,
diff --git a/src/datamodel_code_generator/parser/graphql.py b/src/datamodel_code_generator/parser/graphql.py
@@ -122,7 +122,7 @@ def __init__(  # noqa: PLR0913
         field_constraints: bool = False,
         snake_case_field: bool = False,
         strip_default_none: bool = False,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         allow_population_by_field_name: bool = False,
         apply_default_values_for_required_fields: bool = False,
         allow_extra_fields: bool = False,
diff --git a/src/datamodel_code_generator/parser/jsonschema.py b/src/datamodel_code_generator/parser/jsonschema.py
@@ -658,7 +658,7 @@ def __init__(  # noqa: PLR0913
         field_constraints: bool = False,
         snake_case_field: bool = False,
         strip_default_none: bool = False,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         allow_population_by_field_name: bool = False,
         apply_default_values_for_required_fields: bool = False,
         allow_extra_fields: bool = False,
diff --git a/src/datamodel_code_generator/parser/openapi.py b/src/datamodel_code_generator/parser/openapi.py
@@ -202,7 +202,7 @@ def __init__(  # noqa: PLR0913
         field_constraints: bool = False,
         snake_case_field: bool = False,
         strip_default_none: bool = False,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         allow_population_by_field_name: bool = False,
         allow_extra_fields: bool = False,
         extra_fields: str | None = None,
diff --git a/src/datamodel_code_generator/reference.py b/src/datamodel_code_generator/reference.py
@@ -526,7 +526,7 @@ def __init__(  # noqa: PLR0913, PLR0917
         duplicate_name_suffix: str | None = None,
         base_url: str | None = None,
         singular_name_suffix: str | None = None,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         snake_case_field: bool = False,  # noqa: FBT001, FBT002
         empty_field_name: str | None = None,
         custom_class_name_generator: Callable[[str], str] | None = None,
diff --git a/tests/main/test_main_general.py b/tests/main/test_main_general.py
@@ -1978,6 +1978,7 @@ def test_generate_with_config_object(output_file: Path) -> None:
     GenerateConfig.model_rebuild(_types_namespace={"StrictTypes": StrictTypes, "UnionMode": UnionMode})
     config = GenerateConfig(
         input_filename="test.json",
+        output=output_file,
         output_model_type=DataModelType.PydanticV2BaseModel,
         use_schema_description=True,
         snake_case_field=True,
@@ -1986,7 +1987,6 @@ def test_generate_with_config_object(output_file: Path) -> None:
     )
     generate(
         input_='{"type": "object", "properties": {"userName": {"type": "string"}}}',
-        output=output_file,
         config=config,
     )
     content = output_file.read_text(encoding="utf-8")
@@ -1995,25 +1995,20 @@ def test_generate_with_config_object(output_file: Path) -> None:
 
 
 @pytest.mark.skipif(pydantic.VERSION < "2.0.0", reason="GenerateConfig requires Pydantic v2")
-def test_generate_with_config_object_extra_template_data_override(output_file: Path) -> None:
-    """Test generate() with extra_template_data passed directly, overriding config."""
-    from collections import defaultdict
-
+def test_generate_with_config_and_kwargs_raises_error(output_file: Path) -> None:
+    """Test generate() raises error when both config and kwargs are provided."""
     from datamodel_code_generator.model.pydantic_v2 import UnionMode
     from datamodel_code_generator.types import StrictTypes
 
     GenerateConfig.model_rebuild(_types_namespace={"StrictTypes": StrictTypes, "UnionMode": UnionMode})
     config = GenerateConfig(
         input_filename="test.json",
         output_model_type=DataModelType.PydanticV2BaseModel,
-        extra_template_data={"Model": {"config_key": "config_value"}},
-    )
-    # Pass extra_template_data directly - this should override config value
-    generate(
-        input_='{"type": "object", "properties": {"name": {"type": "string"}}}',
-        output=output_file,
-        config=config,
-        extra_template_data=defaultdict(dict, {"Model": {"direct_key": "direct_value"}}),
     )
-    content = output_file.read_text(encoding="utf-8")
-    assert "class Model" in content
+    # Passing both config and kwargs should raise ValueError
+    with pytest.raises(ValueError, match="Cannot specify both 'config' and keyword arguments"):
+        generate(
+            input_='{"type": "object", "properties": {"name": {"type": "string"}}}',
+            output=output_file,
+            config=config,
+        )
diff --git a/tests/main/test_public_api_signature_baseline.py b/tests/main/test_public_api_signature_baseline.py
@@ -72,7 +72,7 @@ def _baseline_generate(
     field_constraints: bool = False,
     snake_case_field: bool = False,
     strip_default_none: bool = False,
-    aliases: Mapping[str, str] | None = None,
+    aliases: Mapping[str, str | list[str]] | None = None,
     disable_timestamp: bool = False,
     enable_version_header: bool = False,
     enable_command_header: bool = False,
@@ -202,7 +202,7 @@ def __init__(
         field_constraints: bool = False,
         snake_case_field: bool = False,
         strip_default_none: bool = False,
-        aliases: Mapping[str, str] | None = None,
+        aliases: Mapping[str, str | list[str]] | None = None,
         allow_population_by_field_name: bool = False,
         apply_default_values_for_required_fields: bool = False,
         allow_extra_fields: bool = False,
@@ -452,12 +452,52 @@ def _types_match(config_type: Any, dict_type: Any) -> bool:
 
 
 def test_generate_signature_matches_baseline() -> None:
-    """Ensure generate keeps the origin/main kw-only args and annotations."""
+    """Ensure generate keeps backward compatibility via GenerateConfigDict.
+
+    The new signature uses **options: Unpack[GenerateConfigDict], so we verify
+    that GenerateConfigDict has all the same keys as the baseline function's
+    keyword-only arguments (except 'config'), matching types and default values.
+    """
+    from datamodel_code_generator._types import GenerateConfigDict
+
     expected = inspect.signature(_baseline_generate)
-    actual = inspect.signature(generate)
-    assert _kwonly_by_name(actual).keys() == _kwonly_by_name(expected).keys()
-    for name, param in _kwonly_by_name(expected).items():
-        assert _kwonly_by_name(actual)[name].annotation == param.annotation
+    baseline_params = {k: v for k, v in _kwonly_by_name(expected).items() if k != "config"}
+    dict_annotations = GenerateConfigDict.__annotations__
+
+    # 1. Verify all baseline kwargs are in GenerateConfigDict (key names)
+    baseline_kwargs = set(baseline_params.keys())
+    dict_keys = set(dict_annotations.keys())
+    assert baseline_kwargs == dict_keys, (
+        f"Mismatch between baseline args and GenerateConfigDict keys:\n"
+        f"  In baseline but not in dict: {baseline_kwargs - dict_keys}\n"
+        f"  In dict but not in baseline: {dict_keys - baseline_kwargs}"
+    )
+
+    # 2. Verify types match between baseline and GenerateConfigDict
+    for name, param in baseline_params.items():
+        baseline_type = param.annotation
+        dict_type = dict_annotations[name]
+        assert _types_match(baseline_type, dict_type), (
+            f"Type mismatch for '{name}':\n"
+            f"  Baseline: {_normalize_type(baseline_type)}\n"
+            f"  TypedDict: {_normalize_type(dict_type)}"
+        )
+
+    # 3. Verify default values match between baseline and GenerateConfig (Pydantic v2 only)
+    if is_pydantic_v2():
+        from datamodel_code_generator.config import GenerateConfig
+        from datamodel_code_generator.model.pydantic_v2 import UnionMode
+        from datamodel_code_generator.types import StrictTypes
+
+        GenerateConfig.model_rebuild(_types_namespace={"StrictTypes": StrictTypes, "UnionMode": UnionMode})
+
+        for name, param in baseline_params.items():
+            if param.default is inspect.Parameter.empty:
+                continue
+            config_default = GenerateConfig.model_fields[name].default
+            assert config_default == param.default, (
+                f"Default mismatch for '{name}':\n  Baseline: {param.default!r}\n  GenerateConfig: {config_default!r}"
+            )
 
 
 def test_parser_signature_matches_baseline() -> None:
@@ -648,11 +688,11 @@ def test_generate_with_config_produces_same_result_as_kwargs(tmp_path: Path) ->
 
     # Generate with config
     config = GenerateConfig(
+        output=output_config,
         output_model_type=DataModelType.PydanticV2BaseModel,
     )
     generate(
         input_=schema,
-        output=output_config,
         config=config,
     )
 
