-
Notifications
You must be signed in to change notification settings - Fork 2k
/
plugin_info.py
82 lines (76 loc) · 2.87 KB
/
plugin_info.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
import click
@click.command(name=u'plugin-info', short_help='Provide info on installed plugins.')
def plugin_info():
''' 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}
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__)
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']:
extra = None
if i == 'ITemplateHelpers':
extra = _template_helpers(p['class'])
if i == 'IActions':
extra = _actions(p['class'])
click.echo(' {i}'.format(i=i))
if extra:
click.echo(extra)
click.echo()
def _template_helpers(cls):
''' Return readable helper function info. '''
helpers = cls.get_helpers()
return _function_info(helpers)
def _actions(self, cls):
''' Return readable action function info. '''
actions = cls.get_actions()
return _function_info(actions)
def _function_info(functions):
''' 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('*' + args_info.varargs)
if args_info.keywords:
params.append('**' + 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)
# 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(
function_name=function_name, params=params))
# doc string
if fn.__doc__:
bits = fn.__doc__.split('\n')
for bit in bits:
output.append(' {bit}'.format(bit=bit))
return ('\n').join(output)