Skip to content

Fix CLI suppression for model group help #604

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

Merged
merged 2 commits into from
Apr 21, 2025
Merged

Fix CLI suppression for model group help #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2142a9
CLI suppress model group help.
kschwab Apr 21, 2025
927ef0b
Test nested default descriptions.
kschwab Apr 21, 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
4 changes: 3 additions & 1 deletion pydantic_settings/sources/providers/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -923,11 +923,13 @@ def _add_parser_submodels(

preferred_alias = alias_names[0]
is_model_suppressed = self._is_field_suppressed(field_info) or is_model_suppressed
if is_model_suppressed:
model_group_kwargs['description'] = CLI_SUPPRESS
if not self.cli_avoid_json:
added_args.append(arg_names[0])
kwargs['nargs'] = '?'
kwargs['const'] = '{}'
kwargs['help'] = kwargs['help'] = (
kwargs['help'] = (
CLI_SUPPRESS if is_model_suppressed else f'set {arg_names[0]} from JSON string (default: {{}})'
)
model_group = self._add_group(parser, **model_group_kwargs)
Expand Down
8 changes: 4 additions & 4 deletions tests/test_source_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2159,17 +2159,17 @@ class DeepHiddenSubModel(BaseModel):
class HiddenSubModel(BaseModel):
hidden_a: int
hidden_b: int
deep_hidden_obj: DeepHiddenSubModel
deep_hidden_obj: DeepHiddenSubModel = Field(description='deep_hidden_obj description')

class SubModel(BaseModel):
visible_a: int
visible_b: int
deep_hidden_obj: CliSuppress[DeepHiddenSubModel]
deep_hidden_obj: CliSuppress[DeepHiddenSubModel] = Field(description='deep_hidden_obj description')

class Settings(BaseSettings, cli_parse_args=True):
field_a: CliSuppress[int] = 0
field_b: str = Field(default=1, description=CLI_SUPPRESS)
hidden_obj: CliSuppress[HiddenSubModel]
field_b: str = Field(default='hi', description=CLI_SUPPRESS)
hidden_obj: CliSuppress[HiddenSubModel] = Field(description='hidden_obj description')
visible_obj: SubModel

with monkeypatch.context() as m:
Expand Down