CLICommandDump

class: CLICommandDump

• source

  Since: 0.1.0

class CLICommandDump(SymbolDumpBase):
    name: str
    module_path: str
    docstring: str = ''
    line_number: int | None = None
    type: Literal[cli_command] = 'cli_command'
    signature: CallableSignature
    cli_params: list[CLIParamInfo] = ...

A typer CLI command with rich parameter metadata.

Fields

Field	Type	Default	Since
name	str	-	0.1.0
module_path	str	-	0.1.0
docstring	str	''	0.1.0
line_number	int | None	-	0.1.0
type	Literal[cli_command]	'cli_command'	0.1.0
signature	CallableSignature	-	0.1.0
cli_params	list[CLIParamInfo]	...	0.1.0

Changes

Version	Change
0.3.0	field 'line_number' default added: None
0.3.0	added base class 'SymbolDumpBase'
0.2.0	field 'module_path' default removed (was: PydanticUndefined)
0.2.0	field 'signature' default removed (was: PydanticUndefined)
0.2.0	field 'name' default removed (was: PydanticUndefined)
0.1.0	Made public