Skip to content

fix: preserve field aliases #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: preserve field aliases #120

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
770215a
fix: preserve field aliases
hugohonda Sep 26, 2025
10fcb86
use explicit alias parameter to fix mypy
hugohonda Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions agentic_doc/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,17 @@ def create_metadata_model(model: type[BaseModel]) -> type[BaseModel]:
"""
Recursively creates a new Pydantic model from an existing one,
replacing all leaf-level field types with MetadataType.
Preserves field aliases to maintain compatibility with API responses.
"""
fields: Dict[str, Any] = {}
for name, field in model.model_fields.items():
field_type = field.annotation

origin = get_origin(field_type)

# Preserve the original field's alias if it exists
alias = field.alias if field.alias else None

# Handle Optional/Union types
if origin is Union:
args = get_args(field_type)
Expand All @@ -101,11 +105,14 @@ def create_metadata_model(model: type[BaseModel]) -> type[BaseModel]:
non_none_type, BaseModel
):
metadata_type = create_metadata_model(non_none_type)
fields[name] = (Optional[metadata_type], Field(default=None))
fields[name] = (
Optional[metadata_type],
Field(default=None, alias=alias),
)
else:
fields[name] = (
Optional[MetadataType[non_none_type]], # type: ignore[valid-type]
Field(default=None),
Field(default=None, alias=alias),
)
continue

Expand All @@ -116,23 +123,23 @@ def create_metadata_model(model: type[BaseModel]) -> type[BaseModel]:
metadata_inner_type = create_metadata_model(inner_type)
fields[name] = (
List[metadata_inner_type], # type: ignore[valid-type]
Field(default_factory=list), # type: ignore[arg-type]
Field(default_factory=list, alias=alias), # type: ignore[arg-type]
)
else:
fields[name] = (
List[MetadataType[inner_type]], # type: ignore[valid-type]
Field(default_factory=list), # type: ignore[arg-type]
Field(default_factory=list, alias=alias), # type: ignore[arg-type]
)
continue

# Handle nested models
if inspect.isclass(field_type) and issubclass(field_type, BaseModel):
fields[name] = (create_metadata_model(field_type), Field())
fields[name] = (create_metadata_model(field_type), Field(alias=alias))
else:
# Replace primitive leaf with MetadataType[original type]
fields[name] = (
MetadataType[field_type], # type: ignore[valid-type]
Field(),
Field(alias=alias),
)

return create_model(f"{model.__name__}Metadata", **fields)
Expand Down