Skip to content
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

Add CLI subcommand union and alias support #380

Merged
merged 15 commits into from
Sep 9, 2024
Merged

Add CLI subcommand union and alias support #380

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2e361a6
Initial commit.
kschwab Aug 2, 2024
8195867
Merge branch 'main' into cli-subcommand-union-support
kschwab Aug 5, 2024
6f600a9
Merge branch 'main' into cli-subcommand-union-and-alias-support
kschwab Aug 28, 2024
a6daf43
Updates.
kschwab Aug 28, 2024
9feb26d
Fix for pre-parsed args not tied to model.
Aug 30, 2024
45c1f69
Lint.
kschwab Sep 1, 2024
8d44304
Initial test case.
kschwab Sep 1, 2024
cc42d7e
Revert and bring this fix in separately.
kschwab Sep 2, 2024
c2fd129
Completed test cases.
kschwab Sep 2, 2024
050fb06
Merge branch 'main' into cli-subcommand-union-and-alias-support
kschwab Sep 3, 2024
bd011b4
Initial docs.
kschwab Sep 3, 2024
d2578d1
Use get_subcommand in docs.
kschwab Sep 3, 2024
700dbb2
Py 3.8 union fixes.
kschwab Sep 3, 2024
3b7c7f7
Nits.
kschwab Sep 8, 2024
76fd025
Merge branch 'main' into cli-subcommand-union-and-alias-support
kschwab Sep 8, 2024
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
Prev Previous commit
Next Next commit
Py 3.8 union fixes.
  • Loading branch information
@kschwab
kschwab committed Sep 3, 2024
commit 700dbb2a569ce2b897c2ab9cf7256fad6b6e226d
3 changes: 2 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -830,6 +830,7 @@ positional arguments, aliasing will change the CLI help text displayed for the f

```py
import sys
from typing import Union

from pydantic import BaseModel, Field

Expand Down Expand Up @@ -860,7 +861,7 @@ class Gamma(BaseModel):


class Root(BaseSettings, cli_parse_args=True, cli_exit_on_error=False):
subcommand: CliSubCommand[Alpha | Beta] = Field(alias='sub-command')
subcommand: CliSubCommand[Union[Alpha, Beta]] = Field(alias='sub-command')
gamma: CliSubCommand[Gamma] = Field(alias='gamma-cmd')


Expand Down
6 changes: 3 additions & 3 deletions tests/test_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3166,7 +3166,7 @@ class GammaCmd(BaseModel):
class Root1(BaseSettings):
"""Root Help"""

subcommand: CliSubCommand[AlphaCmd | BetaCmd | GammaCmd] = Field(description='Field Help')
subcommand: CliSubCommand[Union[AlphaCmd, BetaCmd, GammaCmd]] = Field(description='Field Help')

alpha = Root1(_cli_parse_args=['AlphaCmd', '-a=alpha'])
assert get_subcommand(alpha).model_dump() == {'a': 'alpha'}
Expand Down Expand Up @@ -3226,7 +3226,7 @@ class Root1(BaseSettings):
class Root2(BaseSettings):
"""Root Help"""

subcommand: CliSubCommand[AlphaCmd | GammaCmd] = Field(description='Field Help')
subcommand: CliSubCommand[Union[AlphaCmd, GammaCmd]] = Field(description='Field Help')
beta: CliSubCommand[BetaCmd] = Field(description='Field Beta Help')

alpha = Root2(_cli_parse_args=['AlphaCmd', '-a=alpha'])
Expand Down Expand Up @@ -3288,7 +3288,7 @@ class Root3(BaseSettings):
"""Root Help"""

beta: CliSubCommand[BetaCmd] = Field(description='Field Beta Help')
subcommand: CliSubCommand[AlphaCmd | GammaCmd] = Field(description='Field Help')
subcommand: CliSubCommand[Union[AlphaCmd, GammaCmd]] = Field(description='Field Help')

alpha = Root3(_cli_parse_args=['AlphaCmd', '-a=alpha'])
assert get_subcommand(alpha).model_dump() == {'a': 'alpha'}
Expand Down
Loading