Command_Builder Module

cli_command_parser.conversion.command_builder.convert_script(script: Script, add_methods: bool = False) → str

class cli_command_parser.conversion.command_builder.Converter(ast_obj: AC | Script, parent: Converter | None = None)

Bases: Generic[AC], ABC

converts: Type[AC] = None

newline_between_members: bool = False

classmethod __init_subclass__(converts: Type[AC] = None, newline_between_members: bool = None, **kwargs)

classmethod for_ast_callable(ast_obj: AC | Type[AC]) → Type[Converter[AC]]

classmethod init_for_ast_callable(ast_obj: AC, *args, **kwargs) → Converter[AC]

classmethod init_group(parent: CollectionConverter, ast_objs: list[AC]) → ConverterGroup[C]

convert(indent: int = 0) → str

abstract format_lines(indent: int = 0) → Iterator[str]

class cli_command_parser.conversion.command_builder.ConverterGroup(parent: CollectionConverter, member_type: Type[C], members: list[C])

Bases: Generic[C]

parent

member_type

members

format_all(indent: int = 0) → Iterator[str]

class cli_command_parser.conversion.command_builder.ScriptConverter(*args, add_methods: bool = False, **kwargs)

Bases: Converter

format_lines(indent: int = 0) → Iterator[str]

converts

alias of Script

class cli_command_parser.conversion.command_builder.CollectionConverter(ast_obj: AC | Script, parent: Converter | None = None)

Bases: Converter[AC], ABC

ast_obj: ArgCollection

parent: CollectionConverter | None

property name_mode: str | None

property grouped_children: list[ConverterGroup[ParamConverter | GroupConverter | Converter]]

descendant_args() → Iterator[ParamConverter]

format_members(prefix: str, indent: int = 4) → Iterator[str]

finalize(had_members: bool, prefix: str, indent: int = 4)

class cli_command_parser.conversion.command_builder.ParserConverter(parser: AstArgumentParser, parent: ParserConverter = None, counter: count = None, *, add_methods: bool = False)

Bases: CollectionConverter[AstArgumentParser]

ast_obj: AstArgumentParser

parent: ParserConverter | None

property sub_parser_converters: list[ParserConverter]

descendant_args() → Iterator[ParamConverter]

format_lines(indent: int = 0) → Iterator[str]

finalize(had_members: bool, prefix: str, indent: int = 4)

property is_sub_parser: bool

property name: str

property name_mode: str | None

converts

alias of AstArgumentParser

class cli_command_parser.conversion.command_builder.GroupConverter(ast_obj: AC | Script, parent: Converter | None = None)

Bases: CollectionConverter[ArgGroup]

ast_obj: ArgGroup

format_lines(indent: int = 4) → Iterator[str]

converts

alias of ArgGroup

newline_between_members: bool = True

class cli_command_parser.conversion.command_builder.ParamConverter(arg: ParserArg, parent: CollectionConverter, num: int)

Bases: Converter[ParserArg]

ast_obj: ParserArg

parent: CollectionConverter | None

classmethod init_group(parent: CollectionConverter, args: list[ParserArg]) → ParamConverterGroup

format_lines(indent: int = 4) → Iterator[str]

format(indent: int = 4) → str

property attr_name: str

property name_mode: str | None

property cmd_option_strs: list[str]

property use_auto_long_opt_str: bool

get_pos_args() → Iterable[str]

get_cls_and_kwargs() → tuple[str, BaseArgs]

property is_pass_thru: bool

property is_positional: bool

property is_option: bool

converts

alias of ParserArg

class cli_command_parser.conversion.command_builder.ParamConverterGroup(parent: CollectionConverter, member_type: Type[C], members: list[C])

Bases: ConverterGroup[ParamConverter]

format_all(indent: int = 4) → Iterator[str]

class cli_command_parser.conversion.command_builder.BaseArgs(help: 'OptStr' = None)

Bases: object

help: OptStr = None

to_str(*args: str) → str

classmethod from_kwargs(**kwargs)

class cli_command_parser.conversion.command_builder.CommandArgs(help: 'OptStr' = None, choice: 'OptStr' = None, choices: 'OptStr' = None, prog: 'OptStr' = None, usage: 'OptStr' = None, description: 'OptStr' = None, epilog: 'OptStr' = None, option_name_mode: 'OptStr' = None, add_help: 'OptStr' = None, docs_url: 'OptStr' = None, email: 'OptStr' = None)

Bases: BaseArgs

choice: OptStr = None

choices: OptStr = None

prog: OptStr = None

usage: OptStr = None

description: OptStr = None

epilog: OptStr = None

option_name_mode: OptStr = None

add_help: OptStr = None

docs_url: OptStr = None

email: OptStr = None

class cli_command_parser.conversion.command_builder.ParamBaseArgs(help: 'OptStr' = None, name: 'OptStr' = None, default: 'OptStr' = None, required: 'OptStr' = None, metavar: 'OptStr' = None, hide: 'OptStr' = None)

Bases: BaseArgs

name: OptStr = None

default: OptStr = None

required: OptStr = None

metavar: OptStr = None

hide: OptStr = None

to_str(*args: str) → str

class cli_command_parser.conversion.command_builder.PassThruArgs(help: 'OptStr' = None, name: 'OptStr' = None, default: 'OptStr' = None, required: 'OptStr' = None, metavar: 'OptStr' = None, hide: 'OptStr' = None)

Bases: ParamBaseArgs

class cli_command_parser.conversion.command_builder.ParamArgs(help: 'OptStr' = None, name: 'OptStr' = None, default: 'OptStr' = None, required: 'OptStr' = None, metavar: 'OptStr' = None, hide: 'OptStr' = None, action: 'OptStr' = None, type: 'OptStr' = None, nargs: 'OptStr' = None, choices: 'OptStr' = None)

Bases: ParamBaseArgs

action: OptStr = None

type: OptStr = None

nargs: OptStr = None

choices: OptStr = None

classmethod init_positional(action: OptStr = None, nargs: OptStr = None, **kwargs)

class cli_command_parser.conversion.command_builder.OptionArgs(help: 'OptStr' = None, name: 'OptStr' = None, default: 'OptStr' = None, required: 'OptStr' = None, metavar: 'OptStr' = None, hide: 'OptStr' = None, action: 'OptStr' = None, type: 'OptStr' = None, nargs: 'OptStr' = None, choices: 'OptStr' = None, name_mode: 'OptStr' = None)

Bases: ParamArgs

name_mode: OptStr = None

classmethod init_option(arg: ParserArg, action: OptStr = None, nargs: OptStr = None, const: OptStr = None, **kwargs)

class cli_command_parser.conversion.command_builder.FlagArgs(help: 'OptStr' = None, name: 'OptStr' = None, default: 'OptStr' = None, required: 'OptStr' = None, metavar: 'OptStr' = None, hide: 'OptStr' = None, action: 'OptStr' = None, type: 'OptStr' = None, nargs: 'OptStr' = None, choices: 'OptStr' = None, name_mode: 'OptStr' = None, const: 'OptStr' = None)

Bases: OptionArgs

const: OptStr = None

classmethod init_flag(action: str, const: OptStr = None, default: OptStr = None, **kwargs)

classmethod init_counter(const: OptStr = None, default: OptStr = None, **kwargs)

cli_command_parser.conversion.command_builder.literal_eval_or_none(expr: str) → str | None

exception cli_command_parser.conversion.command_builder.ConversionError

Bases: Exception