root / kamaki / cli / __init__.py @ de73876b
History | View | Annotate | Download (12.5 kB)
1 |
# Copyright 2012-2013 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# 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 |
_help = False
|
45 |
_debug = False
|
46 |
_include = False
|
47 |
_verbose = False
|
48 |
_colors = False
|
49 |
kloger = None
|
50 |
|
51 |
# command auxiliary methods
|
52 |
|
53 |
_best_match = [] |
54 |
|
55 |
|
56 |
def _construct_command_syntax(cls): |
57 |
spec = getargspec(cls.main.im_func) |
58 |
args = spec.args[1:]
|
59 |
n = len(args) - len(spec.defaults or ()) |
60 |
required = ' '.join(
|
61 |
'<%s>' % x.replace(
|
62 |
'____', '[:').replace( |
63 |
'___', ':').replace( |
64 |
'__', ']').replace( |
65 |
'_', ' ') for x in args[:n]) |
66 |
optional = ' '.join(
|
67 |
'[%s]' % x.replace(
|
68 |
'____', '[:').replace( |
69 |
'___', ':').replace( |
70 |
'__', ']').replace( |
71 |
'_', ' ') for x in args[n:]) |
72 |
cls.syntax = ' '.join(x for x in [required, optional] if x) |
73 |
if spec.varargs:
|
74 |
cls.syntax += ' <%s ...>' % spec.varargs
|
75 |
|
76 |
|
77 |
def _num_of_matching_terms(basic_list, attack_list): |
78 |
if not attack_list: |
79 |
return len(basic_list) |
80 |
|
81 |
matching_terms = 0
|
82 |
for i, term in enumerate(basic_list): |
83 |
try:
|
84 |
if term != attack_list[i]:
|
85 |
break
|
86 |
except IndexError: |
87 |
break
|
88 |
matching_terms += 1
|
89 |
return matching_terms
|
90 |
|
91 |
|
92 |
def _update_best_match(name_terms, prefix=[]): |
93 |
if prefix:
|
94 |
pref_list = prefix if isinstance(prefix, list) else prefix.split('_') |
95 |
else:
|
96 |
pref_list = [] |
97 |
|
98 |
num_of_matching_terms = _num_of_matching_terms(name_terms, pref_list) |
99 |
global _best_match
|
100 |
if not prefix: |
101 |
_best_match = [] |
102 |
|
103 |
if num_of_matching_terms and len(_best_match) <= num_of_matching_terms: |
104 |
if len(_best_match) < num_of_matching_terms: |
105 |
_best_match = name_terms[:num_of_matching_terms] |
106 |
return True |
107 |
return False |
108 |
|
109 |
|
110 |
def command(cmd_tree, prefix='', descedants_depth=1): |
111 |
"""Load a class as a command
|
112 |
e.g. spec_cmd0_cmd1 will be command spec cmd0
|
113 |
|
114 |
:param cmd_tree: is initialized in cmd_spec file and is the structure
|
115 |
where commands are loaded. Var name should be _commands
|
116 |
:param prefix: if given, load only commands prefixed with prefix,
|
117 |
:param descedants_depth: is the depth of the tree descedants of the
|
118 |
prefix command. It is used ONLY if prefix and if prefix is not
|
119 |
a terminal command
|
120 |
|
121 |
:returns: the specified class object
|
122 |
"""
|
123 |
|
124 |
def wrap(cls): |
125 |
global kloger
|
126 |
cls_name = cls.__name__ |
127 |
|
128 |
if not cmd_tree: |
129 |
if _debug:
|
130 |
kloger.warning('command %s found but not loaded' % cls_name)
|
131 |
return cls
|
132 |
|
133 |
name_terms = cls_name.split('_')
|
134 |
if not _update_best_match(name_terms, prefix): |
135 |
if _debug:
|
136 |
kloger.warning('%s failed to update_best_match' % cls_name)
|
137 |
return None |
138 |
|
139 |
global _best_match
|
140 |
max_len = len(_best_match) + descedants_depth
|
141 |
if len(name_terms) > max_len: |
142 |
partial = '_'.join(name_terms[:max_len])
|
143 |
if not cmd_tree.has_command(partial): # add partial path |
144 |
cmd_tree.add_command(partial) |
145 |
if _debug:
|
146 |
kloger.warning('%s failed max_len test' % cls_name)
|
147 |
return None |
148 |
|
149 |
( |
150 |
cls.description, sep, cls.long_description |
151 |
) = cls.__doc__.partition('\n')
|
152 |
_construct_command_syntax(cls) |
153 |
|
154 |
cmd_tree.add_command(cls_name, cls.description, cls) |
155 |
return cls
|
156 |
return wrap
|
157 |
|
158 |
|
159 |
cmd_spec_locations = [ |
160 |
'kamaki.cli.commands',
|
161 |
'kamaki.commands',
|
162 |
'kamaki.cli',
|
163 |
'kamaki',
|
164 |
'']
|
165 |
|
166 |
|
167 |
# Generic init auxiliary functions
|
168 |
|
169 |
|
170 |
def _setup_logging(silent=False, debug=False, verbose=False, include=False): |
171 |
"""handle logging for clients package"""
|
172 |
|
173 |
def add_handler(name, level, prefix=''): |
174 |
h = logging.StreamHandler() |
175 |
fmt = logging.Formatter(prefix + '%(message)s')
|
176 |
h.setFormatter(fmt) |
177 |
logger = logging.getLogger(name) |
178 |
logger.addHandler(h) |
179 |
logger.setLevel(level) |
180 |
|
181 |
if silent:
|
182 |
add_handler('', logging.CRITICAL)
|
183 |
return
|
184 |
|
185 |
if debug:
|
186 |
add_handler('requests', logging.INFO, prefix='* ') |
187 |
add_handler('clients.send', logging.DEBUG, prefix='> ') |
188 |
add_handler('clients.recv', logging.DEBUG, prefix='< ') |
189 |
add_handler('kamaki', logging.DEBUG, prefix='(debug): ') |
190 |
elif verbose:
|
191 |
add_handler('requests', logging.INFO, prefix='* ') |
192 |
add_handler('clients.send', logging.INFO, prefix='> ') |
193 |
add_handler('clients.recv', logging.INFO, prefix='< ') |
194 |
add_handler('kamaki', logging.INFO, prefix='(i): ') |
195 |
if include:
|
196 |
add_handler('data.send', logging.INFO, prefix='>[data]: ') |
197 |
add_handler('data.recv', logging.INFO, prefix='<[data]: ') |
198 |
add_handler('kamaki', logging.WARNING, prefix='(warning): ') |
199 |
global kloger
|
200 |
kloger = logging.getLogger('kamaki')
|
201 |
|
202 |
|
203 |
def _init_session(arguments): |
204 |
global _help
|
205 |
_help = arguments['help'].value
|
206 |
global _debug
|
207 |
_debug = arguments['debug'].value
|
208 |
global _include
|
209 |
_include = arguments['include'].value
|
210 |
global _verbose
|
211 |
_verbose = arguments['verbose'].value
|
212 |
global _colors
|
213 |
_colors = arguments['config'].get('global', 'colors') |
214 |
if not (stdout.isatty() and _colors == 'on'): |
215 |
from kamaki.cli.utils import remove_colors |
216 |
remove_colors() |
217 |
_silent = arguments['silent'].value
|
218 |
_setup_logging(_silent, _debug, _verbose, _include) |
219 |
|
220 |
|
221 |
def _load_spec_module(spec, arguments, module): |
222 |
spec_name = arguments['config'].get(spec, 'cli') |
223 |
if spec_name is None: |
224 |
return None |
225 |
pkg = None
|
226 |
for location in cmd_spec_locations: |
227 |
location += spec_name if location == '' else '.%s' % spec_name |
228 |
try:
|
229 |
pkg = __import__(location, fromlist=[module])
|
230 |
return pkg
|
231 |
except ImportError: |
232 |
continue
|
233 |
return pkg
|
234 |
|
235 |
|
236 |
def _groups_help(arguments): |
237 |
global _debug
|
238 |
global kloger
|
239 |
descriptions = {} |
240 |
for spec in arguments['config'].get_groups(): |
241 |
pkg = _load_spec_module(spec, arguments, '_commands')
|
242 |
if pkg:
|
243 |
cmds = None
|
244 |
try:
|
245 |
cmds = [ |
246 |
cmd for cmd in getattr(pkg, '_commands') |
247 |
if arguments['config'].get(cmd.name, 'cli') |
248 |
] |
249 |
except AttributeError: |
250 |
if _debug:
|
251 |
kloger.warning('No description for %s' % spec)
|
252 |
try:
|
253 |
for cmd in cmds: |
254 |
descriptions[cmd.name] = cmd.description |
255 |
except TypeError: |
256 |
if _debug:
|
257 |
kloger.warning('no cmd specs in module %s' % spec)
|
258 |
elif _debug:
|
259 |
kloger.warning('Loading of %s cmd spec failed' % spec)
|
260 |
print('\nOptions:\n - - - -')
|
261 |
print_dict(descriptions) |
262 |
|
263 |
|
264 |
def _load_all_commands(cmd_tree, arguments): |
265 |
_config = arguments['config']
|
266 |
for spec in [spec for spec in _config.get_groups() |
267 |
if _config.get(spec, 'cli')]: |
268 |
try:
|
269 |
spec_module = _load_spec_module(spec, arguments, '_commands')
|
270 |
spec_commands = getattr(spec_module, '_commands') |
271 |
except AttributeError: |
272 |
if _debug:
|
273 |
global kloger
|
274 |
kloger.warning('No valid description for %s' % spec)
|
275 |
continue
|
276 |
for spec_tree in spec_commands: |
277 |
if spec_tree.name == spec:
|
278 |
cmd_tree.add_tree(spec_tree) |
279 |
break
|
280 |
|
281 |
|
282 |
# Methods to be used by CLI implementations
|
283 |
|
284 |
|
285 |
def print_subcommands_help(cmd): |
286 |
printout = {} |
287 |
for subcmd in cmd.get_subcommands(): |
288 |
spec, sep, print_path = subcmd.path.partition('_')
|
289 |
printout[print_path.replace('_', ' ')] = subcmd.description |
290 |
if printout:
|
291 |
print('\nOptions:\n - - - -')
|
292 |
print_dict(printout) |
293 |
|
294 |
|
295 |
def update_parser_help(parser, cmd): |
296 |
global _best_match
|
297 |
parser.syntax = parser.syntax.split('<')[0] |
298 |
parser.syntax += ' '.join(_best_match)
|
299 |
|
300 |
description = ''
|
301 |
if cmd.is_command:
|
302 |
cls = cmd.get_class() |
303 |
parser.syntax += ' ' + cls.syntax
|
304 |
parser.update_arguments(cls().arguments) |
305 |
description = getattr(cls, 'long_description', '') |
306 |
description = description.strip() |
307 |
else:
|
308 |
parser.syntax += ' <...>'
|
309 |
if cmd.has_description:
|
310 |
parser.parser.description = cmd.help + ( |
311 |
('\n%s' % description) if description else '') |
312 |
else:
|
313 |
parser.parser.description = description |
314 |
|
315 |
|
316 |
def print_error_message(cli_err): |
317 |
errmsg = '%s' % cli_err
|
318 |
if cli_err.importance == 1: |
319 |
errmsg = magenta(errmsg) |
320 |
elif cli_err.importance == 2: |
321 |
errmsg = yellow(errmsg) |
322 |
elif cli_err.importance > 2: |
323 |
errmsg = red(errmsg) |
324 |
stdout.write(errmsg) |
325 |
for errmsg in cli_err.details: |
326 |
print('| %s' % errmsg)
|
327 |
|
328 |
|
329 |
def exec_cmd(instance, cmd_args, help_method): |
330 |
try:
|
331 |
return instance.main(*cmd_args)
|
332 |
except TypeError as err: |
333 |
if err.args and err.args[0].startswith('main()'): |
334 |
print(magenta('Syntax error'))
|
335 |
if _debug:
|
336 |
raise err
|
337 |
if _verbose:
|
338 |
print(unicode(err))
|
339 |
help_method() |
340 |
else:
|
341 |
raise
|
342 |
return 1 |
343 |
|
344 |
|
345 |
def get_command_group(unparsed, arguments): |
346 |
groups = arguments['config'].get_groups()
|
347 |
for term in unparsed: |
348 |
if term.startswith('-'): |
349 |
continue
|
350 |
if term in groups: |
351 |
unparsed.remove(term) |
352 |
return term
|
353 |
return None |
354 |
return None |
355 |
|
356 |
|
357 |
def set_command_params(parameters): |
358 |
"""Add a parameters list to a command
|
359 |
|
360 |
:param paramters: (list of str) a list of parameters
|
361 |
"""
|
362 |
global command
|
363 |
def_params = list(command.func_defaults)
|
364 |
def_params[0] = parameters
|
365 |
command.func_defaults = tuple(def_params)
|
366 |
|
367 |
|
368 |
# CLI Choice:
|
369 |
|
370 |
def run_one_cmd(exe_string, parser): |
371 |
global _history
|
372 |
_history = History( |
373 |
parser.arguments['config'].get('history', 'file')) |
374 |
_history.add(' '.join([exe_string] + argv[1:])) |
375 |
from kamaki.cli import one_command |
376 |
one_command.run(parser, _help) |
377 |
|
378 |
|
379 |
def run_shell(exe_string, parser): |
380 |
from command_shell import _init_shell |
381 |
shell = _init_shell(exe_string, parser) |
382 |
_load_all_commands(shell.cmd_tree, parser.arguments) |
383 |
shell.run(parser) |
384 |
|
385 |
|
386 |
def main(): |
387 |
try:
|
388 |
exe = basename(argv[0])
|
389 |
parser = ArgumentParseManager(exe) |
390 |
|
391 |
if parser.arguments['version'].value: |
392 |
exit(0) |
393 |
|
394 |
_init_session(parser.arguments) |
395 |
|
396 |
if parser.unparsed:
|
397 |
run_one_cmd(exe, parser) |
398 |
elif _help:
|
399 |
parser.parser.print_help() |
400 |
_groups_help(parser.arguments) |
401 |
else:
|
402 |
run_shell(exe, parser) |
403 |
except CLIError as err: |
404 |
print_error_message(err) |
405 |
if _debug:
|
406 |
raise err
|
407 |
exit(1) |
408 |
except Exception as er: |
409 |
print('Unknown Error: %s' % er)
|
410 |
if _debug:
|
411 |
raise
|
412 |
exit(1) |