Skip to content

Commit

Permalink
[#4639] prefix strings and pep8
Browse files Browse the repository at this point in the history
  • Loading branch information
pdelboca committed Jul 1, 2019
1 parent fe28292 commit 967a320
Showing 1 changed file with 39 additions and 28 deletions.
67 changes: 39 additions & 28 deletions ckan/cli/plugin_info.py
@@ -1,58 +1,69 @@
# encoding: utf-8

import click

@click.command(name=u'plugin-info', short_help='Provide info on installed plugins.')

@click.command(
name=u'plugin-info',
short_help=u'Provide info on installed plugins.'
)
def plugin_info():
''' print info about current plugins from the .ini file'''
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] = {'class': item}
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] = {'doc': plugin.__doc__,
'class': plugin,
'implements': []}
plugins[name]['implements'].append(interface.__name__)
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 + ':')
click.echo('-' * (len(plugin) + 1))
if p['doc']:
click.echo(p['doc'])
click.echo('Implements:')
for i in p['implements']:
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 == 'ITemplateHelpers':
extra = _template_helpers(p['class'])
if i == 'IActions':
extra = _actions(p['class'])
click.echo(' {i}'.format(i=i))
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):
''' Return readable helper function info. '''
u''' Return readable helper function info. '''
helpers = plugin_class.get_helpers()
return _function_info(helpers)


def _actions(plugin_class):
''' Return readable action function info. '''
u''' Return readable action function info. '''
actions = plugin_class.get_actions()
return _function_info(actions)


def _function_info(functions):
''' Take a dict of functions and output readable info '''
u''' Take a dict of functions and output readable info '''
import inspect
output = []
for function_name in functions:
Expand All @@ -61,22 +72,22 @@ def _function_info(functions):
params = args_info.args
num_params = len(params)
if args_info.varargs:
params.append('*' + args_info.varargs)
params.append(u'*' + args_info.varargs)
if args_info.keywords:
params.append('**' + 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] + '=' + repr(v)
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 = ', '.join(params)
output.append(' {function_name}({params})'.format(
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('\n')
bits = fn.__doc__.split(u'\n')
for bit in bits:
output.append(' {bit}'.format(bit=bit))
return ('\n').join(output)
output.append(u' {bit}'.format(bit=bit))
return (u'\n').join(output)

0 comments on commit 967a320

Please sign in to comment.