Type reference sources

Author: koxudaxi

src/datamodel_code_generator/reference.py

@@ -43,7 +43,7 @@
 
     import inflect
 
-    from datamodel_code_generator.model.base import DataModel
+    from datamodel_code_generator.model.base import DataModel, DataModelFieldBase
     from datamodel_code_generator.types import DataType
 
 
@@ -77,6 +77,32 @@ def reference(self) -> Reference | None:
         ...
 
 
+if TYPE_CHECKING:
+
+    class _ReferenceSource(Protocol):
+        """Protocol for objects that can be assigned to Reference.source."""
+
+        fields: list[DataModelFieldBase]
+
+        @property
+        def is_alias(self) -> bool:
+            """Return whether this source renders as an alias."""
+            ...
+
+        @property
+        def module_name(self) -> str | None:
+            """Return this source module name."""
+            ...
+
+        @property
+        def nullable(self) -> bool:
+            """Return whether this source is nullable."""
+            ...
+
+else:
+    _ReferenceSource = ReferenceChild
+
+
 class _BaseModel(BaseModel):
     """Base model with field exclusion and pass-through support."""
 
@@ -124,7 +150,7 @@ class Reference(_BaseModel):
     name: str
     duplicate_name: Optional[str] = None  # noqa: UP045
     loaded: bool = True
-    source: Optional[ReferenceChild] = None  # noqa: UP045
+    source: Optional[_ReferenceSource] = None  # noqa: UP045
     children: list[ReferenceChild] = Field(default_factory=list)
     _exclude_fields: ClassVar[set[str]] = {"children"}