Sharing Subparser Options in pydantic-cli

pydantic-cli-sharing-subparse-options.py

"""
Example of Using a Subparser

Demonstration of using two Pydantic data models to
build a subparser and sharing options.

The major friction point and limitation is the order in which the options appear in --help.

For example,

pydantic-cli-sharing-subparse-options.py alpha --help
pydantic-cli-sharing-subparse-options.py beta --help
"""
import sys
import logging
import typing as T
from pydantic import BaseModel, AnyUrl, Field

from pydantic_cli.examples import ExampleConfigDefaults, LogLevel, prologue_handler
from pydantic_cli import run_sp_and_exit, SubParser

log = logging.getLogger(__name__)


class BaseOptions(BaseModel):
    class Config:
        validate_assignment = True
        extra = 'forbid'

    gamma: float = Field(..., title="gamma", description="Gamma is a value", extras={"cli": ("-g", "--gamma")})
    epsilon: float = Field(1.234, title="epsilon", description="Epsilon is a value", extras={"cli": ("-e", "--epsilon")})


class AlphaOptions(BaseOptions):
    class Config(ExampleConfigDefaults):
        CLI_EXTRA_OPTIONS = {
            "max_records": ("-m", "--max-records"),
            "input_file": ("-i",),
        }
        CLI_JSON_ENABLE = True

    input_file: str
    max_records: int = 10
    log_level: LogLevel = LogLevel.DEBUG


class BetaOptions(BaseOptions):
    class Config(ExampleConfigDefaults):
        CLI_EXTRA_OPTIONS = {
            "url": ("-u", "--url"),
            "num_retries": ("-n", "--num-retries"),
            "input_file": ("-i",),
        }
        CLI_JSON_ENABLE = True

    url: AnyUrl
    num_retries: int = 3
    log_level: LogLevel = LogLevel.INFO


def to_func(sx):
    """ Util func to create to custom mocked funcs that be used be each subparser"""

    def example_runner(opts) -> int:
        print(f"Mock {sx} example running with {opts}")
        return 0

    return example_runner


def to_subparser_example() -> T.Dict[str, SubParser]:
    """Simply create a dict of SubParser and pass the dict
    to `run_sp_and_exit` or `to_runner_sp`
    """
    return {
        "alpha": SubParser[AlphaOptions](
            AlphaOptions, to_func("Alpha"), "Alpha SP Description"
        ),
        "beta": SubParser[BetaOptions](
            BetaOptions, to_func("Beta"), "Beta SP Description"
        ),
    }


if __name__ == "__main__":
    run_sp_and_exit(
        to_subparser_example(),
        description=__doc__,
        version="0.1.0",
        prologue_handler=prologue_handler,
    )