__init__.py 12.3 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
from kamaki.cli.argument import ArgumentParseManager
40
from kamaki.cli.history import History
41
42
from kamaki.cli.utils import print_dict, print_list, red, magenta, yellow
from kamaki.cli.errors import CLIError
43

44
45
46
47
_help = False
_debug = False
_verbose = False
_colors = False
Stavros Sachtouris's avatar
Stavros Sachtouris committed
48
kloger = None
49

50
51
52
53
#  command auxiliary methods

_best_match = []

54

55
def _construct_command_syntax(cls):
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
        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


74
75
def _num_of_matching_terms(basic_list, attack_list):
    if not attack_list:
76
        return len(basic_list)
77

78
79
80
81
82
83
84
85
86
    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
87

88

89
90
91
92
93
def _update_best_match(name_terms, prefix=[]):
    if prefix:
        pref_list = prefix if isinstance(prefix, list) else prefix.split('_')
    else:
        pref_list = []
94

95
96
    num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list)
    global _best_match
97
98
    if not prefix:
        _best_match = []
99

100
101
102
103
104
105
106
107
108
    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
109
110
111
        e.g. spec_cmd0_cmd1 will be command spec cmd0

        :param cmd_tree: is initialized in cmd_spec file and is the structure
112
            where commands are loaded. Var name should be _commands
113
114
        :param prefix: if given, load only commands prefixed with prefix,
        :param descedants_depth: is the depth of the tree descedants of the
115
116
            prefix command. It is used ONLY if prefix and if prefix is not
            a terminal command
117
118

        :returns: the specified class object
119
120
121
    """

    def wrap(cls):
122
        global kloger
123
124
125
126
        cls_name = cls.__name__

        if not cmd_tree:
            if _debug:
127
                kloger.warning('command %s found but not loaded' % cls_name)
128
            return cls
129

130
131
        name_terms = cls_name.split('_')
        if not _update_best_match(name_terms, prefix):
132
            if _debug:
133
                kloger.warning('%s failed to update_best_match' % cls_name)
134
            return None
135

136
137
138
139
140
141
        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)
142
            if _debug:
143
                kloger.warning('%s failed max_len test' % cls_name)
144
            return None
145

146
147
148
        cls.description, sep, cls.long_description\
        = cls.__doc__.partition('\n')
        _construct_command_syntax(cls)
149

150
151
152
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
153

154

155
156
157
158
159
160
cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
161

162

163
164
165
#  Generic init auxiliary functions


166
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
167
168
169
170
171
172
173
174
175
176
177
178
    """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)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
179
180
181
        return

    if debug:
182
183
184
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.DEBUG, prefix='> ')
        add_handler('clients.recv', logging.DEBUG, prefix='< ')
185
        add_handler('kamaki', logging.DEBUG, prefix='(debug): ')
186
187
188
189
    elif verbose:
        add_handler('requests', logging.INFO, prefix='* ')
        add_handler('clients.send', logging.INFO, prefix='> ')
        add_handler('clients.recv', logging.INFO, prefix='< ')
190
        add_handler('kamaki', logging.INFO, prefix='(i): ')
191
192
    elif include:
        add_handler('clients.recv', logging.INFO)
193
    add_handler('kamaki', logging.WARNING, prefix='(warning): ')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
194
    global kloger
195
    kloger = logging.getLogger('kamaki')
196

197

198
199
200
201
202
203
204
205
206
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')
207
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
208
209
        from kamaki.cli.utils import remove_colors
        remove_colors()
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    _silent = arguments['silent'].value
    _include = arguments['include'].value
    _setup_logging(_silent, _debug, _verbose, _include)


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
Stavros Sachtouris's avatar
Stavros Sachtouris committed
232
    global kloger
233
234
235
236
237
238
239
240
241
242
243
244
    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:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
245
                    kloger.warning('No description for %s' % spec)
246
247
248
249
250
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
251
                    kloger.warning('no cmd specs in module %s' % spec)
252
        elif _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
253
            kloger.warning('Loading of %s cmd spec failed' % spec)
254
255
256
257
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
def _load_all_commands(cmd_tree, arguments):
    _config = arguments['config']
    for spec in [spec for spec in _config.get_groups()\
            if _config.get(spec, 'cli')]:
        try:
            spec_module = _load_spec_module(spec, arguments, '_commands')
            spec_commands = getattr(spec_module, '_commands')
        except AttributeError:
            if _debug:
                global kloger
                kloger.warning('No valid description for %s' % spec)
            continue
        for spec_tree in spec_commands:
            if spec_tree.name == spec:
                cmd_tree.add_tree(spec_tree)
                break


#  Methods to be used by CLI implementations


def print_subcommands_help(cmd):
280
281
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
282
283
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
284
285
286
287
288
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


289
def update_parser_help(parser, cmd):
290
    global _best_match
291
292
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
293

294
    description = ''
295
296
    if cmd.is_command:
        cls = cmd.get_class()
297
298
        parser.syntax += ' ' + cls.syntax
        parser.update_arguments(cls().arguments)
299
300
        description = getattr(cls, 'long_description', '')
        description = description.strip()
301
    else:
302
        parser.syntax += ' <...>'
303
    if cmd.has_description:
304
305
        parser.parser.description = cmd.help\
        + ((' . . . %s' % description) if description else '')
306
307
    else:
        parser.parser.description = description
308
309


310
def print_error_message(cli_err):
311
312
313
314
315
316
317
318
319
320
321
    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)


322
def exec_cmd(instance, cmd_args, help_method):
323
324
325
326
327
    try:
        return instance.main(*cmd_args)
    except TypeError as err:
        if err.args and err.args[0].startswith('main()'):
            print(magenta('Syntax error'))
328
329
330
            if _debug:
                raise err
            if _verbose:
331
332
333
334
335
336
                print(unicode(err))
            help_method()
        else:
            raise
    return 1

337

338
339
340
341
342
343
344
345
346
347
348
349
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


350
351
352
353
354
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
355
356
    global command
    def_params = list(command.func_defaults)
357
    def_params[0] = parameters
358
359
360
    command.func_defaults = tuple(def_params)


361
#  CLI Choice:
362

363
364
365
366
367
368
369
def run_one_cmd(exe_string, parser):
    global _history
    _history = History(
        parser.arguments['config'].get('history', 'file'))
    _history.add(' '.join([exe_string] + argv[1:]))
    from kamaki.cli import one_command
    one_command.run(parser, _help)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
370
371


372
def run_shell(exe_string, parser):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
373
    from command_shell import _init_shell
374
375
376
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
    shell.run(parser)
377

378
379

def main():
380
381
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
382
        parser = ArgumentParseManager(exe)
383

384
        if parser.arguments['version'].value:
385
386
            exit(0)

387
        _init_session(parser.arguments)
388

389
        if parser.unparsed:
390
            run_one_cmd(exe, parser)
391
        elif _help:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
392
            parser.parser.print_help()
393
            _groups_help(parser.arguments)
394
        else:
395
            run_shell(exe, parser)
396
    except CLIError as err:
397
        print_error_message(err)
398
399
400
        if _debug:
            raise err
        exit(1)
401
402
    except Exception as er:
        print('Unknown Error: %s' % er)
403
        if _debug:
404
405
            raise
        exit(1)