How to accept additional arguments

[FredrikNoren]

Hi,

I can't seem to find how to handle this; I'd like my subcommand to just accept all additional arguments into a List[str], something like:

class StartJobCommand(BaseSettings):
    module: str
    args: List[str]

    def cli_cmd(self) -> None:
        print("Starting job", self.module, self.args)

class ClusterCli(BaseSettings):
    start_job: CliSubCommand[StartJobCommand]
    def cli_cmd(self) -> None:
        CliApp.run_subcommand(self)

if __name__ == "__main__":
    CliApp.run(ClusterCli)

which I'd like to run with python -m cluster start_job testy --any extra --arguments here

[hramezani]

@kschwab Does pydantic-settings offer this?

[kschwab]

@FredrikNoren @hramezani currently we do not support this. We would need to add a new annotation or function that collects "unknown args". This would need to be used with the ignore_unknown_arguments setting. I don't think this is much to add, but will take a look.

[kschwab]

@hramezani @FredrikNoren opened #588 for resolution.

from pydantic import BaseModel

from pydantic_settings import BaseSettings, CliSubCommand, CliApp, CliUnknownArgs

class StartJobCommand(BaseModel):
    module: str
    args: CliUnknownArgs

    def cli_cmd(self) -> None:
        print('Starting job', self.module, self.args)

class ClusterCli(BaseSettings, cli_ignore_unknown_args=True):
    start_job: CliSubCommand[StartJobCommand]
    def cli_cmd(self) -> None:
        CliApp.run_subcommand(self)

if __name__ == '__main__':
    CliApp.run(ClusterCli)

"""
$ python -m cluster start_job --module testy --any extra --arguments here
Starting job testy ['--any', 'extra', '--arguments', 'here']
"""

[FredrikNoren]

@kschwab Nice! That's perfect :D