CLIParamInfo

class: CLIParamInfo

source

Since: 0.1.0

class CLIParamInfo(Entity):
    param_name: str
    type_annotation: str | None = None
    flags: list[str] = ...
    help: str | None = None
    default_repr: str | None = None
    required: bool = False
    envvar: str | None = None
    is_argument: bool = False
    hidden: bool = False
    choices: list[str] | None = None

CLI parameter metadata from typer OptionInfo/ArgumentInfo.

Fields

Field	Type	Default	Since
param_name	`str`	-	0.1.0
type_annotation	`str \| None`	-	0.1.0
flags	`list[str]`	`...`	0.1.0
help	`str \| None`	-	0.1.0
default_repr	`str \| None`	-	0.1.0
required	`bool`	`False`	0.1.0
envvar	`str \| None`	-	0.1.0
is_argument	`bool`	`False`	0.1.0
hidden	`bool`	`False`	0.1.0
choices	`list[str] \| None`	-	0.1.0

Changes

Version	Change
0.3.0	field 'type_annotation' default added: None
0.3.0	field 'default_repr' default added: None
0.3.0	field 'help' default added: None
0.3.0	field 'choices' default added: None
0.3.0	field 'envvar' default added: None
0.3.0	added base class 'Entity'
0.2.0	field 'param_name' default removed (was: PydanticUndefined)
0.1.0	Made public