1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
"""A cmd2 script that saves the help text for every command, subcommand, and topic to a file.
This is meant to be run within a cmd2 session using run_pyscript.
"""
import argparse
import os
import sys
from typing import TextIO
ASTERISKS = "********************************************************"
def get_sub_commands(parser: argparse.ArgumentParser) -> list[str]:
"""Get a list of subcommands for an ArgumentParser."""
sub_cmds = []
# Check if this is parser has subcommands
if parser is not None and parser._subparsers is not None:
# Find the _SubParsersAction for the subcommands of this parser
for action in parser._subparsers._actions:
if isinstance(action, argparse._SubParsersAction):
for sub_cmd, sub_cmd_parser in action.choices.items():
sub_cmds.append(sub_cmd)
# Look for nested subcommands
sub_cmds.extend(f'{sub_cmd} {nested_sub_cmd}' for nested_sub_cmd in get_sub_commands(sub_cmd_parser))
break
sub_cmds.sort()
return sub_cmds
def add_help_to_file(item: str, outfile: TextIO, is_command: bool) -> None:
"""Write help text for commands and topics to the output file
:param item: what is having its help text saved
:param outfile: file being written to
:param is_command: tells if the item is a command and not just a help topic.
"""
label = "COMMAND" if is_command else "TOPIC"
header = f'{ASTERISKS}\n{label}: {item}\n{ASTERISKS}\n'
outfile.write(header)
result = app(f'help {item}')
outfile.write(result.stdout)
def main() -> None:
"""Main function of this script."""
# Make sure we have access to self
if 'self' not in globals():
print("Re-run this script from a cmd2 application where self_in_py is True")
return
# Make sure the user passed in an output file
if len(sys.argv) != 2:
print(f"Usage: {os.path.basename(sys.argv[0])} <output_file>")
return
# Open the output file
outfile_path = os.path.expanduser(sys.argv[1])
try:
with open(outfile_path, 'w') as outfile:
pass
except OSError as e:
print(f"Error opening {outfile_path} because: {e}")
return
# Write the help summary
header = f'{ASTERISKS}\nSUMMARY\n{ASTERISKS}\n'
outfile.write(header)
result = app('help -v')
outfile.write(result.stdout)
# Get a list of all commands and help topics and then filter out duplicates
all_commands = set(self.get_all_commands())
all_topics = set(self.get_help_topics())
to_save = list(all_commands | all_topics)
to_save.sort()
for item in to_save:
is_command = item in all_commands
add_help_to_file(item, outfile, is_command)
if is_command:
# Add any subcommands
for subcmd in get_sub_commands(getattr(self.cmd_func(item), 'argparser', None)):
full_cmd = f'{item} {subcmd}'
add_help_to_file(full_cmd, outfile, is_command)
outfile.close()
print(f"Output written to {outfile_path}")
# Run main function
main()
|
