Add the ability to set the arguments for help

Simply set Manager.help_args to the appropriate list

Author: smurfix

docs/index.rst

@@ -146,8 +146,28 @@ The ``@option`` decorator is explained in more detail below.
 
 Help was previously available with **--help** and **-h**. This had a couple
 of less-than-ideal consequences, among them the inability to use **-h** as
-a shortcut for **--host**. If you want to restore the original meaning of
-**-h**, 
+a shortcut for **--host** or similar options.
+
+*New in version 2.0.2*
+
+If you want to restore the original meaning of **-h**, set your manager's
+``help_args`` attribute to a list of argument strings you want to be
+considered helpful.
+
+    manager = Manager()
+    manager.help_args = ('-h','-?','--help)
+
+You can override this list in sub-commands and -managers::
+
+    def talker(host='localhost'):
+        pass
+    ccmd = ConnectCmd(talker)
+    ccmd.help_args = ('-?','--help)
+    manager.add_command("connect", ccmd)
+    manager.run()
+
+so that **manager -h** prints help, while **manager connect -h fubar.example.com**
+connects to a remote host.
 
 Adding arguments to commands
 ----------------------------
@@ -351,8 +371,8 @@ Before version 2, options and command names could be interspersed freely.
 The author decided to discontinue this practice for a number of reasons;
 the problem with the most impact was that it was not possible to do
 
-	> python manage.py connect -d DEST
-	> python manage.py import -d DIR
+    > python manage.py connect -d DEST
+    > python manage.py import -d DIR
 
 as these options collided.
 

flask_script/__init__.py

@@ -34,8 +34,10 @@
 except ImportError:
     ARGCOMPLETE_IMPORTED = False
 
-def add_help(parser): 
-    parser.add_argument('-?', '--help',
+def add_help(parser, help_args): 
+    if not help_args:
+        return
+    parser.add_argument(*help_args,
                         action='help', default=argparse.SUPPRESS, help=_('show this help message and exit'))
 
 class Manager(object):
@@ -68,6 +70,7 @@ def run(self):
     :param disable_argcomplete: disable automatic loading of argcomplete.
 
     """
+    help_args = ('-?','--help')
 
     def __init__(self, app=None, with_default_commands=None, usage=None,
                  help=None, description=None, disable_argcomplete=False):
@@ -174,7 +177,7 @@ def create_parser(self, prog, func_stack=(), parent=None):
                                          description=self.description,
                                          parents=[options_parser],
                                          add_help=False)
-        add_help(parser)
+        add_help(parser, self.help_args)
 
         self._patch_argparser(parser)
 

flask_script/commands.py

@@ -97,7 +97,7 @@ class Command(object):
     """
 
     option_list = ()
-    add_help = True
+    help_args = None
 
     def __init__(self, func=None):
         if func is None:
@@ -163,13 +163,17 @@ def get_options(self):
         return self.option_list
 
     def create_parser(self, *args, **kwargs):
-
         func_stack = kwargs.pop('func_stack',())
         parent = kwargs.pop('parent',None)
         parser = argparse.ArgumentParser(*args, add_help=False, **kwargs)
-        if self.add_help:
+        help_args = self.help_args
+        while help_args is None and parent is not None:
+            help_args = parent.help_args
+            parent = getattr(parent,'parent',None)
+
+        if help_args:
             from flask_script import add_help
-            add_help(parser)
+            add_help(parser,help_args)
 
         for option in self.get_options():
             if isinstance(option, Group):

setup.py

@@ -27,7 +27,7 @@
 
 setup(
     name='Flask-Script',
-    version='2.0.1',
+    version='2.0.2',
     url='http://github.com/smurfix/flask-script',
     license='BSD',
     author='Dan Jacob',

tests.py

@@ -323,6 +323,30 @@ def hello(name='fred'):
         out, err = capsys.readouterr()
         assert 'Prints your name' in out
 
+    def test_no_help(self, capsys):
+        """
+        Tests that erasing --help really works.
+        """
+
+        manager = Manager(self.app)
+        manager.help_args = ()
+
+        @manager.command
+        def hello(name='fred'):
+            'Prints your name'
+            print('hello ' + name)
+        assert 'hello' in manager._commands
+
+        code = run('manage.py --help hello', manager.run)
+        out, err = capsys.readouterr()
+        print(out)
+        assert 'too many arguments' in err
+
+        code = run('manage.py hello --help', manager.run)
+        out, err = capsys.readouterr()
+        print(out)
+        assert 'too many arguments' in err
+
     def test_command_decorator_with_boolean_options(self, capsys):
 
         manager = Manager(self.app)