pydantic-settings CLI

pydantic_cli.py

from pydantic import Field, FilePath
from pydantic_settings import BaseSettings, CliApp, SettingsConfigDict, SettingsError


class CLISettings(
    BaseSettings,
):
    # model config
    model_config = SettingsConfigDict(
        cli_parse_args=True,
        cli_enforce_required=True,
        cli_exit_on_error=False,
    )

    # parameters
    input_file: FilePath
    output_file: FilePath | None = None
    tricky_param: str = Field(description="This is description of tricky parameter")


def main():
    try:
        args = CliApp.run(CLISettings)
    except SettingsError as e:
        print(e)
    else:
        print(args)


if __name__ == "__main__":
    main()

Example of how to use pydantic as replacement of argparse
keywords: pydantic, python, argparse, settings, configuration, environment variables, cli, pydantic-cli, pydantic-argparse