GitHub

ShowHelp

API reference for ShowHelp.

Show the help of command_path, with errors when parsing failed. Exits with 1 when there are errors, else 0; never reported by run_main.

Attributes

AttributeTypeDescription
command_pathtuple[str, ...]
errorstuple[ParseError, ...] = field(default=())
tagLiteral['ShowHelp'] = 'ShowHelp'
error_reportedbool = field(default=False, init=False, repr=False, compare=False)
messagestr

Functions

__init__

__init__(command_path, errors=()) -> None
ParameterTypeDescription
command_pathtuple[str, ...]
errorstuple[ParseError, ...] = ()