Extract parameter help from docstrings

examples/manage.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # PYTHON_ARGCOMPLETE_OK
 
+from __future__ import print_function
 import pprint
 
 from flask import Flask, current_app
@@ -11,7 +12,7 @@
 def create_app(config=None):
     app = Flask(__name__)
     app.debug = False
-    print "CONFIG", config
+    print("CONFIG", config)
 
     app.config.from_envvar('APP_CONFIG', silent=True)
 
@@ -34,14 +35,14 @@ def dumpconfig():
 @manager.command
 def output(name):
     "print something"
-    print name
-    print type(name)
+    print(name)
+    print(type(name))
 
 
 @manager.command
 def outputplus(name, url=None):
     "print name and url"
-    print name, url
+    print(name, url)
 
 
 @manager.command
@@ -50,7 +51,7 @@ def getrolesimple():
     choices = ("member", "moderator", "admin")
 
     role = prompt_choices("role", choices=choices, default="member")
-    print "ROLE:", role
+    print("ROLE:", role)
 
 
 @manager.command
@@ -63,14 +64,14 @@ def getrole():
     )
 
     role = prompt_choices("role", choices=choices, resolve=int, default=1)
-    print "ROLE:", role
+    print("ROLE:", role)
 
 
 @manager.option('-n', '--name', dest='name', help="your name")
 @manager.option('-u', '--url', dest='url', help="your url")
 def optional(name, url):
     "print name and url"
-    print name, url
+    print(name, url)
 
 manager.add_option("-c", "--config",
                    dest="config",

flask_script/__init__.py

@@ -29,19 +29,21 @@
                 argparse._AppendConstAction,
                 argparse._CountAction)
 
-
 try:
     import argcomplete
+
     ARGCOMPLETE_IMPORTED = True
 except ImportError:
     ARGCOMPLETE_IMPORTED = False
 
-def add_help(parser, help_args): 
+
+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):
     """
     Controller class for handling a set of commands.
@@ -72,13 +74,13 @@ def run(self):
     :param disable_argcomplete: disable automatic loading of argcomplete.
 
     """
-    help_args = ('-?','--help')
+    help_args = ('-?', '--help')
 
     def __init__(self, app=None, with_default_commands=None, usage=None,
                  help=None, description=None, disable_argcomplete=False):
 
         self.app = app
-        
+
         self.subparser_kwargs = dict()
 
         self._commands = OrderedDict()
@@ -162,15 +164,15 @@ def __call__(self, app=None, **kwargs):
 
     def create_app(self, *args, **kwargs):
         warnings.warn("create_app() is deprecated; use __call__().", warnings.DeprecationWarning)
-        return self(*args,**kwargs)
+        return self(*args, **kwargs)
 
     def create_parser(self, prog, func_stack=(), parent=None):
         """
         Creates an ArgumentParser instance from options returned
         by get_options(), and subparser for the given commands.
         """
         prog = os.path.basename(prog)
-        func_stack=func_stack+(self,)
+        func_stack += (self,)
 
         options_parser = argparse.ArgumentParser(add_help=False)
         for option in self.get_options():
@@ -233,7 +235,7 @@ def _parse_known_args(self, arg_strings, *args, **kw):
     def get_options(self):
         return self._options
 
-    def add_command(self, *args, **kwargs):
+    def add_command(self, command_or_name, command=None, namespace=None):
         """
         Adds command to registry.
 
@@ -242,40 +244,37 @@ def add_command(self, *args, **kwargs):
         :param namespace: Namespace of the command (optional; pass as kwarg)
         """
 
-        if len(args) == 1:
-            command = args[0]
-            name = None
-
-        else:
-            name, command = args
-
-        if name is None:
+        if command is None:
+            # one positional arg -> command, guess for name
+            command = command_or_name
             if hasattr(command, 'name'):
                 name = command.name
 
             else:
                 name = type(command).__name__.lower()
                 name = re.sub(r'command$', '', name)
+        else:
+            # two positional args -> command, name
+            name = command_or_name
 
         if isinstance(command, Manager):
             command.parent = self
 
         if isinstance(command, type):
             command = command()
 
-        namespace = kwargs.get('namespace')
-        if not namespace:
+        if namespace is None:
             namespace = getattr(command, 'namespace', None)
 
-        if namespace:
+        if namespace is None:
+            # root namespace
+            self._commands[name] = command
+        else:
             if namespace not in self._commands:
                 self.add_command(namespace, Manager())
 
             self._commands[namespace]._commands[name] = command
 
-        else:
-            self._commands[name] = command
-
     def command(self, func):
         """
         Decorator to add a command function to the registry.
@@ -284,7 +283,6 @@ def command(self, func):
                      options.
 
         """
-
         command = Command(func)
         self.add_command(func.__name__, command)
 
@@ -310,7 +308,6 @@ def decorate(func):
             name = func.__name__
 
             if name not in self._commands:
-
                 command = Command()
                 command.run = func
                 command.__doc__ = func.__doc__
@@ -320,6 +317,7 @@ def decorate(func):
 
             self._commands[name].option_list.append(option)
             return func
+
         return decorate
 
     def shell(self, func):
@@ -351,7 +349,7 @@ def set_defaults(self):
     def handle(self, prog, args=None):
         self.set_defaults()
         app_parser = self.create_parser(prog)
-        
+
         args = list(args or [])
         app_namespace, remaining_args = app_parser.parse_known_args(args)
 
@@ -370,7 +368,7 @@ def handle(self, prog, args=None):
 
             # get only safe config options
             config_keys = [action.dest for action in handle.parser._actions
-                               if handle is last_func or action.__class__ in safe_actions]
+                           if handle is last_func or action.__class__ in safe_actions]
 
             # pass only safe app config keys
             config = dict((k, v) for k, v in iteritems(kwargs)
@@ -385,7 +383,7 @@ def handle(self, prog, args=None):
             try:
                 res = handle(*args, **config)
             except TypeError as err:
-                err.args = ("{0}: {1}".format(handle,str(err)),)
+                err.args = ("{0}: {1}".format(handle, str(err)),)
                 raise
 
             args = [res]

flask_script/_compat.py

@@ -18,6 +18,7 @@
 
 
 if not PY2:
+    # objects for Python >= 3
     unichr = chr
     range_type = range
     text_type = str
@@ -37,6 +38,8 @@ def reraise(tp, value, tb=None):
             raise value.with_traceback(tb)
         raise value
 
+    from inspect import getfullargspec as getargspec
+
     ifilter = filter
     imap = map
     izip = zip
@@ -50,9 +53,10 @@ def reraise(tp, value, tb=None):
     input = input
 
 else:
+    # objects for Python 2.7
     unichr = unichr
-    text_type = unicode
     range_type = xrange
+    text_type = unicode
     string_types = (str, unicode)
     integer_types = (int, long)
 
@@ -66,6 +70,8 @@ def reraise(tp, value, tb=None):
 
     exec('def reraise(tp, value, tb=None):\n raise tp, value, tb')
 
+    from inspect import getargspec
+
     from itertools import imap, izip, ifilter
     intern = intern
 
@@ -113,3 +119,5 @@ def __new__(cls, name, this_bases, d):
     from urllib.parse import quote_from_bytes as url_quote
 except ImportError:
     from urllib import quote as url_quote
+
+__all__ = []