__init__.py 12.4 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
from kamaki.cli.utils import print_dict, red, magenta, yellow
42
from kamaki.cli.errors import CLIError
43

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

51
52
53
54
#  command auxiliary methods

_best_match = []

55

56
57
58
def _arg2syntax(arg):
    return arg.replace(
        '____', '[:').replace(
59
60
61
            '___', ':').replace(
                '__', ']').replace(
                    '_', ' ')
62
63


64
def _construct_command_syntax(cls):
65
66
67
        spec = getargspec(cls.main.im_func)
        args = spec.args[1:]
        n = len(args) - len(spec.defaults or ())
68
69
        required = ' '.join(['<%s>' % _arg2syntax(x) for x in args[:n]])
        optional = ' '.join(['[%s]' % _arg2syntax(x) for x in args[n:]])
70
71
72
73
74
        cls.syntax = ' '.join(x for x in [required, optional] if x)
        if spec.varargs:
            cls.syntax += ' <%s ...>' % spec.varargs


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

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

89

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

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

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

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

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

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

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

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

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

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

152
153
154
        cmd_tree.add_command(cls_name, cls.description, cls)
        return cls
    return wrap
155

156

157
158
159
160
161
162
cmd_spec_locations = [
    'kamaki.cli.commands',
    'kamaki.commands',
    'kamaki.cli',
    'kamaki',
    '']
163

164

165
166
167
#  Generic init auxiliary functions


168
def _setup_logging(silent=False, debug=False, verbose=False, include=False):
169
170
171
172
173
174
175
176
177
178
179
180
    """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
181
182
183
        return

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

200

201
202
203
204
205
def _init_session(arguments):
    global _help
    _help = arguments['help'].value
    global _debug
    _debug = arguments['debug'].value
206
207
    global _include
    _include = arguments['include'].value
208
209
210
211
    global _verbose
    _verbose = arguments['verbose'].value
    global _colors
    _colors = arguments['config'].get('global', 'colors')
212
    if not (stdout.isatty() and _colors == 'on'):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
213
214
        from kamaki.cli.utils import remove_colors
        remove_colors()
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
    _silent = arguments['silent'].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
236
    global kloger
237
238
239
240
241
242
    descriptions = {}
    for spec in arguments['config'].get_groups():
        pkg = _load_spec_module(spec, arguments, '_commands')
        if pkg:
            cmds = None
            try:
243
244
245
                _cnf = arguments['config']
                cmds = [cmd for cmd in getattr(pkg, '_commands') if _cnf.get(
                    cmd.name, 'cli')]
246
247
            except AttributeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
248
                    kloger.warning('No description for %s' % spec)
249
250
251
252
253
            try:
                for cmd in cmds:
                    descriptions[cmd.name] = cmd.description
            except TypeError:
                if _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
254
                    kloger.warning('no cmd specs in module %s' % spec)
255
        elif _debug:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
256
            kloger.warning('Loading of %s cmd spec failed' % spec)
257
258
259
260
    print('\nOptions:\n - - - -')
    print_dict(descriptions)


261
def _load_all_commands(cmd_tree, arguments):
262
263
264
    _cnf = arguments['config']
    specs = [spec for spec in _cnf.get_groups() if _cnf.get(spec, 'cli')]
    for spec in specs:
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
        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):
283
284
    printout = {}
    for subcmd in cmd.get_subcommands():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
285
286
        spec, sep, print_path = subcmd.path.partition('_')
        printout[print_path.replace('_', ' ')] = subcmd.description
287
288
289
290
291
    if printout:
        print('\nOptions:\n - - - -')
        print_dict(printout)


292
def update_parser_help(parser, cmd):
293
    global _best_match
294
295
    parser.syntax = parser.syntax.split('<')[0]
    parser.syntax += ' '.join(_best_match)
296

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


313
def print_error_message(cli_err):
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)
322
323
    for errmsg in cli_err.details:
        print('| %s' % errmsg)
324
325


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

341

342
343
344
345
346
347
348
349
350
351
352
353
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


354
355
356
357
358
def set_command_params(parameters):
    """Add a parameters list to a command

    :param paramters: (list of str) a list of parameters
    """
359
360
    global command
    def_params = list(command.func_defaults)
361
    def_params[0] = parameters
362
363
364
    command.func_defaults = tuple(def_params)


365
#  CLI Choice:
366

367
368
369
370
371
372
373
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
374
375


376
def run_shell(exe_string, parser):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
377
    from command_shell import _init_shell
378
379
380
    shell = _init_shell(exe_string, parser)
    _load_all_commands(shell.cmd_tree, parser.arguments)
    shell.run(parser)
381

382
383

def main():
384
385
    try:
        exe = basename(argv[0])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
386
        parser = ArgumentParseManager(exe)
387

388
        if parser.arguments['version'].value:
389
390
            exit(0)

391
        _init_session(parser.arguments)
392

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