Pydantic-settingsでCLIアプリケーションを作成できる話

"simple.py"

from enum import Enum
from typing import Literal

from pydantic import AliasChoices, Field
from pydantic_settings import BaseSettings, CliPositionalArg, SettingsConfigDict


class Animal(str, Enum):
    DOG = "dog"
    CAT = "cat"
    FISH = "fish"


class Cli(BaseSettings):
    """Pydantic Settingsで作るCLIのサンプル"""
    # ↑のようなDocstringを書くと、helpメッセージに表示される。

    # cli appであることを示すために必要
    model_config = SettingsConfigDict(cli_parse_args=True)

    # positional argを指定することができる。defaultは指定できない。
    arg: CliPositionalArg[str]

    # 特に何も指定しない場合、変数名がそのままオプション名になる
    name: str

    # AliasChoices を使うと、エイリアスを設定できる。この場合は、-a と --alias で指定できる。
    # descriptionを指定すると、helpメッセージに表示される。
    alias: str = Field(
        description="エイリアスが設定できる",
        validation_alias=AliasChoices("a", "alias"),
    )

    # Literal を使うと、指定できる値を制限できる (argparseでいうchoices)。
    # この場合、--mode には "train" か "test" しか指定できない。
    mode: Literal["train", "test"] = "train"

    # Enum でも、指定できる値を制限できる (argparseでいうchoices)。
    # この場合、--animal には "dog", "cat", "fish" しか指定できない。
    animal: Animal = Animal.DOG

    # listを使うことができる。ただし、以下のフォーマットしかサポートされておらず、whitespace区切りでは指定できない。
    # `--field='[1,2]'`, `--field 1 --field 2`, `--field=1,2`
    datasets: list[str] = []

    # dictを使える。以下の2通りが指定できる。
    # - json style: --field='{"k1": 1, "k2": 2}'
    # - key-value style: --field k1=1 --field k2=2
    config: dict[str, str] = {}


def main():
    settings = Cli()
    print(settings)


if __name__ == "__main__":
    main()

"subcommand.py"

from pydantic import AliasChoices, BaseModel, Field
from pydantic_settings import (
    BaseSettings,
    CliPositionalArg,
    CliSubCommand,
    SettingsConfigDict,
    get_subcommand,
)


class Add(BaseModel):
    path: CliPositionalArg[str]


class Commit(BaseModel):
    message: str = Field(validation_alias=AliasChoices("m", "message"))


class Git(BaseSettings):
    model_config = SettingsConfigDict(cli_parse_args=True)
    add: CliSubCommand[Add]
    commit: CliSubCommand[Commit]


def main():
    settings = Git()

    subcommand = get_subcommand(settings)

    if isinstance(subcommand, Add):
        print(f"add: {subcommand.path}")
    elif isinstance(subcommand, Commit):
        print(f"commit: {subcommand.message}")


if __name__ == "__main__":
    main()

"subcommand_app.py"

from pydantic import AliasChoices, BaseModel, Field
from pydantic_settings import (
    BaseSettings,
    CliPositionalArg,
    CliSubCommand,
    SettingsConfigDict,
    CliApp,
)


class Add(BaseModel):
    path: CliPositionalArg[str]

    def cli_cmd(self):
        print(f"add: {self.path}")


class Commit(BaseModel):
    message: str = Field(validation_alias=AliasChoices("m", "message"))

    def cli_cmd(self):
        print(f"commit: {self.message}")


class Git(BaseSettings):
    model_config = SettingsConfigDict(cli_parse_args=True)
    add: CliSubCommand[Add]
    commit: CliSubCommand[Commit]

    def cli_cmd(self):
        print("git command")
        CliApp.run_subcommand(self)


def main():
    settings = CliApp.run(Git)
    print(settings)


if __name__ == "__main__":
    main()