feat: add new option --parent-scoped-naming to avoid name collisions (#2373)

Author: gjcarneiro

README.md

@@ -462,6 +462,8 @@ Model customization:
                         Choose Datetime class between AwareDatetime, NaiveDatetime or
                         datetime. Each output model has its default mapping (for example
                         pydantic: datetime, dataclass: str, ...)
+  --parent-scoped-naming
+                        Set name of models defined inline from the parent model
   --reuse-model         Reuse models on the field when a module has the model with the same
                         content
   --target-python-version {3.9,3.10,3.11,3.12,3.13}

docs/index.md

@@ -454,6 +454,8 @@ Model customization:
                         Choose Datetime class between AwareDatetime, NaiveDatetime or
                         datetime. Each output model has its default mapping (for example
                         pydantic: datetime, dataclass: str, ...)
+  --parent-scoped-naming
+                        Set name of models defined inline from the parent model
   --reuse-model         Reuse models on the field when a module has the model with the same
                         content
   --target-python-version {3.9,3.10,3.11,3.12,3.13}

src/datamodel_code_generator/__init__.py

@@ -287,6 +287,7 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
     keyword_only: bool = False,
     no_alias: bool = False,
     formatters: list[Formatter] = DEFAULT_FORMATTERS,
+    parent_scoped_naming: bool = False,
 ) -> None:
     remote_text_cache: DefaultPutDict[str, str] = DefaultPutDict()
     if isinstance(input_, str):
@@ -483,6 +484,7 @@ def get_header_and_first_line(csv_file: IO[str]) -> dict[str, Any]:
         no_alias=no_alias,
         formatters=formatters,
         encoding=encoding,
+        parent_scoped_naming=parent_scoped_naming,
         **kwargs,
     )
 

src/datamodel_code_generator/__main__.py

@@ -314,6 +314,7 @@ def validate_root(cls, values: Any) -> Any:  # noqa: N805
     keyword_only: bool = False
     no_alias: bool = False
     formatters: list[Formatter] = DEFAULT_FORMATTERS
+    parent_scoped_naming: bool = False
 
     def merge_args(self, args: Namespace) -> None:
         set_args = {f: getattr(args, f) for f in self.get_fields() if getattr(args, f) is not None}
@@ -525,6 +526,7 @@ def main(args: Sequence[str] | None = None) -> Exit:  # noqa: PLR0911, PLR0912,
             keyword_only=config.keyword_only,
             no_alias=config.no_alias,
             formatters=config.formatters,
+            parent_scoped_naming=config.parent_scoped_naming,
         )
     except InvalidClassNameError as e:
         print(f"{e} You have to set `--class-name` option", file=sys.stderr)  # noqa: T201

src/datamodel_code_generator/arguments.py

@@ -202,6 +202,12 @@ def start_section(self, heading: str | None) -> None:
     choices=[i.value for i in DatetimeClassType],
     default=None,
 )
+model_options.add_argument(
+    "--parent-scoped-naming",
+    help="Set name of models defined inline from the parent model",
+    action="store_true",
+    default=None,
+)
 
 # ======================================================================================
 # Typing options for generated models

src/datamodel_code_generator/parser/base.py

@@ -377,6 +377,7 @@ def __init__(  # noqa: PLR0913, PLR0915
         keyword_only: bool = False,
         no_alias: bool = False,
         formatters: list[Formatter] = DEFAULT_FORMATTERS,
+        parent_scoped_naming: bool = False,
     ) -> None:
         self.keyword_only = keyword_only
         self.data_type_manager: DataTypeManager = data_type_manager_type(
@@ -463,6 +464,7 @@ def __init__(  # noqa: PLR0913, PLR0915
             remove_special_field_name_prefix=remove_special_field_name_prefix,
             capitalise_enum_members=capitalise_enum_members,
             no_alias=no_alias,
+            parent_scoped_naming=parent_scoped_naming,
         )
         self.class_name: str | None = class_name
         self.wrap_string_literal: bool | None = wrap_string_literal

src/datamodel_code_generator/parser/graphql.py

@@ -154,6 +154,7 @@ def __init__(  # noqa: PLR0913
         keyword_only: bool = False,
         no_alias: bool = False,
         formatters: list[Formatter] = DEFAULT_FORMATTERS,
+        parent_scoped_naming: bool = False,
     ) -> None:
         super().__init__(
             source=source,
@@ -228,6 +229,7 @@ def __init__(  # noqa: PLR0913
             keyword_only=keyword_only,
             no_alias=no_alias,
             formatters=formatters,
+            parent_scoped_naming=parent_scoped_naming,
         )
 
         self.data_model_scalar_type = data_model_scalar_type

src/datamodel_code_generator/parser/jsonschema.py

@@ -423,6 +423,7 @@ def __init__(  # noqa: PLR0913
         keyword_only: bool = False,
         no_alias: bool = False,
         formatters: list[Formatter] = DEFAULT_FORMATTERS,
+        parent_scoped_naming: bool = False,
     ) -> None:
         super().__init__(
             source=source,
@@ -497,6 +498,7 @@ def __init__(  # noqa: PLR0913
             keyword_only=keyword_only,
             no_alias=no_alias,
             formatters=formatters,
+            parent_scoped_naming=parent_scoped_naming,
         )
 
         self.remote_object_cache: DefaultPutDict[str, dict[str, Any]] = DefaultPutDict()

src/datamodel_code_generator/parser/openapi.py

@@ -216,6 +216,7 @@ def __init__(  # noqa: PLR0913
         keyword_only: bool = False,
         no_alias: bool = False,
         formatters: list[Formatter] = DEFAULT_FORMATTERS,
+        parent_scoped_naming: bool = False,
     ) -> None:
         super().__init__(
             source=source,
@@ -290,6 +291,7 @@ def __init__(  # noqa: PLR0913
             keyword_only=keyword_only,
             no_alias=no_alias,
             formatters=formatters,
+            parent_scoped_naming=parent_scoped_naming,
         )
         self.open_api_scopes: list[OpenAPIScope] = openapi_scopes or [OpenAPIScope.Schemas]
 

src/datamodel_code_generator/reference.py

@@ -318,6 +318,7 @@ def __init__(  # noqa: PLR0913, PLR0917
         capitalise_enum_members: bool = False,  # noqa: FBT001, FBT002
         no_alias: bool = False,  # noqa: FBT001, FBT002
         remove_suffix_number: bool = False,  # noqa: FBT001, FBT002
+        parent_scoped_naming: bool = False,  # noqa: FBT001, FBT002
     ) -> None:
         self.references: dict[str, Reference] = {}
         self._current_root: Sequence[str] = []
@@ -351,6 +352,7 @@ def __init__(  # noqa: PLR0913, PLR0917
         self._base_path: Path = base_path or Path.cwd()
         self._current_base_path: Path | None = self._base_path
         self.remove_suffix_number: bool = remove_suffix_number
+        self.parent_scoped_naming = parent_scoped_naming
 
     @property
     def current_base_path(self) -> Path | None:
@@ -512,6 +514,19 @@ def add_ref(self, ref: str, resolved: bool = False) -> Reference:  # noqa: FBT00
         self.references[path] = reference
         return reference
 
+    def _check_parent_scope_option(self, name: str, path: Sequence[str]) -> str:
+        if self.parent_scoped_naming:
+            parent_reference = None
+            parent_path = path[:-1]
+            while parent_path:
+                parent_reference = self.references.get(self.join_path(parent_path))
+                if parent_reference is not None:
+                    break
+                parent_path = parent_path[:-1]
+            if parent_reference:
+                name = f"{parent_reference.name}_{name}"
+        return name
+
     def add(  # noqa: PLR0913
         self,
         path: Sequence[str],
@@ -533,6 +548,7 @@ def add(  # noqa: PLR0913
         name = original_name
         duplicate_name: str | None = None
         if class_name:
+            name = self._check_parent_scope_option(name, path)
             name, duplicate_name = self.get_class_name(
                 name=name,
                 unique=unique,

tests/data/expected/main/openapi/duplicate_models2.py

@@ -0,0 +1,42 @@
+# generated by datamodel-codegen:
+#   filename:  duplicate_models2.yaml
+#   timestamp: 2019-07-26T00:00:00+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class PetType(Enum):
+    pet = 'pet'
+
+
+class PetDetails(BaseModel):
+    race: Optional[str] = None
+
+
+class Pet(BaseModel):
+    id: int
+    name: str
+    tag: Optional[str] = None
+    type: PetType
+    details: Optional[PetDetails] = None
+
+
+class CarType(Enum):
+    car = 'car'
+
+
+class CarDetails(BaseModel):
+    brand: Optional[str] = None
+
+
+class Car(BaseModel):
+    id: int
+    name: str
+    tag: Optional[str] = None
+    type: CarType
+    details: Optional[CarDetails] = None

tests/data/openapi/duplicate_models2.yaml

@@ -0,0 +1,72 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: Get pet
+      operationId: getPets
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+  /cars:
+    get:
+      summary: Get car
+      operationId: getCar
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Cars"
+
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+        - type
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+        type:
+          type: string
+          enum: [ 'pet' ]
+        details:
+          type: object
+          properties:
+            race: { type: string }
+    Car:
+      required:
+        - id
+        - name
+        - type
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+        type:
+          type: string
+          enum: [ 'car' ]
+        details:
+          type: object
+          properties:
+            brand: { type: string }

tests/main/openapi/test_main_openapi.py

@@ -2570,6 +2570,28 @@ def test_main_openapi_referenced_default() -> None:
         assert output_file.read_text() == (EXPECTED_OPENAPI_PATH / "referenced_default.py").read_text()
 
 
+@freeze_time("2019-07-26")
+def test_duplicate_models() -> None:
+    with TemporaryDirectory() as output_dir:
+        output_file: Path = Path(output_dir) / "output.py"
+        return_code: Exit = main([
+            "--input",
+            str(OPEN_API_DATA_PATH / "duplicate_models2.yaml"),
+            "--output",
+            str(output_file),
+            "--use-operation-id-as-name",
+            "--openapi-scopes",
+            "paths",
+            "schemas",
+            "parameters",
+            "--output-model-type",
+            "pydantic_v2.BaseModel",
+            "--parent-scoped-naming",
+        ])
+        assert return_code == Exit.OK
+        assert output_file.read_text() == (EXPECTED_OPENAPI_PATH / "duplicate_models2.py").read_text()
+
+
 @freeze_time("2019-07-26")
 def test_main_openapi_shadowed_imports() -> None:
     with TemporaryDirectory() as output_dir: