• Search by Module
• Search by Words
• Search Projects

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

• cmd2-master
  • .coveragerc
  • examples
    • argparse_completion.py
    • plumbum_colors.py
    • unicode_commands.py
    • arg_print.py
    • decorator_example.py
    • basic.py
    • exit_code.py
    • async_printing.py
    • table_creation.py
    • help_categories.py
    • paged_output.py
    • hooks.py
    • alias_startup.py
    • hello_cmd2.py
    • event_loops.py
    • override_parser.py
    • custom_parser.py
    • arg_decorators.py
    • subcommands.py
    • migrating.py
    • remove_settable.py
    • example.py
    • remove_builtin_commands.py
    • initialization.py
    • cmd_as_argument.py
    • basic_completion.py
    • persistent_history.py
    • first_app.py
    • transcripts
      • exampleSession.txt
      • transcript_regex.txt
      • pirate.transcript
      • quit.txt
    • scripts
      • nested.txt
      • script.py
      • quit.txt
      • script.txt
      • save_help_text.py
      • conditional.py
      • arg_printer.py
    • python_scripting.py
    • dynamic_commands.py
    • pirate.py
    • .cmd2rc
    • colors.py
    • environment.py
  • LICENSE
  • Pipfile
  • azure-pipelines.yml
  • CONTRIBUTING.md
  • tasks.py
  • CHANGELOG.md
  • .appveyor.yml
  • setup.py
  • cmd2
    • table_creator.py
    • decorators.py
    • history.py
    • exceptions.py
    • parsing.py
    • cmd2.py
    • transcript.py
    • argparse_custom.py
    • ansi.py
    • py_bridge.py
    • rl_utils.py
    • argparse_completer.py
    • constants.py
    • __init__.py
    • utils.py
    • plugin.py
    • clipboard.py
  • setup.cfg
  • .travis.yml
  • README.md
  • tests
    • test_utils.py
    • test_cmd2.py
    • test_argparse_custom.py
    • test_transcript.py
    • test_ansi.py
    • script.py
    • test_history.py
    • pyscript
      • pyscript_dir.py
      • stop.py
      • raises_exception.py
      • help.py
      • echo.py
      • stdout_capture.py
      • recursive.py
      • environment.py
    • test_completion.py
    • test_table_creator.py
    • test_argparse_completer.py
    • relative_multiple.txt
    • test_argparse.py
    • __init__.py
    • script.txt
    • transcripts
      • multiline_no_regex.txt
      • dotstar.txt
      • multiline_regex.txt
      • spaces.txt
      • characterclass.txt
      • failure.txt
      • bol_eol.txt
      • no_output_last.txt
      • regex_set.txt
      • slashslash.txt
      • singleslash.txt
      • word_boundaries.txt
      • slashes_escaped.txt
      • extension_notation.txt
      • no_output.txt
      • from_cmdloop.txt
    • scripts
      • empty.txt
      • nested.txt
      • precmds.txt
      • one_down.txt
      • postcmds.txt
      • help.txt
      • utf8.txt
    • test_plugin.py
    • test_run_pyscript.py
    • .cmd2rc
    • conftest.py
    • test_parsing.py
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • .gitignore
  • docs
    • Makefile
    • make.bat
    • examples
      • first_app.rst
      • alternate_event_loops.rst
      • index.rst
    • api
      • history.rst
      • py_bridge.rst
      • exceptions.rst
      • constants.rst
      • decorators.rst
      • argparse_completer.rst
      • plugin.rst
      • table_creator.rst
      • utils.rst
      • ansi.rst
      • argparse_custom.rst
      • index.rst
      • parsing.rst
      • cmd.rst
    • plugins
      • external_test.rst
      • index.rst
    • doc_conventions.rst
    • overview
      • alternatives.rst
      • summary.rst
      • integrating.rst
      • index.rst
      • installation.rst
      • resources.rst
    • features
      • history.rst
      • completion.rst
      • generating_output.rst
      • hooks.rst
      • commands.rst
      • os.rst
      • disable_commands.rst
      • scripting.rst
      • embedded_python_shells.rst
      • clipboard.rst
      • initialization.rst
      • help.rst
      • plugins.rst
      • shortcuts_aliases_macros.rst
      • table_creation.rst
      • redirection.rst
      • packaging.rst
      • builtin_commands.rst
      • misc.rst
      • settings.rst
      • index.rst
      • argument_processing.rst
      • transcripts.rst
      • prompt.rst
      • startup_commands.rst
      • multiline_commands.rst
    • migrating
      • why.rst
      • next_steps.rst
      • minimum.rst
      • incompatibilities.rst
      • summary.rst
      • index.rst
    • index.rst
    • conf.py
    • .gitignore
  • MANIFEST.in
  • tox.ini

# coding=utf-8
# flake8: noqa F821
"""
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 List, 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
                    for nested_sub_cmd in get_sub_commands(sub_cmd_parser):
                        sub_cmds.append('{} {}'.format(sub_cmd, nested_sub_cmd))

                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
    """
    if is_command:
        label = "COMMAND"
    else:
        label = "TOPIC"

    header = '{}\n{}: {}\n{}\n'.format(ASTERISKS, label, item, ASTERISKS)
    outfile.write(header)

    result = app('help {}'.format(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("Usage: {} <output_file>".format(os.path.basename(sys.argv[0])))
        return

    # Open the output file
    outfile_path = os.path.expanduser(sys.argv[1])
    try:
        outfile = open(outfile_path, 'w')
    except OSError as e:
        print("Error opening {} because: {}".format(outfile_path, e))
        return

    # Write the help summary
    header = '{0}\nSUMMARY\n{0}\n'.format(ASTERISKS)
    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 = '{} {}'.format(item, subcmd)
                add_help_to_file(full_cmd, outfile, is_command)

    outfile.close()
    print("Output written to {}".format(outfile_path))


# Run main function
main()