Skip to content

Bugfix for cli_kebab_case="all" and CliImplicitFlag[bool] #702

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 4 commits into from
Nov 25, 2025
Merged

Bugfix for cli_kebab_case="all" and CliImplicitFlag[bool] #702

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8bb58e
fix cli_kebab_case=all with implicit flags
Digity101 Nov 6, 2025
91c583f
Merge branch 'main' into cli-kebab-case-implicit-flag
hramezani Nov 7, 2025
2d7c7eb
update conditional check for cli_kebab_case
Digity101 Nov 25, 2025
61f39cd
Merge branch 'main' into cli-kebab-case-implicit-flag
hramezani Nov 25, 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
2 changes: 2 additions & 0 deletions pydantic_settings/sources/providers/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,8 @@ def _resolve_parsed_args(self, parsed_args: dict[str, list[str] | str]) -> list[
elif field_name.endswith(':subcommand') and val is not None:
selected_subcommands.append(self._parser_map[field_name][val].dest)
elif self.cli_kebab_case == 'all':
if isinstance(val, bool):
Copy link
Contributor

@kschwab kschwab Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of making it specific to bool, can you update to exclude above on str. e.g.

elif self.cli_kebab_case == 'all' and isinstance(val, str):

All of the logic in this case assumes val is str. Thanks for the catch 👍🏾

Copy link
Contributor Author

@Digity101 Digity101 Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change is indeed better. When I wrote the bug fix, I didn't pay much attention to possible types of val and took the easy way out.

continue
snake_val = val.replace('-', '_')
cli_arg = self._parser_map.get(field_name, {}).get(None)
if (
Expand Down
16 changes: 16 additions & 0 deletions tests/test_source_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2606,6 +2606,22 @@ class SettingsAll(BaseSettings):
CliApp.run(SettingsAll, cli_args=['--example', 'example_a', '--mybool=true'])


def test_cli_kebab_case_all_with_implicit_flag():
class Settings(BaseSettings):
model_config = SettingsConfigDict(cli_kebab_case='all')
test_bool_flag: CliImplicitFlag[bool]

assert CliApp.run(
Settings,
cli_args=['--test-bool-flag'],
).model_dump() == {'test_bool_flag': True}

assert CliApp.run(
Settings,
cli_args=['--no-test-bool-flag'],
).model_dump() == {'test_bool_flag': False}


def test_cli_with_unbalanced_brackets_in_json_string():
class StrToStrDictOptions(BaseSettings):
nested: dict[str, str]
Expand Down