From 479ffd377893c535f370cfb327ae59f2598d48c4 Mon Sep 17 00:00:00 2001 From: Koudai Aono Date: Fri, 2 Jan 2026 08:32:29 +0000 Subject: [PATCH] Clarify --aliases help text to explain schema field becomes Pydantic alias --- src/datamodel_code_generator/arguments.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/datamodel_code_generator/arguments.py b/src/datamodel_code_generator/arguments.py index 97c111ed0..f65e6d7e4 100644 --- a/src/datamodel_code_generator/arguments.py +++ b/src/datamodel_code_generator/arguments.py @@ -816,12 +816,13 @@ def start_section(self, heading: str | None) -> None: template_options.add_argument( "--aliases", help="Alias mapping file (JSON) for renaming fields. " + "Format: {'': ''} - the schema field name becomes the Pydantic alias. " "Supports hierarchical formats: " - "Flat: {'field': 'alias'} applies to all occurrences. " - "Scoped: {'ClassName.field': 'alias'} applies to specific class. " + "Flat: {'id': 'id_'} applies to all occurrences. " + "Scoped: {'User.name': 'user_name'} applies to specific class. " "Priority: scoped > flat. " - "Multiple aliases (Pydantic v2 only): {'field': ['alias1', 'alias2']} uses AliasChoices for validation. " - "Example: {'User.name': 'user_name', 'id': 'id_', 'field': ['my-field', 'my_field']}", + "Multiple aliases (Pydantic v2 only): {'field': ['alt1', 'alt2']} uses AliasChoices for validation. " + "Example: {'User.name': 'user_name', 'id': 'id_'} generates `id_: ... = Field(alias='id')`.", type=Path, ) template_options.add_argument(