Set prog in argparser based on the name of the function

Author: kotfu

cmd2.py

@@ -260,13 +260,17 @@ def cmd_wrapper(instance, arg):
             opts = argparser.parse_args(lexed_arglist)
             func(instance, arg, opts)
 
+        # argparser defaults the program name to sys.argv[0]
+        # we want it to be the name of our command
+        argparser.prog = func.__name__[3:]
+
+        # put the help message in the method docstring
         funcdoc = func.__doc__
         if funcdoc:
             funcdoc += '\n'
         else:
             # if it's None, make it an empty string
             funcdoc = ''
-        
         cmd_wrapper.__doc__ = '{}{}'.format(funcdoc, argparser.format_help())
         return cmd_wrapper
     return arg_decorator

examples/argparse_example.py

@@ -67,10 +67,7 @@ def do_speak(self, rawarg, args=None):
     do_orate = do_speak  # another synonym, but this one takes multi-line input
 
 
-    argparser = argparse.ArgumentParser(
-      prog='tag',
-      description='create a html tag',
-    )
+    argparser = argparse.ArgumentParser(description='create a html tag')
     argparser.add_argument('tag', nargs=1, help='tag')
     argparser.add_argument('content', nargs='+', help='content to surround with tag')
     @with_argument_parser(argparser)

tests/test_argparse.py

@@ -13,9 +13,7 @@ def __init__(self):
         self.maxrepeats = 3
         cmd2.Cmd.__init__(self)
 
-    argparser = argparse.ArgumentParser(
-      prog='say',
-    )
+    argparser = argparse.ArgumentParser()
     argparser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
     argparser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')
     argparser.add_argument('-r', '--repeat', type=int, help='output [n] times')
@@ -37,10 +35,7 @@ def do_say(self, cmdline, args=None):
             self.stdout.write(' '.join(words))
             self.stdout.write('\n')
 
-    argparser = argparse.ArgumentParser(
-      prog='tag',
-      description='create a html tag'
-    )
+    argparser = argparse.ArgumentParser(description='create a html tag')
     argparser.add_argument('tag', nargs=1, help='tag')
     argparser.add_argument('content', nargs='+', help='content to surround with tag')
     @cmd2.with_argument_parser(argparser)
@@ -88,3 +83,9 @@ def test_argparse_help_docstring(argparse_app):
 def test_argparse_help_description(argparse_app):
     out = run_cmd(argparse_app, 'help tag')
     assert out[2] == 'create a html tag'
+
+def test_argparse_prog(argparse_app):
+    out = run_cmd(argparse_app, 'help tag')
+    progname = out[0].split(' ')[1]
+    assert progname == 'tag'
+