More incompatible changes:

* command.handle() is now simply command()
* short help is '-?'. '-h' is used for --host too often.
* Server options '-d' and '-r' are no longer toggles for debugging/reloading.
  Instead, '-d' forces debugging on and '-D' forces it off,
  no matter what the default said.
* The command.prompt_* compatibility methods have beeen removed.
  (They were already heavily deprecated.)

Author: smurfix

flask_script/__init__.py

@@ -6,6 +6,7 @@
 import sys
 import types
 import warnings
+from gettext import gettext as _
 
 import argparse
 
@@ -33,6 +34,9 @@
 except ImportError:
     ARGCOMPLETE_IMPORTED = False
 
+def add_help(parser): 
+    parser.add_argument('-?', '--help',
+                        action='help', default=argparse.SUPPRESS, help=_('show this help message and exit'))
 
 class Manager(object):
     """
@@ -163,7 +167,9 @@ def create_parser(self, prog, func_stack=(), parents=None):
 
         parser = argparse.ArgumentParser(prog=prog, usage=self.usage,
                                          description=self.description,
-                                         parents=[options_parser])
+                                         parents=[options_parser],
+                                         add_help=False)
+        add_help(parser)
 
         self._patch_argparser(parser)
 
@@ -178,7 +184,8 @@ def create_parser(self, prog, func_stack=(), parents=None):
 
             subparser = subparsers.add_parser(name, usage=usage, help=help,
                                               description=description,
-                                              parents=[command_parser], add_help=False)
+                                              parents=[command_parser],
+                                              add_help=False)
 
             if isinstance(command, Manager):
                 self._patch_argparser(subparser)

flask_script/commands.py

@@ -165,7 +165,10 @@ def get_options(self):
     def create_parser(self, *args, **kwargs):
 
         func_stack = kwargs.pop('func_stack',())
-        parser = argparse.ArgumentParser(*args, add_help=self.add_help, **kwargs)
+        parser = argparse.ArgumentParser(*args, add_help=False, **kwargs)
+        if self.add_help:
+            from flask_script import add_help
+            add_help(parser)
 
         for option in self.get_options():
             if isinstance(option, Group):
@@ -190,17 +193,8 @@ def create_parser(self, *args, **kwargs):
 
     def __call__(self, app=None, *args, **kwargs):
         """
-        Compatibility code so that we can pass outselves to argparse
-        as `func_handle`, above.
-        The call to handle() is not replaced, so older code can still
-        override it.
-        """
-        return self.handle(app, *args, **kwargs)
-
-    def handle(self, app, *args, **kwargs):
-        """
-        Handles the command with given app. Default behaviour is to call within
-        a test request context.
+        Handles the command with the given app.
+        Default behaviour is to call ``self.run`` within a test request context.
         """
         with app.test_request_context():
             return self.run(*args, **kwargs)
@@ -212,34 +206,6 @@ def run(self):
         """
         raise NotImplementedError
 
-    def prompt(self, name, default=None):
-        warnings.warn_explicit(
-            "Command.prompt is deprecated, use prompt() function instead")
-
-        prompt(name, default)
-
-    def prompt_pass(self, name, default=None):
-        warnings.warn_explicit(
-            "Command.prompt_pass is deprecated, use prompt_pass() function "
-            "instead")
-
-        prompt_pass(name, default)
-
-    def prompt_bool(self, name, default=False):
-        warnings.warn_explicit(
-            "Command.prompt_bool is deprecated, use prompt_bool() function "
-            "instead")
-
-        prompt_bool(name, default)
-
-    def prompt_choices(self, name, choices, default=None):
-        warnings.warn_explicit(
-            "Command.choices is deprecated, use prompt_choices() function "
-            "instead")
-
-        prompt_choices(name, choices, default)
-
-
 class Shell(Command):
     """
     Runs a Python shell inside Flask application context.
@@ -365,7 +331,7 @@ def __init__(self, host='127.0.0.1', port=5000, use_debugger=True,
     def get_options(self):
 
         options = (
-            Option('-t', '--host',
+            Option('-h', '--host',
                    dest='host',
                    default=self.host),
 
@@ -391,7 +357,11 @@ def get_options(self):
         )
 
         if self.use_debugger:
-            options += (Option('-d', '--no-debug',
+            options += (Option('-d', '--debug',
+                               action='store_true',
+                               dest='use_debugger',
+                               help="(no-op for compatibility)"),)
+            options += (Option('-D', '--no-debug',
                                action='store_false',
                                dest='use_debugger',
                                default=self.use_debugger),)
@@ -401,9 +371,17 @@ def get_options(self):
                                action='store_true',
                                dest='use_debugger',
                                default=self.use_debugger),)
+            options += (Option('-D', '--no-debug',
+                               action='store_false',
+                               dest='use_debugger',
+                               help="(no-op for compatibility)"),)
 
         if self.use_reloader:
-            options += (Option('-r', '--no-reload',
+            options += (Option('-r', '--reload',
+                               action='store_true',
+                               dest='use_reloader',
+                               help="(no-op for compatibility)"),)
+            options += (Option('-R', '--no-reload',
                                action='store_false',
                                dest='use_reloader',
                                default=self.use_reloader),)
@@ -413,10 +391,14 @@ def get_options(self):
                                action='store_true',
                                dest='use_reloader',
                                default=self.use_reloader),)
+            options += (Option('-R', '--no-reload',
+                               action='store_false',
+                               dest='use_reloader',
+                               help="(no-op for compatibility)"),)
 
         return options
 
-    def handle(self, app, host, port, use_debugger, use_reloader,
+    def __call__(self, app, host, port, use_debugger, use_reloader,
                threaded, processes, passthrough_errors):
         # we don't need to run the server in request context
         # so just run it directly
@@ -514,3 +496,5 @@ def run(self, url, order):
 
         for row in rows:
             print(str_template % row[:column_length])
+
+

tests.py

@@ -315,7 +315,7 @@ def hello(name='fred'):
         out, err = capsys.readouterr()
         assert 'hello joe' in out
 
-        code = run('manage.py hello -h', manager.run)
+        code = run('manage.py hello -?', manager.run)
         out, err = capsys.readouterr()
         assert 'Prints your name' in out
 
@@ -346,7 +346,7 @@ def verify(verified=False):
         out, err = capsys.readouterr()
         assert 'NO' in out
 
-        code = run('manage.py verify -h', manager.run)
+        code = run('manage.py verify -?', manager.run)
         out, err = capsys.readouterr()
         assert 'Checks if verified' in out
 
@@ -387,7 +387,7 @@ def hello(name):
         out, err = capsys.readouterr()
         assert 'hello joe' in out
 
-        code = run('manage.py hello -h', manager.run)
+        code = run('manage.py hello -?', manager.run)
         out, err = capsys.readouterr()
         assert 'Your name' in out
 
@@ -741,7 +741,7 @@ def test_manager_usage_with_submanager(self, capsys):
         manager = Manager(self.app)
         manager.add_command('sub_manager', sub_manager)
 
-        code = run('manage.py -h', manager.run)
+        code = run('manage.py -?', manager.run)
         out, err = capsys.readouterr()
         assert code == 0
         assert 'Example sub-manager' in out
@@ -756,7 +756,7 @@ def test_submanager_usage_and_help_and_description(self, capsys):
         manager = Manager(self.app)
         manager.add_command('sub_manager', sub_manager)
 
-        code = run('manage.py -h', manager.run)
+        code = run('manage.py -?', manager.run)
         out, err = capsys.readouterr()
         assert code == 0
         assert 'sub_manager [--foo]' not in out
@@ -771,18 +771,18 @@ def test_submanager_usage_and_help_and_description(self, capsys):
         assert 'longer desc for submanager' in out
         assert 'simple command' in out
 
-        code = run('manage.py sub_manager -h', manager.run)
+        code = run('manage.py sub_manager -?', manager.run)
         out, err = capsys.readouterr()
         assert code == 0
         assert 'sub_manager [--foo]' in out
         assert 'shorter desc for submanager' not in out
         assert 'longer desc for submanager' in out
         assert 'simple command' in out
 
-        code = run('manage.py sub_manager simple -h', manager.run)
+        code = run('manage.py sub_manager simple -?', manager.run)
         out, err = capsys.readouterr()
         assert code == 0
-        assert 'sub_manager [--foo] simple [-h]' in out
+        assert 'sub_manager [--foo] simple [-?]' in out
         assert 'simple command' in out
 
     def test_submanager_has_no_default_commands(self):