Add --all-exports-scope and --all-exports-collision-strategy options for recursive exports (#2588)

* Add support for all exports scope and collision strategy in __init__.py generation

* Add support for recursive all exports scope in __init__.py generation

* Add support for recursive all exports scope with collision error handling

* Add support for all exports scope with no child exports handling

Author: koxudaxi

README.md

@@ -443,6 +443,15 @@ Field customization:
                         docstring
 
 Model customization:
+  --all-exports-collision-strategy {error,minimal-prefix,full-prefix}
+                        Strategy for name collisions when using --all-exports-
+                        scope=recursive. ''error'': raise an error (default). ''minimal-
+                        prefix'': add module prefix only to colliding names. ''full-prefix'':
+                        add full module path prefix to colliding names.
+  --all-exports-scope {children,recursive}
+                        Generate __all__ in __init__.py with re-exports. ''children'': export
+                        from direct child modules only. ''recursive'': export from all
+                        descendant modules.
   --allow-extra-fields  Deprecated: Allow passing extra fields. This flag is deprecated. Use
                         `--extra-fields=allow` instead.
   --allow-population-by-field-name
@@ -490,8 +499,6 @@ Model customization:
                         target python version
   --treat-dot-as-module
                         treat dotted module names as modules
-  --use-all-exports     Generate __all__ = [...] in __init__.py to export all defined models
-                        and types
   --use-exact-imports   import exact types instead of modules, for example: "from .foo
                         import Bar" instead of "from . import foo" with "foo.Bar"
   --use-pendulum        use pendulum instead of datetime

docs/index.md

@@ -435,6 +435,15 @@ Field customization:
                         docstring
 
 Model customization:
+  --all-exports-collision-strategy {error,minimal-prefix,full-prefix}
+                        Strategy for name collisions when using --all-exports-
+                        scope=recursive. ''error'': raise an error (default). ''minimal-
+                        prefix'': add module prefix only to colliding names. ''full-prefix'':
+                        add full module path prefix to colliding names.
+  --all-exports-scope {children,recursive}
+                        Generate __all__ in __init__.py with re-exports. ''children'': export
+                        from direct child modules only. ''recursive'': export from all
+                        descendant modules.
   --allow-extra-fields  Deprecated: Allow passing extra fields. This flag is deprecated. Use
                         `--extra-fields=allow` instead.
   --allow-population-by-field-name
@@ -482,8 +491,6 @@ Model customization:
                         target python version
   --treat-dot-as-module
                         treat dotted module names as modules
-  --use-all-exports     Generate __all__ = [...] in __init__.py to export all defined models
-                        and types
   --use-exact-imports   import exact types instead of modules, for example: "from .foo
                         import Bar" instead of "from . import foo" with "foo.Bar"
   --use-pendulum        use pendulum instead of datetime

src/datamodel_code_generator/__init__.py

@@ -246,6 +246,30 @@ class OpenAPIScope(Enum):
     Webhooks = "webhooks"
 
 
+class AllExportsScope(Enum):
+    """Scope for __all__ exports in __init__.py.
+
+    children: Export models from direct child modules only.
+    recursive: Export models from all descendant modules recursively.
+    """
+
+    Children = "children"
+    Recursive = "recursive"
+
+
+class AllExportsCollisionStrategy(Enum):
+    """Strategy for handling name collisions in recursive exports.
+
+    error: Raise an error when name collision is detected.
+    minimal_prefix: Add module prefix only to colliding names.
+    full_prefix: Add full module path prefix to all colliding names.
+    """
+
+    Error = "error"
+    MinimalPrefix = "minimal-prefix"
+    FullPrefix = "full-prefix"
+
+
 class GraphQLScope(Enum):
     """Scopes for GraphQL model generation."""
 
@@ -375,7 +399,8 @@ def generate(  # noqa: PLR0912, PLR0913, PLR0914, PLR0915
     dataclass_arguments: DataclassArguments | None = None,
     disable_future_imports: bool = False,
     type_mappings: list[str] | None = None,
-    use_all_exports: bool = False,
+    all_exports_scope: AllExportsScope | None = None,
+    all_exports_collision_strategy: AllExportsCollisionStrategy | None = None,
 ) -> None:
     """Generate Python data models from schema definitions or structured data.
 
@@ -613,7 +638,11 @@ def get_header_and_first_line(csv_file: IO[str]) -> dict[str, Any]:
     )
 
     with chdir(output):
-        results = parser.parse(disable_future_imports=disable_future_imports, use_all_exports=use_all_exports)
+        results = parser.parse(
+            disable_future_imports=disable_future_imports,
+            all_exports_scope=all_exports_scope,
+            all_exports_collision_strategy=all_exports_collision_strategy,
+        )
     if not input_filename:  # pragma: no cover
         if isinstance(input_, str):
             input_filename = "<stdin>"
@@ -704,6 +733,8 @@ def infer_input_type(text: str) -> InputFileType:
 __all__ = [
     "MAX_VERSION",
     "MIN_VERSION",
+    "AllExportsCollisionStrategy",
+    "AllExportsScope",
     "DatetimeClassType",
     "DefaultPutDict",
     "Error",

src/datamodel_code_generator/__main__.py

@@ -22,6 +22,8 @@
 
 from datamodel_code_generator import (
     DEFAULT_SHARED_MODULE_NAME,
+    AllExportsCollisionStrategy,
+    AllExportsScope,
     DataclassArguments,
     DataModelType,
     Error,
@@ -241,6 +243,10 @@ def validate_custom_formatters(cls, values: dict[str, Any]) -> dict[str, Any]:
         f"`--keyword-only` requires `--target-python-version` {PythonVersion.PY_310.value} or higher."
     )
 
+    __validate_all_exports_collision_strategy_err: ClassVar[str] = (
+        "`--all-exports-collision-strategy` can only be used with `--all-exports-scope=recursive`."
+    )
+
     if PYDANTIC_V2:
 
         @model_validator()  # pyright: ignore[reportArgumentType]
@@ -289,6 +295,13 @@ def validate_root(self: Self) -> Self:  # pyright: ignore[reportRedeclaration]
                 self.field_constraints = True
             return self
 
+        @model_validator()  # pyright: ignore[reportArgumentType]
+        def validate_all_exports_collision_strategy(self: Self) -> Self:  # pyright: ignore[reportRedeclaration]
+            """Validate all_exports_collision_strategy requires recursive scope."""
+            if self.all_exports_collision_strategy is not None and self.all_exports_scope != AllExportsScope.Recursive:
+                raise Error(self.__validate_all_exports_collision_strategy_err)
+            return self
+
     else:
 
         @model_validator()  # pyright: ignore[reportArgumentType]
@@ -337,6 +350,16 @@ def validate_root(cls, values: dict[str, Any]) -> dict[str, Any]:  # noqa: N805
                 values["field_constraints"] = True
             return values
 
+        @model_validator()  # pyright: ignore[reportArgumentType]
+        def validate_all_exports_collision_strategy(cls, values: dict[str, Any]) -> dict[str, Any]:  # noqa: N805
+            """Validate all_exports_collision_strategy requires recursive scope."""
+            if (
+                values.get("all_exports_collision_strategy") is not None
+                and values.get("all_exports_scope") != AllExportsScope.Recursive
+            ):
+                raise Error(cls.__validate_all_exports_collision_strategy_err)
+            return values
+
     input: Optional[Union[Path, str]] = None  # noqa: UP007, UP045
     input_file_type: InputFileType = InputFileType.Auto
     output_model_type: DataModelType = DataModelType.PydanticBaseModel
@@ -425,7 +448,8 @@ def validate_root(cls, values: dict[str, Any]) -> dict[str, Any]:  # noqa: N805
     parent_scoped_naming: bool = False
     disable_future_imports: bool = False
     type_mappings: Optional[list[str]] = None  # noqa: UP045
-    use_all_exports: bool = False
+    all_exports_scope: Optional[AllExportsScope] = None  # noqa: UP045
+    all_exports_collision_strategy: Optional[AllExportsCollisionStrategy] = None  # noqa: UP045
 
     def merge_args(self, args: Namespace) -> None:
         """Merge command-line arguments into config."""
@@ -827,7 +851,8 @@ def main(args: Sequence[str] | None = None) -> Exit:  # noqa: PLR0911, PLR0912,
             dataclass_arguments=config.dataclass_arguments,
             disable_future_imports=config.disable_future_imports,
             type_mappings=config.type_mappings,
-            use_all_exports=config.use_all_exports,
+            all_exports_scope=config.all_exports_scope,
+            all_exports_collision_strategy=config.all_exports_collision_strategy,
         )
     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

@@ -16,6 +16,8 @@
 
 from datamodel_code_generator import (
     DEFAULT_SHARED_MODULE_NAME,
+    AllExportsCollisionStrategy,
+    AllExportsScope,
     DataclassArguments,
     DataModelType,
     InputFileType,
@@ -294,9 +296,20 @@ def start_section(self, heading: str | None) -> None:
     default=None,
 )
 model_options.add_argument(
-    "--use-all-exports",
-    help="Generate __all__ = [...] in __init__.py to export all defined models and types",
-    action="store_true",
+    "--all-exports-scope",
+    help="Generate __all__ in __init__.py with re-exports. "
+    "'children': export from direct child modules only. "
+    "'recursive': export from all descendant modules.",
+    choices=[s.value for s in AllExportsScope],
+    default=None,
+)
+model_options.add_argument(
+    "--all-exports-collision-strategy",
+    help="Strategy for name collisions when using --all-exports-scope=recursive. "
+    "'error': raise an error (default). "
+    "'minimal-prefix': add module prefix only to colliding names. "
+    "'full-prefix': add full module path prefix to colliding names.",
+    choices=[s.value for s in AllExportsCollisionStrategy],
     default=None,
 )