config_dir=os.path.join('~', '.{}'.format(cli_name)),
config_env_var_prefix=cli_name,
commands_loader_cls=VstsCommandsLoader,
help_cls=VstsCLIHelp)
loader = vstscli.commands_loader_cls()
loader.__init__(vstscli)
cmd_table = loader.load_command_table([])
for command in loader.command_table:
loader.load_arguments(command)
vstsclihelp = vstscli.help_cls(cli_ctx=vstscli)
global_parser = vstscli.parser_cls.create_global_parser(cli_ctx=vstscli)
parser = vstscli.parser_cls(cli_ctx=vstscli,
prog=vstscli.name,
parents=[global_parser])
parser.load_command_table(cmd_table)
cmd_list = cmd_table.keys()
results = {}
for cmd_name in cmd_list:
cmd_args = cmd_table[cmd_name].arguments
args = []
for arg in cmd_args:
args.append(arg)
results[cmd_name] = args
print(json.dumps(results, indent=1))
def make_rst(self):
INDENT = ' '
DOUBLEINDENT = INDENT * 2
parser_keys = []
parser_values = []
sub_parser_keys = []
sub_parser_values = []
# similar to what the Application object provides for in "az"
cli_name = "vsts"
vstscli = CLI(cli_name=cli_name,
config_dir=os.path.join('~', '.{}'.format(cli_name)),
config_env_var_prefix=cli_name,
commands_loader_cls=VstsCommandsLoader,
help_cls=VstsCLIHelp)
loader = vstscli.commands_loader_cls()
loader.__init__(vstscli)
loader.load_command_table([])
for command in loader.command_table:
loader.load_arguments(command)
vstsclihelp = vstscli.help_cls(cli_ctx=vstscli)
global_parser = vstscli.parser_cls.create_global_parser(
cli_ctx=vstscli)
parser = vstscli.parser_cls(cli_ctx=vstscli,
prog=vstscli.name,
parents=[global_parser])
parser.load_command_table(loader.command_table)
_store_parsers(parser, parser_keys, parser_values, sub_parser_keys,
sub_parser_values)
for cmd, parser in zip(parser_keys, parser_values):
if cmd not in sub_parser_keys:
sub_parser_keys.append(cmd)
sub_parser_values.append(parser)
doc_source_map = _load_doc_source_map()
help_files = []
for cmd, parser in zip(sub_parser_keys, sub_parser_values):
try:
help_file = _help.GroupHelpFile(cmd, parser) if _is_group(
parser) else _help.CommandHelpFile(cmd, parser)
help_file.load(parser)
help_files.append(help_file)
except Exception as ex:
print("Skipped '{}' due to '{}'".format(cmd, ex))
help_files = sorted(help_files, key=lambda x: x.command)
for help_file in help_files:
is_command = isinstance(help_file, _help.CommandHelpFile)
yield '.. cli{}:: {}'.format(
'command' if is_command else 'group',
help_file.command if help_file.command else
'vsts') #it is top level group vsts if command is empty
yield ''
yield '{}:summary: {}'.format(INDENT, help_file.short_summary)
yield '{}:description: {}'.format(INDENT, help_file.long_summary)
if not is_command:
top_group_name = help_file.command.split(
)[0] if help_file.command else 'vsts'
yield '{}:docsource: {}'.format(
INDENT, doc_source_map[top_group_name]
if top_group_name in doc_source_map else '')
else:
top_command_name = help_file.command.split(
)[0] if help_file.command else ''
if top_command_name in doc_source_map:
yield '{}:docsource: {}'.format(
INDENT, doc_source_map[top_command_name])
yield ''
if is_command and help_file.parameters:
group_registry = _help.ArgumentGroupRegistry([
p.group_name for p in help_file.parameters if p.group_name
])
for arg in sorted(
help_file.parameters,
key=lambda p: group_registry.get_group_priority(
p.group_name) + str(not p.required) + p.name):
yield '{}.. cliarg:: {}'.format(INDENT, arg.name)
yield ''
yield '{}:required: {}'.format(DOUBLEINDENT, arg.required)
short_summary = arg.short_summary or ''
possible_values_index = short_summary.find(
' Possible values include')
short_summary = short_summary[
0:possible_values_index
if possible_values_index >= 0 else len(short_summary)]
short_summary = short_summary.strip()
yield '{}:summary: {}'.format(DOUBLEINDENT, short_summary)
yield '{}:description: {}'.format(DOUBLEINDENT,
arg.long_summary)
if arg.choices:
yield '{}:values: {}'.format(
DOUBLEINDENT,
', '.join(sorted([str(x) for x in arg.choices])))
if arg.default and arg.default != argparse.SUPPRESS:
yield '{}:default: {}'.format(DOUBLEINDENT,
arg.default)
if arg.value_sources:
yield '{}:source: {}'.format(
DOUBLEINDENT, ', '.join(arg.value_sources))
yield ''
yield ''
if len(help_file.examples) > 0:
for e in help_file.examples:
yield '{}.. cliexample:: {}'.format(INDENT, e.name)
yield ''
yield DOUBLEINDENT + e.text
yield ''