jgdv.cli.parser_model

Classes

CLIParserModel

# {prog} {args} {cmd} {cmd_args}

Module Contents

class jgdv.cli.parser_model.CLIParserModel[source]

# {prog} {args} {cmd} {cmd_args} # {prog} {args} [{task} {tasks_args}] - implicit do cmd

_cmd_at_front() → <Unknown>[source]

Return type:: bool

_has_help_flag_at_tail() → <Unknown>[source]

Return type:: bool

_has_more_args() → <Unknown>[source]

Return type:: bool

_has_no_specs() → <Unknown>[source]

Return type:: bool

_insert_implicit_cmd() → <Unknown>[source]

Return type:: None

_insert_implicit_sub() → <Unknown>[source]

Return type:: None

_kwarg_at_front() → <Unknown>[source]

See if theres a kwarg to parse

Return type:: bool

_no_cmd() → <Unknown>[source]

Return type:: bool

_no_sub() → <Unknown>[source]

Return type:: bool

_posarg_at_front() → <Unknown>[source]

Return type:: bool

_prep_cmd_lookup(cmds) → <Unknown>[source]

get the param specs for each cmd

Parameters:: cmds (list[jgdv.cli._interface.ParamSource_p])
Return type:: None

_prep_prog_lookup(prog) → <Unknown>[source]

Parameters:: prog (jgdv.cli._interface.ParamSource_p)
Return type:: None

_prep_sub_lookup(subs) → <Unknown>[source]

for each sub cmd, get it’s param specs, but also register the parent cmd constraint

Parameters:: subs (list[jgdv.cli._interface.ParamSource_p])
Return type:: None

_prog_at_front() → <Unknown>[source]

Return type:: bool

_separator_at_front() → <Unknown>[source]

Return type:: bool

_sub_at_front() → <Unknown>[source]

Return type:: bool

cleanup() → <Unknown>[source]

Return type:: None

clear_section() → <Unknown>[source]

Return type:: None

initialise_section() → <Unknown>[source]

Return type:: None

parse_kwarg() → <Unknown>[source]

try each param until one works

Return type:: None

parse_posarg() → <Unknown>[source]

Return type:: None

parse_separator() → <Unknown>[source]

Return type:: None

prepare_for_parse( *, prog, cmds, subs, raw_args, implicits=None, ) → <Unknown>[source]

Parameters:

prog (jgdv.cli._interface.ParamSource_p)
cmds (list)
subs (list)
raw_args (list[str])
implicits (jgdv.Maybe[dict[str, list[str]]])

Return type:

None

report() → <Unknown>[source]

Take the parsed results and return a nested dict

Return type:: jgdv.cli._interface.ParseReport_d

select_cmd_spec() → <Unknown>[source]

Return type:: None

select_prog_spec() → <Unknown>[source]

Return type:: None

select_sub_spec() → <Unknown>[source]

Return type:: None

set_force_help() → <Unknown>[source]

Return type:: None

CmdName: TypeAlias = str

SectionTypes: ClassVar[type[jgdv.cli._interface.SectionType_e]]

SubConstraint: TypeAlias = tuple[str, ...]

SubName: TypeAlias = str

Sub_Params: TypeAlias = tuple[SubConstraint, list[ParamSpec_i]]

_current_data: jgdv.Maybe[jgdv.cli._interface.ParseResult_d]

_current_section: jgdv.Maybe[tuple[str, list[jgdv.cli._interface.ParamSpec_i]]]

_force_help: bool

_help: jgdv.cli._interface.ParamSpec_i

_processor: jgdv.cli.param_spec.param_spec.ParamProcessor

_report: jgdv.Maybe[jgdv.cli._interface.ParseReport_d]

_section_type: jgdv.Maybe[jgdv.cli._interface.SectionType_e]

_separator: jgdv.cli._interface.ParamSpec_i

_subs_constraints: collections.defaultdict[CLIParserModel.CmdName, set[CLIParserModel.SubName]]

args_initial: tuple[str, Ellipsis]

args_remaining: list[str]

data_cmds: list[jgdv.cli._interface.ParseResult_d]

data_prog: jgdv.Maybe[jgdv.cli._interface.ParseResult_d]

data_subs: list[jgdv.cli._interface.ParseResult_d]

implicits: dict[str, list]

specs_cmds: dict[CLIParserModel.CmdName, list[jgdv.cli._interface.ParamSpec_i]]

specs_prog: list[jgdv.cli._interface.ParamSpec_i]

specs_prog_prefix: list[str]

specs_subs: dict[CLIParserModel.SubName, list[jgdv.cli._interface.ParamSpec_i]]