Merge branch 'master' of github.com:ckan/ckan

ckan/cli/cli.py

@@ -11,6 +11,7 @@
     datastore,
     translation,
     dataset,
+    plugin_info,
 )
 
 from ckan.config.middleware import make_app
@@ -44,3 +45,4 @@ def ckan(ctx, config, *args, **kwargs):
 ckan.add_command(datastore.datastore)
 ckan.add_command(translation.translation)
 ckan.add_command(dataset.dataset)
+ckan.add_command(plugin_info.plugin_info)

ckan/cli/plugin_info.py

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+import click
+
+
+@click.command(
+    name=u'plugin-info',
+    short_help=u'Provide info on installed plugins.'
+)
+def plugin_info():
+    u''' print info about current plugins from the .ini file'''
+    import ckan.plugins as p
+    interfaces = {}
+    plugins = {}
+    for name in dir(p):
+        item = getattr(p, name)
+        try:
+            if issubclass(item, p.Interface):
+                interfaces[item] = {u'class': item}
+        except TypeError:
+            pass
+
+    for interface in interfaces:
+        for plugin in p.PluginImplementations(interface):
+            name = plugin.name
+            if name not in plugins:
+                plugins[name] = {
+                    u'doc': plugin.__doc__,
+                    u'class': plugin,
+                    u'implements': []
+                }
+            plugins[name][u'implements'].append(interface.__name__)
+
+    for plugin in plugins:
+        p = plugins[plugin]
+        click.echo(plugin + u':')
+        click.echo(u'-' * (len(plugin) + 1))
+        if p[u'doc']:
+            click.echo(p[u'doc'])
+        click.echo(u'Implements:')
+        for i in p[u'implements']:
+            extra = None
+            if i == u'ITemplateHelpers':
+                extra = _template_helpers(p[u'class'])
+            if i == u'IActions':
+                extra = _actions(p[u'class'])
+            click.echo(u'    {i}'.format(i=i))
+            if extra:
+                click.echo(extra)
+        click.echo()
+
+
+def _template_helpers(plugin_class):
+    u''' Return readable helper function info. '''
+    helpers = plugin_class.get_helpers()
+    return _function_info(helpers)
+
+
+def _actions(plugin_class):
+    u''' Return readable action function info. '''
+    actions = plugin_class.get_actions()
+    return _function_info(actions)
+
+
+def _function_info(functions):
+    u''' Take a dict of functions and output readable info '''
+    import inspect
+    output = []
+    for function_name in functions:
+        fn = functions[function_name]
+        args_info = inspect.getargspec(fn)
+        params = args_info.args
+        num_params = len(params)
+        if args_info.varargs:
+            params.append(u'*' + args_info.varargs)
+        if args_info.keywords:
+            params.append(u'**' + args_info.keywords)
+        if args_info.defaults:
+            offset = num_params - len(args_info.defaults)
+            for i, v in enumerate(args_info.defaults):
+                params[i + offset] = params[i + offset] + u'=' + repr(v)
+        # is this a classmethod if so remove the first parameter
+        if inspect.ismethod(fn) and inspect.isclass(fn.__self__):
+            params = params[1:]
+        params = u', '.join(params)
+        output.append(u'        {function_name}({params})'.format(
+            function_name=function_name, params=params))
+        # doc string
+        if fn.__doc__:
+            bits = fn.__doc__.split(u'\n')
+            for bit in bits:
+                output.append(u'            {bit}'.format(bit=bit))
+    return (u'\n').join(output)