Revision fd5db045 kamaki/cli/command_shell.py
b/kamaki/cli/command_shell.py | ||
---|---|---|
5 | 5 |
# conditions are met: |
6 | 6 |
# |
7 | 7 |
# 1. Redistributions of source code must retain the above |
8 |
# copyright notice, this list of conditions and the following
|
|
9 |
# disclaimer.
|
|
8 |
# copyright notice, this list of conditions and the following
|
|
9 |
# disclaimer.
|
|
10 | 10 |
# |
11 | 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.
|
|
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 | 15 |
# |
16 | 16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS |
17 | 17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
... | ... | |
42 | 42 |
from sys import stdout |
43 | 43 |
from .history import History |
44 | 44 |
|
45 |
|
|
45 | 46 |
def _fix_arguments(): |
46 |
_arguments.pop('version', None) |
|
47 |
_arguments.pop('options', None) |
|
48 |
_arguments.pop('history', None) |
|
47 |
_arguments.pop('version', None) |
|
48 |
_arguments.pop('options', None) |
|
49 |
_arguments.pop('history', None) |
|
50 |
|
|
49 | 51 |
|
50 | 52 |
class Shell(Cmd): |
51 |
"""Kamaki interactive shell""" |
|
52 |
_prefix = '[' |
|
53 |
_suffix = ']:' |
|
54 |
cmd_tree = None |
|
55 |
_history = None |
|
56 |
undoc_header='interactive shell commands:' |
|
57 |
|
|
58 |
def greet(self, version): |
|
59 |
print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'%version) |
|
60 |
def set_prompt(self, new_prompt): |
|
61 |
self.prompt = '[%s]:'%new_prompt |
|
62 |
|
|
63 |
def do_exit(self, line): |
|
64 |
print('') |
|
65 |
return True |
|
66 |
|
|
67 |
def do_shell(self, line): |
|
68 |
output = popen(line).read() |
|
69 |
print(output) |
|
70 |
|
|
71 |
@property |
|
72 |
def path(self): |
|
73 |
if self._cmd: |
|
74 |
return _cmd.path |
|
75 |
return '' |
|
76 |
|
|
77 |
@classmethod |
|
78 |
def _register_method(self, method, name): |
|
79 |
self.__dict__[name]=method |
|
80 |
@classmethod |
|
81 |
def _unregister_method(self, name): |
|
82 |
try: |
|
83 |
self.__dict__.pop(name) |
|
84 |
except KeyError: |
|
85 |
pass |
|
86 |
def _roll_command(self, cmd_path): |
|
87 |
for subname in self.cmd_tree.get_subnames(cmd_path): |
|
88 |
self._unregister_method('do_%s'%subname) |
|
89 |
self._unregister_method('complete_%s'%subname) |
|
90 |
self._unregister_method('help_%s'%subname) |
|
91 |
|
|
92 |
@classmethod |
|
93 |
def _backup(self): |
|
94 |
return dict(self.__dict__) |
|
95 |
@classmethod |
|
96 |
def _restore(self, oldcontext): |
|
97 |
self.__dict__= oldcontext |
|
98 |
|
|
99 |
def _push_in_command(self, cmd_path): |
|
100 |
cmd = self.cmd_tree.get_command(cmd_path) |
|
101 |
_cmd_tree = self.cmd_tree |
|
102 |
_history = self._history |
|
103 |
|
|
104 |
def do_method(self, line): |
|
105 |
""" Template for all cmd.Cmd methods of the form do_<cmd name> |
|
106 |
Parse cmd + args and decide to execute or change context |
|
107 |
<cmd> <term> <term> <args> is always parsed to the most specific cmd path |
|
108 |
even if cmd_term_term is not a terminal path |
|
109 |
""" |
|
110 |
if _history: |
|
111 |
_history.add(' '.join([cmd.path.replace('_',' '), line])) |
|
112 |
subcmd, cmd_args = cmd.parse_out(line.split()) |
|
113 |
active_terms = [cmd.name]+subcmd.path.split('_')[len(cmd.path.split('_')):] |
|
114 |
subname = '_'.join(active_terms) |
|
115 |
cmd_parser = ArgumentParser(subname, add_help=False) |
|
116 |
cmd_parser.description = subcmd.help |
|
117 |
|
|
118 |
#exec command or change context |
|
119 |
if subcmd.is_command:#exec command |
|
120 |
cls = subcmd.get_class() |
|
121 |
instance = cls(dict(_arguments)) |
|
122 |
cmd_parser.prog= cmd_parser.prog.replace('_', ' ')+' '+cls.syntax |
|
123 |
_update_parser(cmd_parser, instance.arguments) |
|
124 |
if '-h' in cmd_args or '--help' in cmd_args: |
|
125 |
cmd_parser.print_help() |
|
126 |
return |
|
127 |
parsed, unparsed = cmd_parser.parse_known_args(cmd_args) |
|
128 |
|
|
129 |
for name, arg in instance.arguments.items(): |
|
130 |
arg.value = getattr(parsed, name, arg.default) |
|
131 |
_exec_cmd(instance, unparsed, cmd_parser.print_help) |
|
132 |
elif ('-h' in cmd_args or '--help' in cmd_args) \ |
|
133 |
or len(cmd_args):#print options |
|
134 |
print('%s: %s'%(subname, subcmd.help)) |
|
135 |
options = {} |
|
136 |
for sub in subcmd.get_subcommands(): |
|
137 |
options[sub.name] = sub.help |
|
138 |
print_dict(options) |
|
139 |
else:#change context |
|
140 |
new_context = self |
|
141 |
backup_context = self._backup() |
|
142 |
old_prompt = self.prompt |
|
143 |
new_context._roll_command(cmd.parent_path) |
|
144 |
new_context.set_prompt(subcmd.path.replace('_',' ')) |
|
145 |
newcmds = [subcmd for subcmd in subcmd.get_subcommands()] |
|
146 |
for subcmd in newcmds: |
|
147 |
new_context._push_in_command(subcmd.path) |
|
148 |
new_context.cmdloop() |
|
149 |
self.prompt = old_prompt |
|
150 |
#when new context is over, roll back to the old one |
|
151 |
self._restore(backup_context) |
|
152 |
self._register_method(do_method, 'do_%s'%cmd.name) |
|
153 |
|
|
154 |
def help_method(self): |
|
155 |
print('%s (%s -h for more options)'%(cmd.help, cmd.name)) |
|
156 |
self._register_method(help_method, 'help_%s'%cmd.name) |
|
157 |
|
|
158 |
def complete_method(self, text, line, begidx, endidx): |
|
159 |
subcmd, cmd_args = cmd.parse_out(line.split()[1:]) |
|
160 |
if subcmd.is_command: |
|
161 |
cls = subcmd.get_class() |
|
162 |
instance = cls(dict(_arguments)) |
|
163 |
empty, sep, subname = subcmd.path.partition(cmd.path) |
|
164 |
cmd_name = '%s %s'%(cmd.name,subname.replace('_',' ')) |
|
165 |
print('\n%s\nSyntax:\t%s %s'%(cls.description,cmd_name,cls.syntax)) |
|
166 |
cmd_args={} |
|
167 |
for arg in instance.arguments.values(): |
|
168 |
cmd_args[','.join(arg.parsed_name)]=arg.help |
|
169 |
print_dict(cmd_args, ident=14) |
|
170 |
stdout.write('%s %s'%(self.prompt,line)) |
|
171 |
return subcmd.get_subnames() |
|
172 |
self._register_method(complete_method, 'complete_%s'%cmd.name) |
|
173 |
|
|
174 |
@property |
|
175 |
def doc_header(self): |
|
176 |
hdr = self.prompt.partition(self._prefix)[2].partition(self._suffix)[0].strip() |
|
177 |
return '%s commands:'%hdr |
|
178 |
|
|
179 |
def run(self, path=''): |
|
180 |
self._history = History(_arguments['config'].get('history', 'file')) |
|
181 |
if len(path): |
|
182 |
cmd = self.cmd_tree.get_command(path) |
|
183 |
intro = cmd.path.replace('_', ' ') |
|
184 |
else: |
|
185 |
intro = self.cmd_tree.name |
|
186 |
|
|
187 |
for subcmd in self.cmd_tree.get_subcommands(path): |
|
188 |
self._push_in_command(subcmd.path) |
|
189 |
|
|
190 |
self.set_prompt(intro) |
|
191 |
self.cmdloop() |
|
53 |
"""Kamaki interactive shell""" |
|
54 |
_prefix = '[' |
|
55 |
_suffix = ']:' |
|
56 |
cmd_tree = None |
|
57 |
_history = None |
|
58 |
undoc_header = 'interactive shell commands:' |
|
59 |
|
|
60 |
def greet(self, version): |
|
61 |
print('kamaki v%s - Interactive Shell\n\t(exit or ^D to exit)\n'\ |
|
62 |
% version) |
|
63 |
|
|
64 |
def set_prompt(self, new_prompt): |
|
65 |
self.prompt = '[%s]:' % new_prompt |
|
66 |
|
|
67 |
def do_exit(self, line): |
|
68 |
print('') |
|
69 |
return True |
|
70 |
|
|
71 |
def do_shell(self, line): |
|
72 |
output = popen(line).read() |
|
73 |
print(output) |
|
74 |
|
|
75 |
@property |
|
76 |
def path(self): |
|
77 |
if self._cmd: |
|
78 |
return _cmd.path |
|
79 |
return '' |
|
80 |
|
|
81 |
@classmethod |
|
82 |
def _register_method(self, method, name): |
|
83 |
self.__dict__[name] = method |
|
84 |
|
|
85 |
@classmethod |
|
86 |
def _unregister_method(self, name): |
|
87 |
try: |
|
88 |
self.__dict__.pop(name) |
|
89 |
except KeyError: |
|
90 |
pass |
|
91 |
|
|
92 |
def _roll_command(self, cmd_path): |
|
93 |
for subname in self.cmd_tree.get_subnames(cmd_path): |
|
94 |
self._unregister_method('do_%s' % subname) |
|
95 |
self._unregister_method('complete_%s' % subname) |
|
96 |
self._unregister_method('help_%s' % subname) |
|
97 |
|
|
98 |
@classmethod |
|
99 |
def _backup(self): |
|
100 |
return dict(self.__dict__) |
|
101 |
|
|
102 |
@classmethod |
|
103 |
def _restore(self, oldcontext): |
|
104 |
self.__dict__ = oldcontext |
|
105 |
|
|
106 |
def _push_in_command(self, cmd_path): |
|
107 |
cmd = self.cmd_tree.get_command(cmd_path) |
|
108 |
_cmd_tree = self.cmd_tree |
|
109 |
_history = self._history |
|
110 |
|
|
111 |
def do_method(self, line): |
|
112 |
""" Template for all cmd.Cmd methods of the form do_<cmd name> |
|
113 |
Parse cmd + args and decide to execute or change context |
|
114 |
<cmd> <term> <term> <args> is always parsed to most specific |
|
115 |
even if cmd_term_term is not a terminal path |
|
116 |
""" |
|
117 |
if _history: |
|
118 |
_history.add(' '.join([cmd.path.replace('_', ' '), line])) |
|
119 |
subcmd, cmd_args = cmd.parse_out(line.split()) |
|
120 |
active_terms = [cmd.name] +\ |
|
121 |
subcmd.path.split('_')[len(cmd.path.split('_')):] |
|
122 |
subname = '_'.join(active_terms) |
|
123 |
cmd_parser = ArgumentParser(subname, add_help=False) |
|
124 |
cmd_parser.description = subcmd.help |
|
125 |
|
|
126 |
# exec command or change context |
|
127 |
if subcmd.is_command: # exec command |
|
128 |
cls = subcmd.get_class() |
|
129 |
instance = cls(dict(_arguments)) |
|
130 |
cmd_parser.prog = '%s %s' % (cmd_parser.prog.replace('_', ' '), |
|
131 |
cls.syntax) |
|
132 |
_update_parser(cmd_parser, instance.arguments) |
|
133 |
if '-h' in cmd_args or '--help' in cmd_args: |
|
134 |
cmd_parser.print_help() |
|
135 |
return |
|
136 |
parsed, unparsed = cmd_parser.parse_known_args(cmd_args) |
|
137 |
|
|
138 |
for name, arg in instance.arguments.items(): |
|
139 |
arg.value = getattr(parsed, name, arg.default) |
|
140 |
_exec_cmd(instance, unparsed, cmd_parser.print_help) |
|
141 |
elif ('-h' in cmd_args or '--help' in cmd_args) \ |
|
142 |
or len(cmd_args): # print options |
|
143 |
print('%s: %s' % (subname, subcmd.help)) |
|
144 |
options = {} |
|
145 |
for sub in subcmd.get_subcommands(): |
|
146 |
options[sub.name] = sub.help |
|
147 |
print_dict(options) |
|
148 |
else: # change context |
|
149 |
new_context = self |
|
150 |
backup_context = self._backup() |
|
151 |
old_prompt = self.prompt |
|
152 |
new_context._roll_command(cmd.parent_path) |
|
153 |
new_context.set_prompt(subcmd.path.replace('_', ' ')) |
|
154 |
newcmds = [subcmd for subcmd in subcmd.get_subcommands()] |
|
155 |
for subcmd in newcmds: |
|
156 |
new_context._push_in_command(subcmd.path) |
|
157 |
new_context.cmdloop() |
|
158 |
self.prompt = old_prompt |
|
159 |
#when new context is over, roll back to the old one |
|
160 |
self._restore(backup_context) |
|
161 |
self._register_method(do_method, 'do_%s' % cmd.name) |
|
162 |
|
|
163 |
def help_method(self): |
|
164 |
print('%s (%s -h for more options)' % (cmd.help, cmd.name)) |
|
165 |
self._register_method(help_method, 'help_%s' % cmd.name) |
|
166 |
|
|
167 |
def complete_method(self, text, line, begidx, endidx): |
|
168 |
subcmd, cmd_args = cmd.parse_out(line.split()[1:]) |
|
169 |
if subcmd.is_command: |
|
170 |
cls = subcmd.get_class() |
|
171 |
instance = cls(dict(_arguments)) |
|
172 |
empty, sep, subname = subcmd.path.partition(cmd.path) |
|
173 |
cmd_name = '%s %s' % (cmd.name, subname.replace('_', ' ')) |
|
174 |
print('\n%s\nSyntax:\t%s %s'\ |
|
175 |
% (cls.description, cmd_name, cls.syntax)) |
|
176 |
cmd_args = {} |
|
177 |
for arg in instance.arguments.values(): |
|
178 |
cmd_args[','.join(arg.parsed_name)] = arg.help |
|
179 |
print_dict(cmd_args, ident=14) |
|
180 |
stdout.write('%s %s' % (self.prompt, line)) |
|
181 |
return subcmd.get_subnames() |
|
182 |
self._register_method(complete_method, 'complete_%s' % cmd.name) |
|
183 |
|
|
184 |
@property |
|
185 |
def doc_header(self): |
|
186 |
tmp_partition = self.prompt.partition(self._prefix) |
|
187 |
tmp_partition = tmp_partition[2].partition(self._suffix) |
|
188 |
hdr = tmp_partition[0].strip() |
|
189 |
return '%s commands:' % hdr |
|
190 |
|
|
191 |
def run(self, path=''): |
|
192 |
self._history = History(_arguments['config'].get('history', 'file')) |
|
193 |
if len(path): |
|
194 |
cmd = self.cmd_tree.get_command(path) |
|
195 |
intro = cmd.path.replace('_', ' ') |
|
196 |
else: |
|
197 |
intro = self.cmd_tree.name |
|
198 |
|
|
199 |
for subcmd in self.cmd_tree.get_subcommands(path): |
|
200 |
self._push_in_command(subcmd.path) |
|
201 |
|
|
202 |
self.set_prompt(intro) |
|
203 |
self.cmdloop() |
Also available in: Unified diff