1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
|
"""Public API signature baselines from origin/main."""
from __future__ import annotations
import ast
import inspect
import types
from typing import TYPE_CHECKING, Annotated, Any, ForwardRef, Union, get_args, get_origin
import pytest
from typing_extensions import NotRequired
from datamodel_code_generator import DEFAULT_SHARED_MODULE_NAME, generate
from datamodel_code_generator.enums import (
AllExportsCollisionStrategy,
AllExportsScope,
AllOfClassHierarchy,
AllOfMergeMode,
ClassNameAffixScope,
CollapseRootModelsNameStrategy,
DataModelType,
FieldTypeCollisionStrategy,
GraphQLScope,
InputFileType,
ModuleSplitMode,
NamingStrategy,
OpenAPIScope,
ReadOnlyWriteOnlyModelType,
ReuseScope,
TargetPydanticVersion,
VersionMode,
)
from datamodel_code_generator.format import PythonVersionMin
from datamodel_code_generator.model.pydantic_v2 import BaseModel, DataModelField, DataTypeManager, RootModel
from datamodel_code_generator.parser.base import YamlValue, title_to_class_name
if TYPE_CHECKING:
from collections import defaultdict
from collections.abc import Callable, Iterable, Mapping, Sequence
from pathlib import Path
from urllib.parse import ParseResult
from datamodel_code_generator.config import GenerateConfig
from datamodel_code_generator.format import DateClassType, DatetimeClassType, Formatter, PythonVersion
from datamodel_code_generator.model import DataModel, DataModelFieldBase
from datamodel_code_generator.model.dataclass import DataclassArguments
from datamodel_code_generator.model.pydantic_v2 import UnionMode
from datamodel_code_generator.parser import DefaultPutDict, LiteralType
from datamodel_code_generator.types import StrictTypes
from datamodel_code_generator.validators import ModelValidators
def _baseline_generate(
input_: Path | str | ParseResult | Mapping[str, Any],
*,
config: GenerateConfig | None = None,
input_filename: str | None = None,
input_file_type: InputFileType = InputFileType.Auto,
output: Path | None = None,
output_model_type: DataModelType = DataModelType.PydanticV2BaseModel,
target_python_version: PythonVersion = PythonVersionMin,
target_pydantic_version: TargetPydanticVersion | None = None,
base_class: str = "",
base_class_map: dict[str, str | list[str]] | None = None,
additional_imports: list[str] | None = None,
class_decorators: list[str] | None = None,
custom_template_dir: Path | None = None,
extra_template_data: defaultdict[str, dict[str, Any]] | None = None,
validators: Mapping[str, ModelValidators] | None = None,
validation: bool = False,
field_constraints: bool = False,
snake_case_field: bool = False,
strip_default_none: bool = False,
aliases: Mapping[str, str | list[str]] | None = None,
default_value_overrides: Mapping[str, Any] | None = None,
disable_timestamp: bool = False,
enable_version_header: bool = False,
enable_command_header: bool = False,
command_line: str | None = None,
allow_population_by_field_name: bool = False,
allow_extra_fields: bool = False,
extra_fields: str | None = None,
use_generic_base_class: bool = False,
apply_default_values_for_required_fields: bool = False,
force_optional_for_required_fields: bool = False,
class_name: str | None = None,
class_name_prefix: str | None = None,
class_name_suffix: str | None = None,
class_name_affix_scope: ClassNameAffixScope = ClassNameAffixScope.All,
use_standard_collections: bool = True,
use_schema_description: bool = False,
use_field_description: bool = False,
use_field_description_example: bool = False,
use_attribute_docstrings: bool = False,
use_inline_field_description: bool = False,
use_default_kwarg: bool = False,
reuse_model: bool = False,
reuse_scope: ReuseScope = ReuseScope.Module,
shared_module_name: str = DEFAULT_SHARED_MODULE_NAME,
encoding: str = "utf-8",
enum_field_as_literal: LiteralType | None = None,
enum_field_as_literal_map: dict[str, str] | None = None,
ignore_enum_constraints: bool = False,
use_one_literal_as_default: bool = False,
use_enum_values_in_discriminator: bool = False,
set_default_enum_member: bool = False,
use_subclass_enum: bool = False,
use_specialized_enum: bool = True,
strict_nullable: bool = False,
use_generic_container_types: bool = False,
enable_faux_immutability: bool = False,
disable_appending_item_suffix: bool = False,
strict_types: Sequence[StrictTypes] | None = None,
empty_enum_field_name: str | None = None,
custom_class_name_generator: Callable[[str], str] | None = None,
field_extra_keys: set[str] | None = None,
field_include_all_keys: bool = False,
field_extra_keys_without_x_prefix: set[str] | None = None,
model_extra_keys: set[str] | None = None,
model_extra_keys_without_x_prefix: set[str] | None = None,
openapi_scopes: list[OpenAPIScope] | None = None,
include_path_parameters: bool = False,
openapi_include_paths: list[str] | None = None,
graphql_scopes: list[GraphQLScope] | None = None,
graphql_no_typename: bool = False,
wrap_string_literal: bool | None = None,
use_title_as_name: bool = False,
use_operation_id_as_name: bool = False,
use_unique_items_as_set: bool = False,
use_tuple_for_fixed_items: bool = False,
use_closed_typed_dict: bool = True,
allof_merge_mode: AllOfMergeMode = AllOfMergeMode.Constraints,
allof_class_hierarchy: AllOfClassHierarchy = AllOfClassHierarchy.IfNoConflict,
http_headers: Sequence[tuple[str, str]] | None = None,
http_ignore_tls: bool = False,
http_timeout: float | None = None,
use_annotated: bool = False,
use_serialize_as_any: bool = False,
use_non_positive_negative_number_constrained_types: bool = False,
use_decimal_for_multiple_of: bool = False,
original_field_name_delimiter: str | None = None,
use_double_quotes: bool = False,
use_union_operator: bool = True,
collapse_root_models: bool = False,
collapse_root_models_name_strategy: CollapseRootModelsNameStrategy | None = None,
collapse_reuse_models: bool = False,
skip_root_model: bool = False,
use_type_alias: bool = False,
use_root_model_type_alias: bool = False,
special_field_name_prefix: str | None = None,
remove_special_field_name_prefix: bool = False,
capitalise_enum_members: bool = False,
keep_model_order: bool = False,
custom_file_header: str | None = None,
custom_file_header_path: Path | None = None,
custom_formatters: list[str] | None = None,
custom_formatters_kwargs: dict[str, Any] | None = None,
use_pendulum: bool = False,
use_standard_primitive_types: bool = False,
http_query_parameters: Sequence[tuple[str, str]] | None = None,
treat_dot_as_module: bool | None = None,
use_exact_imports: bool = False,
use_type_checking_imports: bool | None = None,
union_mode: UnionMode | None = None,
output_datetime_class: DatetimeClassType | None = None,
output_date_class: DateClassType | None = None,
keyword_only: bool = False,
frozen_dataclasses: bool = False,
no_alias: bool = False,
use_serialization_alias: bool = False,
use_frozen_field: bool = False,
use_default_factory_for_optional_nested_models: bool = False,
formatters: list[Formatter] | None = None,
settings_path: Path | None = None,
parent_scoped_naming: bool = False,
naming_strategy: NamingStrategy | None = None,
duplicate_name_suffix: dict[str, str] | None = None,
dataclass_arguments: DataclassArguments | None = None,
disable_future_imports: bool = False,
type_mappings: list[str] | None = None,
type_overrides: dict[str, str] | None = None,
read_only_write_only_model_type: ReadOnlyWriteOnlyModelType | None = None,
use_status_code_in_response_name: bool = False,
all_exports_scope: AllExportsScope | None = None,
all_exports_collision_strategy: AllExportsCollisionStrategy | None = None,
field_type_collision_strategy: FieldTypeCollisionStrategy | None = None,
module_split_mode: ModuleSplitMode | None = None,
schema_version: str | None = None,
schema_version_mode: VersionMode | None = None,
external_ref_mapping: dict[str, str] | None = None,
) -> str | object | None:
raise NotImplementedError
class _BaselineParser:
def __init__(
self,
source: str | Path | list[Path] | ParseResult | dict[str, YamlValue],
*,
data_model_type: type[DataModel] = BaseModel,
data_model_root_type: type[DataModel] = RootModel,
data_type_manager_type: type[DataTypeManager] = DataTypeManager,
data_model_field_type: type[DataModelFieldBase] = DataModelField,
base_class: str | None = None,
base_class_map: dict[str, str | list[str]] | None = None,
additional_imports: list[str] | None = None,
class_decorators: list[str] | None = None,
custom_template_dir: Path | None = None,
extra_template_data: defaultdict[str, dict[str, Any]] | None = None,
validators: Mapping[str, ModelValidators] | None = None,
target_python_version: PythonVersion = PythonVersionMin,
dump_resolve_reference_action: Callable[[Iterable[str]], str] | None = None,
validation: bool = False,
field_constraints: bool = False,
snake_case_field: bool = False,
strip_default_none: bool = False,
aliases: Mapping[str, str | list[str]] | None = None,
default_value_overrides: Mapping[str, Any] | None = None,
allow_population_by_field_name: bool = False,
apply_default_values_for_required_fields: bool = False,
allow_extra_fields: bool = False,
extra_fields: str | None = None,
use_generic_base_class: bool = False,
force_optional_for_required_fields: bool = False,
class_name: str | None = None,
class_name_prefix: str | None = None,
class_name_suffix: str | None = None,
class_name_affix_scope: ClassNameAffixScope = ClassNameAffixScope.All,
use_standard_collections: bool = False,
base_path: Path | None = None,
use_schema_description: bool = False,
use_field_description: bool = False,
use_field_description_example: bool = False,
use_attribute_docstrings: bool = False,
use_inline_field_description: bool = False,
use_default_kwarg: bool = False,
reuse_model: bool = False,
reuse_scope: ReuseScope | None = None,
shared_module_name: str = DEFAULT_SHARED_MODULE_NAME,
encoding: str = "utf-8",
enum_field_as_literal: LiteralType | None = None,
enum_field_as_literal_map: dict[str, str] | None = None,
ignore_enum_constraints: bool = False,
set_default_enum_member: bool = False,
use_subclass_enum: bool = False,
use_specialized_enum: bool = True,
strict_nullable: bool = False,
use_generic_container_types: bool = False,
enable_faux_immutability: bool = False,
remote_text_cache: DefaultPutDict[str, str] | None = None,
disable_appending_item_suffix: bool = False,
strict_types: Sequence[StrictTypes] | None = None,
empty_enum_field_name: str | None = None,
custom_class_name_generator: Callable[[str], str] | None = title_to_class_name,
field_extra_keys: set[str] | None = None,
field_include_all_keys: bool = False,
field_extra_keys_without_x_prefix: set[str] | None = None,
model_extra_keys: set[str] | None = None,
model_extra_keys_without_x_prefix: set[str] | None = None,
wrap_string_literal: bool | None = None,
use_title_as_name: bool = False,
use_operation_id_as_name: bool = False,
use_unique_items_as_set: bool = False,
use_tuple_for_fixed_items: bool = False,
use_closed_typed_dict: bool = True,
allof_merge_mode: AllOfMergeMode = AllOfMergeMode.Constraints,
allof_class_hierarchy: AllOfClassHierarchy = AllOfClassHierarchy.IfNoConflict,
http_headers: Sequence[tuple[str, str]] | None = None,
http_ignore_tls: bool = False,
http_timeout: float | None = None,
use_annotated: bool = False,
use_serialize_as_any: bool = False,
use_non_positive_negative_number_constrained_types: bool = False,
use_decimal_for_multiple_of: bool = False,
original_field_name_delimiter: str | None = None,
use_double_quotes: bool = False,
use_union_operator: bool = False,
allow_responses_without_content: bool = False,
collapse_root_models: bool = False,
collapse_root_models_name_strategy: CollapseRootModelsNameStrategy | None = None,
collapse_reuse_models: bool = False,
skip_root_model: bool = False,
use_type_alias: bool = False,
special_field_name_prefix: str | None = None,
remove_special_field_name_prefix: bool = False,
capitalise_enum_members: bool = False,
keep_model_order: bool = False,
use_one_literal_as_default: bool = False,
use_enum_values_in_discriminator: bool = False,
known_third_party: list[str] | None = None,
custom_formatters: list[str] | None = None,
custom_formatters_kwargs: dict[str, Any] | None = None,
use_pendulum: bool = False,
use_standard_primitive_types: bool = False,
http_query_parameters: Sequence[tuple[str, str]] | None = None,
treat_dot_as_module: bool | None = None,
use_exact_imports: bool = False,
use_type_checking_imports: bool | None = None,
default_field_extras: dict[str, Any] | None = None,
target_datetime_class: DatetimeClassType | None = None,
target_date_class: DateClassType | None = None,
keyword_only: bool = False,
frozen_dataclasses: bool = False,
no_alias: bool = False,
use_serialization_alias: bool = False,
use_frozen_field: bool = False,
use_default_factory_for_optional_nested_models: bool = False,
formatters: list[Formatter] | None = None,
defer_formatting: bool = False,
parent_scoped_naming: bool = False,
naming_strategy: NamingStrategy | None = None,
duplicate_name_suffix: dict[str, str] | None = None,
dataclass_arguments: DataclassArguments | None = None,
type_mappings: list[str] | None = None,
type_overrides: dict[str, str] | None = None,
read_only_write_only_model_type: ReadOnlyWriteOnlyModelType | None = None,
field_type_collision_strategy: FieldTypeCollisionStrategy | None = None,
target_pydantic_version: TargetPydanticVersion | None = None,
external_ref_mapping: dict[str, str] | None = None,
) -> None:
raise NotImplementedError
def parse(
self,
with_import: bool | None = True,
format_: bool | None = True,
settings_path: Path | None = None,
disable_future_imports: bool = False,
all_exports_scope: AllExportsScope | None = None,
all_exports_collision_strategy: AllExportsCollisionStrategy | None = None,
module_split_mode: ModuleSplitMode | None = None,
) -> str | dict[tuple[str, ...], Any]:
raise NotImplementedError
def _kwonly_params(signature: inspect.Signature) -> list[inspect.Parameter]:
return [param for param in signature.parameters.values() if param.kind is inspect.Parameter.KEYWORD_ONLY]
def _kwonly_by_name(signature: inspect.Signature) -> dict[str, inspect.Parameter]:
return {param.name: param for param in _kwonly_params(signature)}
def _params_by_name(signature: inspect.Signature) -> dict[str, inspect.Parameter]:
return {
name: param
for name, param in signature.parameters.items()
if name != "self" and param.kind in {inspect.Parameter.POSITIONAL_OR_KEYWORD, inspect.Parameter.KEYWORD_ONLY}
}
def _type_to_str(tp: Any) -> str: # pragma: no cover
"""Convert type to normalized string."""
if tp is type(None):
return "None"
if isinstance(tp, type):
return tp.__name__
if isinstance(tp, str):
return tp
return (
str(tp)
.replace("collections.abc.", "")
.replace("collections.", "")
.replace("typing.", "")
.replace("pathlib.", "")
)
def _normalize_union_str(type_str: str) -> str:
"""Normalize a union type string by sorting its components recursively."""
try:
tree = ast.parse(type_str, mode="eval")
except SyntaxError: # pragma: no cover
return type_str
def normalize_node(node: ast.expr) -> str:
if isinstance(node, ast.BinOp) and isinstance(node.op, ast.BitOr):
def collect_union_parts(n: ast.expr) -> list[str]:
if isinstance(n, ast.BinOp) and isinstance(n.op, ast.BitOr):
return collect_union_parts(n.left) + collect_union_parts(n.right)
return [normalize_node(n)]
parts = collect_union_parts(node)
return " | ".join(sorted(parts))
if isinstance(node, ast.Subscript):
value = ast.unparse(node.value)
if isinstance(node.slice, ast.Tuple):
args = [normalize_node(elt) for elt in node.slice.elts]
return f"{value}[{', '.join(args)}]"
return f"{value}[{normalize_node(node.slice)}]"
return ast.unparse(node)
return normalize_node(tree.body)
@pytest.mark.parametrize(
("input_str", "expected"),
[
("str | int", "int | str"),
("str | int | None", "None | int | str"),
("int", "int"),
("Mapping[str, str]", "Mapping[str, str]"),
("Mapping[str, str | list[str]]", "Mapping[str, list[str] | str]"),
("Mapping[str, list[str] | str]", "Mapping[str, list[str] | str]"),
("Mapping[str, str | list[str]] | None", "Mapping[str, list[str] | str] | None"),
("dict[str, int | str | None]", "dict[str, None | int | str]"),
("list[str | int]", "list[int | str]"),
("tuple[str | int, bool | None]", "tuple[int | str, None | bool]"),
],
)
def test_normalize_union_str(input_str: str, expected: str) -> None:
"""Test _normalize_union_str correctly normalizes union types recursively."""
assert _normalize_union_str(input_str) == expected
@pytest.mark.parametrize(
("type_a", "type_b"),
[
("Mapping[str, str | list[str]]", "Mapping[str, list[str] | str]"),
("str | int | None", "None | str | int"),
("dict[str, int | str]", "dict[str, str | int]"),
],
)
def test_normalize_union_str_equivalence(type_a: str, type_b: str) -> None:
"""Test that different orderings of the same union type normalize to the same string."""
assert _normalize_union_str(type_a) == _normalize_union_str(type_b)
def _normalize_type(tp: Any) -> str: # noqa: PLR0911 # pragma: no cover
"""Normalize type for comparison between Config and TypedDict."""
if tp is None or tp is type(None):
return "None"
if isinstance(tp, str):
return _normalize_union_str(tp)
if isinstance(tp, ForwardRef):
arg = tp.__forward_arg__
if arg.startswith("NotRequired[") and arg.endswith("]"):
arg = arg[12:-1]
return _normalize_union_str(arg)
if isinstance(tp, list):
return f"[{', '.join(_normalize_type(t) for t in tp)}]"
origin = get_origin(tp)
args = get_args(tp)
if origin in {Annotated, NotRequired}:
return _normalize_type(args[0]) if args else _type_to_str(tp)
if origin is Union or isinstance(tp, types.UnionType):
if isinstance(tp, types.UnionType):
args = get_args(tp)
normalized_args = sorted(_normalize_type(a) for a in args)
return _type_to_str(" | ".join(normalized_args))
if origin is not None:
if args:
normalized_args = [_normalize_type(a) for a in args]
origin_name = getattr(origin, "__name__", str(origin))
return _type_to_str(f"{origin_name}[{', '.join(normalized_args)}]")
return _type_to_str(origin)
return _type_to_str(tp)
def _types_match(config_type: Any, dict_type: Any) -> bool:
"""Check if Config type and TypedDict type are equivalent."""
return _normalize_type(config_type) == _normalize_type(dict_type)
def test_generate_signature_matches_baseline() -> None:
"""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)
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
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():
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:
"""Ensure Parser.__init__ keeps backward compatibility via ParserConfigDict.
The new signature uses **options: Unpack[ParserConfigDict], so we verify
that ParserConfigDict 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 ParserConfigDict
expected = inspect.signature(_BaselineParser.__init__)
baseline_params = {k: v for k, v in _kwonly_by_name(expected).items() if k != "config"}
dict_annotations = ParserConfigDict.__annotations__
baseline_kwargs = set(baseline_params.keys())
dict_keys = set(dict_annotations.keys())
assert baseline_kwargs == dict_keys, (
f"Mismatch between baseline args and ParserConfigDict 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}"
)
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)}"
)
from datamodel_code_generator.config import ParserConfig
from datamodel_code_generator.model.base import DataModel, DataModelFieldBase
from datamodel_code_generator.model.pydantic_v2 import UnionMode
from datamodel_code_generator.types import DataTypeManager, StrictTypes
ParserConfig.model_rebuild(
_types_namespace={
"StrictTypes": StrictTypes,
"UnionMode": UnionMode,
"DataModel": DataModel,
"DataModelFieldBase": DataModelFieldBase,
"DataTypeManager": DataTypeManager,
}
)
for name, param in baseline_params.items():
config_default = ParserConfig.model_fields[name].default
if callable(param.default) and config_default is None:
continue
assert config_default == param.default, (
f"Default mismatch for '{name}':\n Baseline: {param.default!r}\n ParserConfig: {config_default!r}"
)
def test_generate_config_dict_fields_match_generate_config() -> None:
"""Ensure GenerateConfigDict has same field names as GenerateConfig."""
from datamodel_code_generator._types import GenerateConfigDict
from datamodel_code_generator.config import GenerateConfig
config_fields = set(GenerateConfig.model_fields.keys())
dict_fields = set(GenerateConfigDict.__annotations__.keys())
assert config_fields == dict_fields, f"Mismatch: {config_fields ^ dict_fields}"
def test_generate_config_dict_types_match_generate_config() -> None:
"""Ensure GenerateConfigDict field types match GenerateConfig."""
from datamodel_code_generator._types import GenerateConfigDict
from datamodel_code_generator.config import GenerateConfig
for field_name, field_info in GenerateConfig.model_fields.items():
config_type = field_info.annotation
dict_type = GenerateConfigDict.__annotations__[field_name]
assert _types_match(config_type, dict_type), (
f"Type mismatch for {field_name}: Config={_normalize_type(config_type)}, Dict={_normalize_type(dict_type)}"
)
def test_parser_config_dict_fields_match_parser_config() -> None:
"""Ensure ParserConfigDict has same field names as ParserConfig."""
from datamodel_code_generator._types import ParserConfigDict
from datamodel_code_generator.config import ParserConfig
config_fields = set(ParserConfig.model_fields.keys())
dict_fields = set(ParserConfigDict.__annotations__.keys())
assert config_fields == dict_fields, f"Mismatch: {config_fields ^ dict_fields}"
def test_parse_config_dict_fields_match_parse_config() -> None:
"""Ensure ParseConfigDict has same field names as ParseConfig."""
from datamodel_code_generator._types import ParseConfigDict
from datamodel_code_generator.config import ParseConfig
config_fields = set(ParseConfig.model_fields.keys())
dict_fields = set(ParseConfigDict.__annotations__.keys())
assert config_fields == dict_fields, f"Mismatch: {config_fields ^ dict_fields}"
def test_parser_config_dict_types_match_parser_config() -> None:
"""Ensure ParserConfigDict field types match ParserConfig."""
from datamodel_code_generator._types import ParserConfigDict
from datamodel_code_generator.config import ParserConfig
for field_name, field_info in ParserConfig.model_fields.items():
config_type = field_info.annotation
dict_type = ParserConfigDict.__annotations__[field_name]
assert _types_match(config_type, dict_type), (
f"Type mismatch for {field_name}: Config={_normalize_type(config_type)}, Dict={_normalize_type(dict_type)}"
)
def test_parse_config_dict_types_match_parse_config() -> None:
"""Ensure ParseConfigDict field types match ParseConfig."""
from datamodel_code_generator._types import ParseConfigDict
from datamodel_code_generator.config import ParseConfig
for field_name, field_info in ParseConfig.model_fields.items():
config_type = field_info.annotation
dict_type = ParseConfigDict.__annotations__[field_name]
assert _types_match(config_type, dict_type), (
f"Type mismatch for {field_name}: Config={_normalize_type(config_type)}, Dict={_normalize_type(dict_type)}"
)
def test_generate_config_defaults_match_generate_signature() -> None:
"""Ensure GenerateConfig default values match generate() signature defaults."""
from datamodel_code_generator.config import GenerateConfig
expected_sig = inspect.signature(_baseline_generate)
expected_params = _kwonly_by_name(expected_sig)
for field_name, field_info in GenerateConfig.model_fields.items():
param = expected_params[field_name]
config_default = field_info.default
assert config_default == param.default, (
f"Default mismatch for {field_name}: Config={config_default}, generate()={param.default}"
)
def test_parser_config_defaults_match_parser_signature() -> None:
"""Ensure ParserConfig default values match Parser.__init__ signature defaults."""
from datamodel_code_generator.config import ParserConfig
expected_sig = inspect.signature(_BaselineParser.__init__)
expected_params = _kwonly_by_name(expected_sig)
for field_name, field_info in ParserConfig.model_fields.items():
param = expected_params[field_name]
config_default = field_info.default
if callable(param.default) and config_default is None:
continue
assert config_default == param.default, (
f"Default mismatch for {field_name}: Config={config_default}, Parser.__init__()={param.default}"
)
def test_parse_config_defaults_match_parse_signature() -> None:
"""Ensure ParseConfig default values match Parser.parse() signature defaults."""
from datamodel_code_generator.config import ParseConfig
expected_sig = inspect.signature(_BaselineParser.parse)
expected_params = _params_by_name(expected_sig)
for field_name, field_info in ParseConfig.model_fields.items():
param = expected_params[field_name]
config_default = field_info.default
assert config_default == param.default, (
f"Default mismatch for {field_name}: Config={config_default}, Parser.parse()={param.default}"
)
def test_generate_with_config_produces_same_result_as_kwargs(tmp_path: Path) -> None:
"""Ensure generate() with GenerateConfig produces same result as kwargs."""
from datamodel_code_generator.config import GenerateConfig
from datamodel_code_generator.enums import DataModelType
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})
schema = '{"type": "object", "properties": {"name": {"type": "string"}}}'
output_kwargs = tmp_path / "output_kwargs.py"
output_config = tmp_path / "output_config.py"
# Generate with kwargs
generate(
input_=schema,
output=output_kwargs,
output_model_type=DataModelType.PydanticV2BaseModel,
)
# Generate with config
config = GenerateConfig(
output=output_config,
output_model_type=DataModelType.PydanticV2BaseModel,
)
generate(
input_=schema,
config=config,
)
# Compare results
kwargs_content = output_kwargs.read_text(encoding="utf-8")
config_content = output_config.read_text(encoding="utf-8")
assert kwargs_content == config_content, "Output differs between kwargs and config"
|