__init__.py 13 KB
Newer Older
1
# Copyright 2012-2013 GRNET S.A. All rights reserved.
2
3
4
5
6
7
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
8
9
#      copyright notice, this list of conditions and the following
#      disclaimer.
10
11
#
#   2. Redistributions in binary form must reproduce the above
12
13
14
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.command
33
34

import logging
35
from sys import argv, exit, stdout
36
from os.path import basename
37
from inspect import getargspec
38

39
40
from kamaki.cli.argument import _arguments, parse_known_args, init_parser,\
    update_arguments
41
from kamaki.cli.history import History
42
43
from kamaki.cli.utils import print_dict, print_list, red, magenta, yellow
from kamaki.cli.errors import CLIError
44

45
46
47
48
_help = False
_debug = False
_verbose = False
_colors = False
49
50


51
def _construct_command_syntax(cls):
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
        spec = getargspec(cls.main.im_func)
        args = spec.args[1:]
        n = len(args) - len(spec.defaults or ())
        required = ' '.join('<%s>' % x\
            .replace('____', '[:')\
            .replace('___', ':')\
            .replace('__', ']').\
            replace('_', ' ') for x in args[:n])
        optional = ' '.join('[%s]' % x\
            .replace('____', '[:')\
            .replace('___', ':')\
            .replace('__', ']').\
            replace('_', ' ') for x in args[n:])
        cls.syntax = ' '.join(x for x in [required, optional] if x)
        if spec.varargs:
            cls.syntax += ' <%s ...>' % spec.varargs


70
71
72
73
74
def _get_cmd_tree_from_spec(spec, cmd_tree_list):
    for tree in cmd_tree_list:
        if tree.name == spec:
            return tree
    return None
75

76

77
_best_match = []
78

79

80
81
82
def _num_of_matching_terms(basic_list, attack_list):
    if not attack_list:
        return 1
83

84
85
86
87
88
89
90
91
92
    matching_terms = 0
    for i, term in enumerate(basic_list):
        try:
            if term != attack_list[i]:
                break
        except IndexError:
            break
        matching_terms += 1
    return matching_terms
93

94

95
96
97
98
99
def _update_best_match(name_terms, prefix=[]):
    if prefix:
        pref_list = prefix if isinstance(prefix, list) else prefix.split('_')
    else:
        pref_list = []
100

101
102
    num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list)
    global _best_match
103

104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
    if num_of_matching_terms and len(_best_match) <= num_of_matching_terms:
        if len(_best_match) < num_of_matching_terms:
            _best_match = name_terms[:num_of_matching_terms]
        return True
    return False


def command(cmd_tree, prefix='', descedants_depth=1):
    """Load a class as a command
        spec_cmd0_cmd1 will be command spec cmd0
        @cmd_tree is initialized in cmd_spec file and is the structure
            where commands are loaded. Var name should be _commands
        @param prefix if given, load only commands prefixed with prefix,
        @param descedants_depth is the depth of the tree descedants of the
            prefix command. It is used ONLY if prefix and if prefix is not
            a terminal command
    """

    def wrap(cls):
        cls_name = cls.__name__

        if not cmd_tree:
            if _debug:
                print('Warning: command %s found but not loaded' % cls_name)
            return cls
129

130
131
132
        name_terms = cls_name.split('_')
        if not _update_best_match(name_terms, prefix):
            return None
133

134
135
136
137
138
139
140
        global _best_match
        max_len = len(_best_match) + descedants_depth
        if len(name_terms) > max_len:
            partial = '_'.join(name_terms[:max_len])
            if not cmd_tree.has_command(partial):  # add partial path
                cmd_tree.add_command(partial)
            return None
141

142
143
144
        cls.description, sep, cls.long_description\
        = cls.__doc__.partition('\n')
        _construct_command_syntax(cls)
145

146
147
148
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
149

150

151
152
153
154
155
156
157
158
159
160
161
def get_cmd_terms():
    global command
    return [term for term in command.func_defaults[0]\
        if not term.startswith('-')]

cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
162

163

164
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
    """handle logging for clients package"""

    def add_handler(name, level, prefix=''):
        h = logging.StreamHandler()
        fmt = logging.Formatter(prefix + '%(message)s')
        h.setFormatter(fmt)
        logger = logging.getLogger(name)
        logger.addHandler(h)
        logger.setLevel(level)

    if silent:
        add_handler('', logging.CRITICAL)
    elif debug:
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.DEBUG, prefix='> ')
        add_handler('clients.recv', logging.DEBUG, prefix='< ')
    elif verbose:
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.INFO, prefix='> ')
        add_handler('clients.recv', logging.INFO, prefix='< ')
    elif include:
        add_handler('clients.recv', logging.INFO)
    else:
        add_handler('', logging.WARNING)

190

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
    global _verbose
    _verbose = arguments['verbose'].value
    global _colors
    _colors = arguments['config'].get('global', 'colors')
    _silent = arguments['silent'].value
    _include = arguments['include'].value
    _setup_logging(_silent, _debug, _verbose, _include)


def get_command_group(unparsed, arguments):
    groups = arguments['config'].get_groups()
    for term in unparsed:
        if term.startswith('-'):
            continue
        if term in groups:
            unparsed.remove(term)
            return term
        return None
    return None


def _load_spec_module(spec, arguments, module):
    spec_name = arguments['config'].get(spec, 'cli')
    if spec_name is None:
        return None
    pkg = None
    for location in cmd_spec_locations:
        location += spec_name if location == '' else '.%s' % spec_name
        try:
            pkg = __import__(location, fromlist=[module])
            return pkg
        except ImportError:
            continue
    return pkg


def _groups_help(arguments):
    global _debug
    descriptions = {}
    for spec in arguments['config'].get_groups():
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
            cmds = None
            try:
                cmds = [
                    cmd for cmd in getattr(pkg, '_commands')\
                    if arguments['config'].get(cmd.name, 'cli')
                ]
            except AttributeError:
                if _debug:
                    print('Warning: No description for %s' % spec)
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
                    print('Warning: no cmd specs in module %s' % spec)
        elif _debug:
            print('Warning: Loading of %s cmd spec failed' % spec)
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


def _print_subcommands_help(cmd):
    printout = {}
    for subcmd in cmd.get_subcommands():
        printout[subcmd.path.replace('_', ' ')] = subcmd.description
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


def _update_parser_help(parser, cmd):
    global _best_match
    parser.prog = parser.prog.split('<')[0]
    parser.prog += ' '.join(_best_match)

    if cmd.is_command:
        cls = cmd.get_class()
        parser.prog += ' ' + cls.syntax
        arguments = cls().arguments
        update_arguments(parser, arguments)
    else:
        parser.prog += ' <...>'
    if cmd.has_description:
        parser.description = cmd.help


def _print_error_message(cli_err):
    errmsg = '%s' % cli_err
    if cli_err.importance == 1:
        errmsg = magenta(errmsg)
    elif cli_err.importance == 2:
        errmsg = yellow(errmsg)
    elif cli_err.importance > 2:
        errmsg = red(errmsg)
    stdout.write(errmsg)
    print_list(cli_err.details)


def _get_best_match_from_cmd_tree(cmd_tree, unparsed):
    matched = [term for term in unparsed if not term.startswith('-')]
    while matched:
        try:
            return cmd_tree.get_command('_'.join(matched))
        except KeyError:
            matched = matched[:-1]
    return None


306
def _exec_cmd(instance, cmd_args, help_method):
307
308
309
310
311
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
312
313
314
            if _debug:
                raise err
            if _verbose:
315
316
317
318
319
                print(unicode(err))
            help_method()
        else:
            raise
    except CLIError as err:
320
321
        if _debug:
            raise err
322
323
324
        _print_error_message(err)
    return 1

325

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
def set_command_param(param, value):
    if param == 'prefix':
        pos = 0
    elif param == 'descedants_depth':
        pos = 1
    else:
        return
    global command
    def_params = list(command.func_defaults)
    def_params[pos] = value
    command.func_defaults = tuple(def_params)


def one_cmd(parser, unparsed, arguments):
    group = get_command_group(list(unparsed), arguments)
    if not group:
        parser.print_help()
        _groups_help(arguments)
        exit(0)

    set_command_param(
        'prefix',
        [term for term in unparsed if not term.startswith('-')]
    )
    global _best_match
    _best_match = []

    spec_module = _load_spec_module(group, arguments, '_commands')

    cmd_tree = _get_cmd_tree_from_spec(group, spec_module._commands)

    if _best_match:
        cmd = cmd_tree.get_command('_'.join(_best_match))
    else:
        cmd = _get_best_match_from_cmd_tree(cmd_tree, unparsed)
        _best_match = cmd.path.split('_')
    if cmd is None:
        if _debug or _verbose:
            print('Unexpected error: failed to load command')
365
366
        exit(1)

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
    _update_parser_help(parser, cmd)

    if _help or not cmd.is_command:
        parser.print_help()
        _print_subcommands_help(cmd)
        exit(0)

    cls = cmd.get_class()
    executable = cls(arguments)
    parsed, unparsed = parse_known_args(parser, executable.arguments)
    for term in _best_match:
        unparsed.remove(term)
    _exec_cmd(executable, unparsed, parser.print_help)


382
383
from command_shell import _fix_arguments, Shell

384

385
def _start_shell():
386
387
388
389
390
391
392
    shell = Shell()
    shell.set_prompt(basename(argv[0]))
    from kamaki import __version__ as version
    shell.greet(version)
    shell.do_EOF = shell.do_exit
    return shell

393

394
def run_shell(arguments):
395
396
397
    _fix_arguments()
    shell = _start_shell()
    _config = _arguments['config']
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
    from kamaki.cli.command_tree import CommandTree
    shell.cmd_tree = CommandTree(
        'kamaki', 'A command line tool for poking clouds')
    for spec in [spec for spec in _config.get_groups()\
            if arguments['config'].get(spec, 'cli')]:
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                print('Warning: No valid description for %s' % spec)
            continue
        for spec_tree in spec_commands:
            if spec_tree.name == spec:
                shell.cmd_tree.add_tree(spec_tree)
                break
414
415
    shell.run()

416
417

def main():
418
419
420
421
422
423
    exe = basename(argv[0])
    parser = init_parser(exe, _arguments)
    parsed, unparsed = parse_known_args(parser, _arguments)

    if _arguments['version'].value:
        exit(0)
424

425
426
427
428
429
430
431
432
433
    _init_session(_arguments)

    if unparsed:
        _history = History(_arguments['config'].get('history', 'file'))
        _history.add(' '.join([exe] + argv[1:]))
        one_cmd(parser, unparsed, _arguments)
    elif _help:
        parser.print_help()
        _groups_help(_arguments)
434
    else:
435
        run_shell(_arguments)