proj_flow.cli.argument

The proj_flow.cli.argument provides command-line builders and runners, supporting the functions decorated with @arg.command().

class proj_flow.cli.argument.Completer(*args, **kwargs)

class proj_flow.cli.argument.Action(*args, **kwargs)

completer: Completer

class proj_flow.cli.argument.Subparsers(*args, **kwargs)

parent: Parser

add_parser(**kwargs) → Parser

class proj_flow.cli.argument.Parser(**kwargs)

flow: FlowConfig

menu: List[Command]

shortcuts: Dict[str, List[str]]

add_subparsers(**kwargs) → Subparsers

find_and_run_command(args: Namespace)

proj_flow.cli.argument.build_argparser(flow_cfg: FlowConfig)

proj_flow.cli.argument.expand_shortcuts(parser: Parser, args: Namespace)

class proj_flow.cli.argument.AdditionalArgument(name: str, ctor: <built-in function callable>)

name: str

ctor: callable

create(rt: Runtime, args: Namespace, menu: Command)

class proj_flow.cli.argument.AnnotatedArgument(name: str, argument: proj_flow.api.arg.Argument)

name: str

argument: Argument

property group

argparse_visit(parser: _ActionsContainer)

class proj_flow.cli.argument.Command(name: str, doc: str, entry: <built-in function callable>, annotated: List[proj_flow.cli.argument.AnnotatedArgument], additional: List[proj_flow.cli.argument.AdditionalArgument], parent: ForwardRef('Command') | None, children: List[ForwardRef('Command')] = <factory>)

name: str

doc: str

entry: callable

annotated: List[AnnotatedArgument]

additional: List[AdditionalArgument]

parent: Command | None

children: List[Command]

argparse_visit(subparsers: Subparsers, alias: str | None = None, doc: str | None = None, level=0)

run(args: Namespace, rt: Runtime, level=0)

proj_flow.cli.argument.verbose_info(commands: List[Command], prefix='')