CLI autocomplete

[pycaw]

I don't see mention of autocomplete anywhere. Are there plans to implement this? Have you thought about integrating with existing libraries? Like argcomplete?

Autocomplete is important to me and I am 90% sure I want prompt-toolkit + its completers as part of REPL (I will write what's necessary to glue things to BaseModels). But, having a pydantic-enabled CLI parser with autocomplete has great potential as well.

[hramezani]

Thanks @pycaw for the issue.

pydantic-settings CLI doesn't have autocomplete integration. We don't have any plans to support it soon.

[mpkocher]

You can work around with by using shtab and a little bit of code.

https://github.com/iterative/shtab

from argparse import ArgumentParser
import shtab

from pydantic_settings import (
    BaseSettings,
    CliSettingsSource,
    PydanticBaseSettingsSource, CliApp,
)

parser = ArgumentParser()

class Settings(BaseSettings):
    alpha: int
    beta: float
    gamma: int = 1234

    @classmethod
    def settings_customise_sources(
            cls,
            settings_cls: type[BaseSettings],
            init_settings: PydanticBaseSettingsSource,
            env_settings: PydanticBaseSettingsSource,
            dotenv_settings: PydanticBaseSettingsSource,
            file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        return env_settings, CliSettingsSource(settings_cls, cli_parse_args=True, root_parser=parser)

    def cli_cmd(self) -> None:
        print(repr(self))



if __name__ == "__main__":
    shtab.add_argument_to(parser, ["--print-completion"])
    CliApp.run(Settings, cli_parse_args=True)

And to emit it:

python example_simple.py --print-completion zsh  >  /opt/homebrew/share/zsh/site-functions/example_simple_py

I don't think this would be too difficult to add to pydantic-settings.

[pycaw]

You can work around with by using shtab and a little bit of code.

https://github.com/iterative/shtab

from argparse import ArgumentParser
import shtab

from pydantic_settings import (
BaseSettings,
CliSettingsSource,
PydanticBaseSettingsSource, CliApp,
)

parser = ArgumentParser()

class Settings(BaseSettings):
alpha: int
beta: float
gamma: int = 1234

@classmethod
def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
) -> tuple[PydanticBaseSettingsSource, ...]:
    return env_settings, CliSettingsSource(settings_cls, cli_parse_args=True, root_parser=parser)

def cli_cmd(self) -> None:
    print(repr(self))

if name == "main":
shtab.add_argument_to(parser, ["--print-completion"])
CliApp.run(Settings, cli_parse_args=True)

And to emit it:

python example_simple.py --print-completion zsh > /opt/homebrew/share/zsh/site-functions/example_simple_py

I don't think this would be too difficult to add to pydantic-settings.

It's nice that it's so simple to set up and doesn't re-evaluate when pressing TAB. For fancier completions it's probably not the right tool. I think Literal["a", "b"] should translate to argparse's "choices" and then this tool should consider that but I didn't find that to be the case.