Merge branch 'master' into delete_optparse

# Conflicts:
#	cmd2.py

1 files changed, 145 insertions, 0 deletions

diff --git a/examples/help_categories.py b/examples/help_categories.py
new file mode 100755
index 00000000..e7e3373d
--- /dev/null
+++ b/examples/help_categories.py
@@ -0,0 +1,145 @@
+#!/usr/bin/env python
+# coding=utf-8
+"""
+A sample application for tagging categories on commands.
+"""
+
+from cmd2 import Cmd, categorize, __version__, with_argparser, with_category
+import argparse
+
+
+class HelpCategories(Cmd):
+    """ Example cmd2 application. """
+
+    # Command categories
+    CMD_CAT_CONNECTING = 'Connecting'
+    CMD_CAT_APP_MGMT = 'Application Management'
+    CMD_CAT_SERVER_INFO = 'Server Information'
+
+    def __init__(self):
+        # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
+        Cmd.__init__(self, use_ipython=False)
+
+    def do_connect(self, _):
+        """Connect command"""
+        self.poutput('Connect')
+
+    # Tag the above command functions under the category Connecting
+    categorize(do_connect, CMD_CAT_CONNECTING)
+
+    @with_category(CMD_CAT_CONNECTING)
+    def do_which(self, _):
+        """Which command"""
+        self.poutput('Which')
+
+    def do_list(self, _):
+        """List command"""
+        self.poutput('List')
+
+    def do_deploy(self, _):
+        """Deploy command"""
+        self.poutput('Which')
+
+    def do_start(self, _):
+        """Start command"""
+        self.poutput('Start')
+
+    def do_sessions(self, _):
+        """Sessions command"""
+        self.poutput('Sessions')
+
+    def do_redeploy(self, _):
+        """Redeploy command"""
+        self.poutput('Redeploy')
+
+    restart_parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
+    restart_parser.add_argument('when', default='now',
+                                choices=['now', 'later', 'sometime', 'whenever'],
+                                help='Specify when to restart')
+
+    @with_argparser(restart_parser)
+    @with_category(CMD_CAT_APP_MGMT)
+    def do_restart(self, _):
+        """Restart command"""
+        self.poutput('Restart')
+
+    def do_expire(self, _):
+        """Expire command"""
+        self.poutput('Expire')
+
+    def do_undeploy(self, _):
+        """Undeploy command"""
+        self.poutput('Undeploy')
+
+    def do_stop(self, _):
+        """Stop command"""
+        self.poutput('Stop')
+
+    def do_findleakers(self, _):
+        """Find Leakers command"""
+        self.poutput('Find Leakers')
+
+    # Tag the above command functions under the category Application Management
+    categorize((do_list,
+                do_deploy,
+                do_start,
+                do_sessions,
+                do_redeploy,
+                do_expire,
+                do_undeploy,
+                do_stop,
+                do_findleakers), CMD_CAT_APP_MGMT)
+
+    def do_resources(self, _):
+        """Resources command"""
+        self.poutput('Resources')
+
+    def do_status(self, _):
+        """Status command"""
+        self.poutput('Status')
+
+    def do_serverinfo(self, _):
+        """Server Info command"""
+        self.poutput('Server Info')
+
+    def do_thread_dump(self, _):
+        """Thread Dump command"""
+        self.poutput('Thread Dump')
+
+    def do_sslconnectorciphers(self, _):
+        """
+        SSL Connector Ciphers command is an example of a command that contains
+        multiple lines of help information for the user. Each line of help in a
+        contiguous set of lines will be printed and aligned in the verbose output
+        provided with 'help --verbose'
+
+        This is after a blank line and won't de displayed in the verbose help
+        """
+        self.poutput('SSL Connector Ciphers')
+
+    def do_vminfo(self, _):
+        """VM Info command"""
+        self.poutput('VM Info')
+
+    # Tag the above command functions under the category Server Information
+    categorize(do_resources, CMD_CAT_SERVER_INFO)
+    categorize(do_status, CMD_CAT_SERVER_INFO)
+    categorize(do_serverinfo, CMD_CAT_SERVER_INFO)
+    categorize(do_thread_dump, CMD_CAT_SERVER_INFO)
+    categorize(do_sslconnectorciphers, CMD_CAT_SERVER_INFO)
+    categorize(do_vminfo, CMD_CAT_SERVER_INFO)
+
+    # The following command functions don't have the HELP_CATEGORY attribute set
+    # and show up in the 'Other' group
+    def do_config(self, _):
+        """Config command"""
+        self.poutput('Config')
+
+    def do_version(self, _):
+        """Version command"""
+        self.poutput(__version__)
+
+
+if __name__ == '__main__':
+    c = HelpCategories()
+    c.cmdloop()