1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 """ A file containing different extension of the cmd basic python library"""
16
17
18 import logging
19 import os
20 import pydoc
21 import re
22 import signal
23 import subprocess
24 import sys
25 import traceback
26 try:
27 import readline
28 GNU_SPLITTING = ('GNU' in readline.__doc__)
29 except:
30 readline = None
31 GNU_SPLITTING = True
32
33
34 logger = logging.getLogger('cmdprint')
35 logger_stderr = logging.getLogger('fatalerror')
36
37 try:
38 import madgraph.various.misc as misc
39 from madgraph import MG5DIR
40 MADEVENT = False
41 except ImportError, error:
42 try:
43 import internal.misc as misc
44 except:
45 raise error
46
47 MADEVENT = True
48
49
50 pjoin = os.path.join
53 """Class for run-time error"""
54
55 -def debug(debug_only=True):
56
57 def deco_debug(f):
58
59 if debug_only and not __debug__:
60 return f
61
62 def deco_f(*args, **opt):
63 try:
64 return f(*args, **opt)
65 except Exception, error:
66 logger.error(error)
67 logger.error(traceback.print_exc(file=sys.stdout))
68 return
69 return deco_f
70 return deco_debug
71
72 import string
73
74
75 __all__ = ["Cmd"]
76 PROMPT = '(Cmd) '
77 IDENTCHARS = string.ascii_letters + string.digits + '_'
79 """A simple framework for writing line-oriented command interpreters.
80
81 These are often useful for test harnesses, administrative tools, and
82 prototypes that will later be wrapped in a more sophisticated interface.
83
84 A Cmd instance or subclass instance is a line-oriented interpreter
85 framework. There is no good reason to instantiate Cmd itself; rather,
86 it's useful as a superclass of an interpreter class you define yourself
87 in order to inherit Cmd's methods and encapsulate action methods.
88
89 """
90 prompt = PROMPT
91 identchars = IDENTCHARS
92 ruler = '='
93 lastcmd = ''
94 intro = None
95 doc_leader = ""
96 doc_header = "Documented commands (type help <topic>):"
97 misc_header = "Miscellaneous help topics:"
98 undoc_header = "Undocumented commands:"
99 nohelp = "*** No help on %s"
100 use_rawinput = 1
101
102 - def __init__(self, completekey='tab', stdin=None, stdout=None,**opt):
103 """Instantiate a line-oriented interpreter framework.
104
105 The optional argument 'completekey' is the readline name of a
106 completion key; it defaults to the Tab key. If completekey is
107 not None and the readline module is available, command completion
108 is done automatically. The optional arguments stdin and stdout
109 specify alternate input and output file objects; if not specified,
110 sys.stdin and sys.stdout are used.
111
112 """
113 import sys
114 if stdin is not None:
115 self.stdin = stdin
116 else:
117 self.stdin = sys.stdin
118 if stdout is not None:
119 self.stdout = stdout
120 else:
121 self.stdout = sys.stdout
122 self.cmdqueue = []
123 self.completekey = completekey
124 self.cmd_options = opt
125
127 """Repeatedly issue a prompt, accept input, parse an initial prefix
128 off the received input, and dispatch to action methods, passing them
129 the remainder of the line as argument.
130
131 """
132
133 self.preloop()
134 if self.use_rawinput and self.completekey:
135 try:
136 import readline
137 self.old_completer = readline.get_completer()
138 readline.set_completer(self.complete)
139 readline.parse_and_bind(self.completekey+": complete")
140 except ImportError:
141 pass
142 try:
143 if intro is not None:
144 self.intro = intro
145 if self.intro:
146 self.stdout.write(str(self.intro)+"\n")
147 stop = None
148 while not stop:
149 if self.cmdqueue:
150 line = self.cmdqueue.pop(0)
151 else:
152 if self.use_rawinput:
153 try:
154 line = raw_input(self.prompt)
155 except EOFError:
156 line = 'EOF'
157 else:
158 self.stdout.write(self.prompt)
159 self.stdout.flush()
160 line = self.stdin.readline()
161 if not len(line):
162 line = 'EOF'
163 else:
164 line = line.rstrip('\r\n')
165 line = self.precmd(line)
166 stop = self.onecmd(line)
167 stop = self.postcmd(stop, line)
168 self.postloop()
169 finally:
170 if self.use_rawinput and self.completekey:
171 try:
172 import readline
173 readline.set_completer(self.old_completer)
174 except ImportError:
175 pass
176
177
179 """Hook method executed just before the command line is
180 interpreted, but after the input prompt is generated and issued.
181
182 """
183 return line
184
185 - def postcmd(self, stop, line):
186 """Hook method executed just after a command dispatch is finished."""
187 return stop
188
190 """Hook method executed once when the cmdloop() method is called."""
191 pass
192
193 - def postloop(self):
194 """Hook method executed once when the cmdloop() method is about to
195 return.
196
197 """
198 pass
199
201 """Parse the line into a command name and a string containing
202 the arguments. Returns a tuple containing (command, args, line).
203 'command' and 'args' may be None if the line couldn't be parsed.
204 """
205 line = line.strip()
206 if not line:
207 return None, None, line
208 elif line[0] == '?':
209 line = 'help ' + line[1:]
210 elif line[0] == '!':
211 if hasattr(self, 'do_shell'):
212 line = 'shell ' + line[1:]
213 else:
214 return None, None, line
215 i, n = 0, len(line)
216 while i < n and line[i] in self.identchars: i = i+1
217 cmd, arg = line[:i], line[i:].strip()
218 return cmd, arg, line
219
221 """Interpret the argument as though it had been typed in response
222 to the prompt.
223
224 This may be overridden, but should not normally need to be;
225 see the precmd() and postcmd() methods for useful execution hooks.
226 The return value is a flag indicating whether interpretation of
227 commands by the interpreter should stop.
228
229 """
230 cmd, arg, line = self.parseline(line)
231 if not line:
232 return self.emptyline()
233 if cmd is None:
234 return self.default(line)
235 self.lastcmd = line
236 if cmd == '':
237 return self.default(line)
238 else:
239 try:
240 func = getattr(self, 'do_' + cmd)
241 except AttributeError:
242 return self.default(line)
243 return func(arg)
244
246 """Called when an empty line is entered in response to the prompt.
247
248 If this method is not overridden, it repeats the last nonempty
249 command entered.
250
251 """
252 if self.lastcmd:
253 return self.onecmd(self.lastcmd)
254
256 """Called on an input line when the command prefix is not recognized.
257
258 If this method is not overridden, it prints an error message and
259 returns.
260
261 """
262 self.stdout.write('*** Unknown syntax: %s\n'%line)
263
265 """Method called to complete an input line when no command-specific
266 complete_*() method is available.
267
268 By default, it returns an empty list.
269
270 """
271 return []
272
274 dotext = 'do_'+text
275
276 done = set()
277
278 return [a[3:] for a in self.get_names()
279 if a.startswith(dotext) and a not in done and not done.add(a)]
280
282 """Return the next possible completion for 'text'.
283
284 If a command has not been entered, then complete against command list.
285 Otherwise try to call complete_<command> to get list of completions.
286 """
287 if state == 0:
288 import readline
289 origline = readline.get_line_buffer()
290 line = origline.lstrip()
291 stripped = len(origline) - len(line)
292 begidx = readline.get_begidx() - stripped
293 endidx = readline.get_endidx() - stripped
294 if begidx>0:
295 cmd, args, foo = self.parseline(line)
296 if cmd == '':
297 compfunc = self.completedefault
298 else:
299 try:
300 compfunc = getattr(self, 'complete_' + cmd)
301 except AttributeError:
302 compfunc = self.completedefault
303 else:
304 compfunc = self.completenames
305 self.completion_matches = compfunc(text, line, begidx, endidx)
306 try:
307 return self.completion_matches[state]
308 except IndexError:
309 return None
310
312
313
314 names = []
315 classes = [self.__class__]
316 while classes:
317 aclass = classes.pop(0)
318 if aclass.__bases__:
319 classes = classes + list(aclass.__bases__)
320 names = names + dir(aclass)
321 return names
322
325
327 if arg:
328
329 try:
330 func = getattr(self, 'help_' + arg)
331 except AttributeError:
332 try:
333 doc=getattr(self, 'do_' + arg).__doc__
334 if doc:
335 self.stdout.write("%s\n"%str(doc))
336 return
337 except AttributeError:
338 pass
339 self.stdout.write("%s\n"%str(self.nohelp % (arg,)))
340 return
341 func()
342 else:
343 names = self.get_names()
344 cmds_doc = []
345 cmds_undoc = []
346 help = {}
347 for name in names:
348 if name[:5] == 'help_':
349 help[name[5:]]=1
350 names.sort()
351
352 prevname = ''
353 for name in names:
354 if name[:3] == 'do_':
355 if name == prevname:
356 continue
357 prevname = name
358 cmd=name[3:]
359 if cmd in help:
360 cmds_doc.append(cmd)
361 del help[cmd]
362 elif getattr(self, name).__doc__:
363 cmds_doc.append(cmd)
364 else:
365 cmds_undoc.append(cmd)
366 self.stdout.write("%s\n"%str(self.doc_leader))
367 self.print_topics(self.doc_header, cmds_doc, 15,80)
368 self.print_topics(self.misc_header, help.keys(),15,80)
369 self.print_topics(self.undoc_header, cmds_undoc, 15,80)
370
378
380 """Display a list of strings as a compact set of columns.
381
382 Each column is only as wide as necessary.
383 Columns are separated by two spaces (one was not legible enough).
384 """
385 if not list:
386 self.stdout.write("<empty>\n")
387 return
388 nonstrings = [i for i in range(len(list))
389 if not isinstance(list[i], str)]
390 if nonstrings:
391 raise TypeError, ("list[i] not a string for i in %s" %
392 ", ".join(map(str, nonstrings)))
393 size = len(list)
394 if size == 1:
395 self.stdout.write('%s\n'%str(list[0]))
396 return
397
398 for nrows in range(1, len(list)):
399 ncols = (size+nrows-1) // nrows
400 colwidths = []
401 totwidth = -2
402 for col in range(ncols):
403 colwidth = 0
404 for row in range(nrows):
405 i = row + nrows*col
406 if i >= size:
407 break
408 x = list[i]
409 colwidth = max(colwidth, len(x))
410 colwidths.append(colwidth)
411 totwidth += colwidth + 2
412 if totwidth > displaywidth:
413 break
414 if totwidth <= displaywidth:
415 break
416 else:
417 nrows = len(list)
418 ncols = 1
419 colwidths = [0]
420 for row in range(nrows):
421 texts = []
422 for col in range(ncols):
423 i = row + nrows*col
424 if i >= size:
425 x = ""
426 else:
427 x = list[i]
428 texts.append(x)
429 while texts and not texts[-1]:
430 del texts[-1]
431 for col in range(len(texts)):
432 texts[col] = texts[col].ljust(colwidths[col])
433 self.stdout.write("%s\n"%str(" ".join(texts)))
434
435
436
437
438
439
440
441 -class BasicCmd(OriginalCmd):
442 """Simple extension for the readline"""
443
445 """ This has been refactorized here so that it can be called when another
446 program called by MG5 (such as MadAnalysis5) changes this attribute of readline"""
447 if readline:
448 if not 'libedit' in readline.__doc__:
449 readline.set_completion_display_matches_hook(self.print_suggestions)
450 else:
451 readline.set_completion_display_matches_hook()
452
456
458 """convert the multiple category in a formatted list understand by our
459 specific readline parser"""
460
461 if not formatting:
462 return dico
463
464 if 'libedit' in readline.__doc__:
465
466 out = []
467 for name, opt in dico.items():
468 out += opt
469 return out
470
471
472 if not forceCategory and all(len(s) <= 1 for s in dico.values() ):
473 values = set((s[0] for s in dico.values() if len(s)==1))
474 if len(values) == 1:
475 return values
476
477
478 out = []
479 valid=0
480
481 for name, opt in dico.items():
482 if not opt:
483 continue
484 name = name.replace(' ', '_')
485 valid += 1
486 out.append(opt[0].rstrip()+'@@'+name+'@@')
487
488 d = {}
489 for x in opt:
490 d[x] = 1
491 opt = list(d.keys())
492 opt.sort()
493 out += opt
494
495 if not forceCategory and valid == 1:
496 out = out[1:]
497
498 return out
499
500 @debug()
502 """print auto-completions by category"""
503 if not hasattr(self, 'completion_prefix'):
504 self.completion_prefix = ''
505 longest_match_length += len(self.completion_prefix)
506 try:
507 if len(matches) == 1:
508 self.stdout.write(matches[0]+' ')
509 return
510 self.stdout.write('\n')
511 l2 = [a[-2:] for a in matches]
512 if '@@' in l2:
513 nb_column = self.getTerminalSize()//(longest_match_length+1)
514 pos=0
515 for val in self.completion_matches:
516 if val.endswith('@@'):
517 category = val.rsplit('@@',2)[1]
518 category = category.replace('_',' ')
519 self.stdout.write('\n %s:\n%s\n' % (category, '=' * (len(category)+2)))
520 start = 0
521 pos = 0
522 continue
523 elif pos and pos % nb_column ==0:
524 self.stdout.write('\n')
525 self.stdout.write(self.completion_prefix + val + \
526 ' ' * (longest_match_length +1 -len(val)))
527 pos +=1
528 self.stdout.write('\n')
529 else:
530
531 nb_column = self.getTerminalSize()//(longest_match_length+1)
532 for i,val in enumerate(matches):
533 if i and i%nb_column ==0:
534 self.stdout.write('\n')
535 self.stdout.write(self.completion_prefix + val + \
536 ' ' * (longest_match_length +1 -len(val)))
537 self.stdout.write('\n')
538
539 self.stdout.write(self.prompt+readline.get_line_buffer())
540 self.stdout.flush()
541 except Exception, error:
542 if __debug__:
543 logger.error(error)
544
546 def ioctl_GWINSZ(fd):
547 try:
548 import fcntl, termios, struct
549 cr = struct.unpack('hh', fcntl.ioctl(fd, termios.TIOCGWINSZ,
550 '1234'))
551 except Exception:
552 return None
553 return cr
554 cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
555 if not cr:
556 try:
557 fd = os.open(os.ctermid(), os.O_RDONLY)
558 cr = ioctl_GWINSZ(fd)
559 os.close(fd)
560 except Exception:
561 pass
562 if not cr:
563 try:
564 cr = (os.environ['LINES'], os.environ['COLUMNS'])
565 except Exception:
566 cr = (25, 80)
567 return int(cr[1])
568
570 """Return the next possible completion for 'text'.
571 If a command has not been entered, then complete against command list.
572 Otherwise try to call complete_<command> to get list of completions.
573 """
574 if state == 0:
575 import readline
576 origline = readline.get_line_buffer()
577 line = origline.lstrip()
578 stripped = len(origline) - len(line)
579 begidx = readline.get_begidx() - stripped
580 endidx = readline.get_endidx() - stripped
581
582 if ';' in line:
583 begin, line = line.rsplit(';',1)
584 begidx = begidx - len(begin) - 1
585 endidx = endidx - len(begin) - 1
586 if line[:begidx] == ' ' * begidx:
587 begidx=0
588
589 if begidx>0:
590 cmd, args, foo = self.parseline(line)
591 if cmd == '':
592 compfunc = self.completedefault
593 else:
594 try:
595 compfunc = getattr(self, 'complete_' + cmd)
596 except AttributeError, error:
597 compfunc = self.completedefault
598 except Exception, error:
599 misc.sprint(error)
600 else:
601 compfunc = self.completenames
602
603
604 if line and begidx > 2 and line[begidx-2:begidx] == '\ ':
605 Ntext = line.split(os.path.sep)[-1]
606 self.completion_prefix = Ntext.rsplit('\ ', 1)[0] + '\ '
607 to_rm = len(self.completion_prefix) - 1
608 Nbegidx = len(line.rsplit(os.path.sep, 1)[0]) + 1
609 data = compfunc(Ntext.replace('\ ', ' '), line, Nbegidx, endidx)
610 self.completion_matches = [p[to_rm:] for p in data
611 if len(p)>to_rm]
612
613 elif line and line[begidx-1] in ['-',"=",':']:
614 try:
615 sep = line[begidx-1]
616 Ntext = line.split()[-1]
617 self.completion_prefix = Ntext.rsplit(sep,1)[0] + sep
618 to_rm = len(self.completion_prefix)
619 Nbegidx = len(line.rsplit(None, 1)[0])
620 data = compfunc(Ntext, line, Nbegidx, endidx)
621 self.completion_matches = [p[to_rm:] for p in data
622 if len(p)>to_rm]
623 except Exception, error:
624 print error
625 else:
626 self.completion_prefix = ''
627 self.completion_matches = compfunc(text, line, begidx, endidx)
628
629 self.completion_matches = [ l if l[-1] in [' ','@','=',os.path.sep]
630 else ((l + ' ') if not l.endswith('\\$') else l[:-2])
631 for l in self.completion_matches if l]
632
633 try:
634 return self.completion_matches[state]
635 except IndexError, error:
636
637
638
639 return None
640
641 @staticmethod
643 """Split a line of arguments"""
644
645 split = line.split()
646 out=[]
647 tmp=''
648 for data in split:
649 if data[-1] == '\\':
650 tmp += data[:-1]+' '
651 elif tmp:
652 tmp += data
653 tmp = os.path.expanduser(os.path.expandvars(tmp))
654 out.append(tmp)
655
656
657 tmp = ''
658 else:
659 out.append(data)
660 return out
661
662 @staticmethod
664 """Propose completions of text in list"""
665
666 if not text:
667 completions = list
668 else:
669 completions = [ f
670 for f in list
671 if f.startswith(text)
672 ]
673
674 return completions
675
676
677 @staticmethod
678 - def path_completion(text, base_dir = None, only_dirs = False,
679 relative=True):
680 """Propose completions of text to compose a valid path"""
681
682 if base_dir is None:
683 base_dir = os.getcwd()
684 base_dir = os.path.expanduser(os.path.expandvars(base_dir))
685
686 if text == '~':
687 text = '~/'
688 prefix, text = os.path.split(text)
689 prefix = os.path.expanduser(os.path.expandvars(prefix))
690 base_dir = os.path.join(base_dir, prefix)
691 if prefix:
692 prefix += os.path.sep
693
694 if only_dirs:
695 completion = [prefix + f + os.path.sep
696 for f in os.listdir(base_dir)
697 if f.startswith(text) and \
698 os.path.isdir(os.path.join(base_dir, f)) and \
699 (not f.startswith('.') or text.startswith('.'))
700 ]
701 else:
702 completion = [ prefix + f
703 for f in os.listdir(base_dir)
704 if f.startswith(text) and \
705 os.path.isfile(os.path.join(base_dir, f)) and \
706 (not f.startswith('.') or text.startswith('.'))
707 ]
708
709 completion = completion + \
710 [prefix + f + os.path.sep
711 for f in os.listdir(base_dir)
712 if f.startswith(text) and \
713 os.path.isdir(os.path.join(base_dir, f)) and \
714 (not f.startswith('.') or text.startswith('.'))
715 ]
716
717 if relative:
718 completion += [prefix + f for f in ['.'+os.path.sep, '..'+os.path.sep] if \
719 f.startswith(text) and not prefix.startswith('.')]
720
721 completion = [a.replace(' ','\ ') for a in completion]
722 return completion
723
728 """Extension of the cmd object for only the check command"""
729
730 - def check_history(self, args):
731 """check the validity of line"""
732
733 if len(args) > 1:
734 self.help_history()
735 raise self.InvalidCmd('\"history\" command takes at most one argument')
736
737 if not len(args):
738 return
739
740 if args[0] =='.':
741 if not self._export_dir:
742 raise self.InvalidCmd("No default directory is defined for \'.\' option")
743 elif args[0] != 'clean':
744 dirpath = os.path.dirname(args[0])
745 if dirpath and not os.path.exists(dirpath) or \
746 os.path.isdir(args[0]):
747 raise self.InvalidCmd("invalid path %s " % dirpath)
748
750 """check that the line is compatible with save options"""
751
752 if len(args) > 2:
753 self.help_save()
754 raise self.InvalidCmd, 'too many arguments for save command.'
755
756 if len(args) == 2:
757 if args[0] != 'options':
758 self.help_save()
759 raise self.InvalidCmd, '\'%s\' is not recognized as first argument.' % \
760 args[0]
761 else:
762 args.pop(0)
763
765 """Extension of the cmd object for only the help command"""
766
768 logger.info("-- terminates the application",'$MG:color:BLUE')
769 logger.info("syntax: quit",'$MG:color:BLACK')
770
771 help_EOF = help_quit
772
773 - def help_history(self):
774 logger.info("-- interact with the command history.",'$MG:color:BLUE')
775 logger.info("syntax: history [FILEPATH|clean|.] ",'$MG:color:BLACK')
776 logger.info(" > If FILEPATH is \'.\' and \'output\' is done,")
777 logger.info(" Cards/proc_card_mg5.dat will be used.")
778 logger.info(" > If FILEPATH is omitted, the history will be output to stdout.")
779 logger.info(" \"clean\" will remove all entries from the history.")
780
782 logger.info("-- access to the in-line help",'$MG:color:BLUE')
783 logger.info("syntax: help",'$MG:color:BLACK')
784
786 """help text for save"""
787 logger.info("-- save options configuration to filepath.",'$MG:color:BLUE')
788 logger.info("syntax: save [options] [FILEPATH]",'$MG:color:BLACK')
789
791 """help for display command"""
792 logger.info("-- display a the status of various internal state variables",'$MG:color:BLUE')
793 logger.info("syntax: display " + "|".join(self._display_opts),'$MG:color:BLACK')
794
803
804 - def complete_history(self, text, line, begidx, endidx):
805 "Complete the history command"
806
807 args = self.split_arg(line[0:begidx])
808
809
810 if args[-1].endswith(os.path.sep):
811 return self.path_completion(text,
812 os.path.join('.',*[a for a in args \
813 if a.endswith(os.path.sep)]))
814
815 if len(args) == 1:
816 return self.path_completion(text)
817
819 "Complete the save command"
820
821 args = self.split_arg(line[0:begidx])
822
823
824 if len(args) == 1:
825 return self.list_completion(text, ['options'])
826
827
828 if args[-1].endswith(os.path.sep):
829 return self.path_completion(text,
830 pjoin('.',*[a for a in args if a.endswith(os.path.sep)]),
831 only_dirs = True)
832
833
834 if len(args) == 2:
835 return self.path_completion(text)
836
837 -class Cmd(CheckCmd, HelpCmd, CompleteCmd, BasicCmd):
838 """Extension of the cmd.Cmd command line.
839 This extensions supports line breaking, history, comments,
840 internal call to cmdline, path completion,...
841 this class should be MG5 independent"""
842
843
844 next_possibility = {}
845 history_header = ""
846
847 _display_opts = ['options','variable']
848 allow_notification_center = True
849
851 """expected error for wrong command"""
852 pass
853
854 ConfigurationError = InvalidCmd
855
856 debug_output = 'debug'
857 error_debug = """Please report this bug to developers\n
858 More information is found in '%(debug)s'.\n
859 Please attach this file to your report."""
860 config_debug = error_debug
861
862 keyboard_stop_msg = """stopping all current operation
863 in order to quit the program please enter exit"""
864
865
866 if MADEVENT:
867 plugin_path = []
868 else:
869 plugin_path = [pjoin(MG5DIR, 'PLUGIN')]
870 if 'PYTHONPATH' in os.environ:
871 for PluginCandidate in os.environ['PYTHONPATH'].split(':'):
872 try:
873 dirlist = os.listdir(PluginCandidate)
874 except OSError:
875 continue
876 for onedir in dirlist:
877 if onedir == 'MG5aMC_PLUGIN':
878 plugin_path.append(pjoin(PluginCandidate, 'MG5aMC_PLUGIN'))
879 break
880 else:
881 continue
882 break
883
885 """Init history and line continuation"""
886
887 self.log = True
888 self.history = []
889 self.save_line = ''
890 super(Cmd, self).__init__(*arg, **opt)
891 self.__initpos = os.path.abspath(os.getcwd())
892 self.child = None
893 self.mother = None
894 self.inputfile = None
895 self.haspiping = not sys.stdin.isatty()
896 self.stored_line = ''
897
898 if not hasattr(self, 'helporder'):
899 self.helporder = ['Documented commands']
900
902 """Hook method executed once when the cmdloop() method is called."""
903 if self.completekey:
904 try:
905 import readline
906 self.old_completer = readline.get_completer()
907 readline.set_completer(self.complete)
908 readline.parse_and_bind(self.completekey+": complete")
909 except ImportError:
910 readline = None
911 pass
912 if readline and not 'libedit' in readline.__doc__:
913 readline.set_completion_display_matches_hook(self.print_suggestions)
914
915
917
918 self.preloop()
919 if intro is not None:
920 self.intro = intro
921 if self.intro:
922 print self.intro
923 stop = None
924 while not stop:
925 if self.cmdqueue:
926 line = self.cmdqueue[0]
927 del self.cmdqueue[0]
928 else:
929 if self.use_rawinput:
930 try:
931 line = raw_input(self.prompt)
932 except EOFError:
933 line = 'EOF'
934 else:
935 sys.stdout.write(self.prompt)
936 sys.stdout.flush()
937 line = sys.stdin.readline()
938 if not len(line):
939 line = 'EOF'
940 else:
941 line = line[:-1]
942 try:
943 line = self.precmd(line)
944 stop = self.onecmd(line)
945 except BaseException, error:
946 self.error_handling(error, line)
947 if isinstance(error, KeyboardInterrupt):
948 stop = True
949 finally:
950 stop = self.postcmd(stop, line)
951 self.postloop()
952
954 """avoid to have html opening / notification"""
955 self.allow_notification_center = False
956 try:
957 self.options['automatic_html_opening'] = False
958 self.options['notification_center'] = False
959
960 except:
961 pass
962
963
965 """ A suite of additional function needed for in the cmd
966 this implement history, line breaking, comment treatment,...
967 """
968
969 if not line:
970 return line
971
972
973 if self.save_line:
974 line = self.save_line + line
975 self.save_line = ''
976
977 line = line.lstrip()
978
979 if line.endswith('\\'):
980 self.save_line = line[:-1]
981 return ''
982
983
984 if '#' in line:
985 line = line.split('#')[0]
986
987
988 if ';' in line:
989 lines = line.split(';')
990 for subline in lines:
991 if not (subline.startswith("history") or subline.startswith('help') \
992 or subline.startswith('#*')):
993 self.history.append(subline)
994 stop = self.onecmd_orig(subline)
995 stop = self.postcmd(stop, subline)
996 return ''
997
998
999 self.history.append(line)
1000 return line
1001
1002 - def postcmd(self,stop, line):
1003 """ finishing a command
1004 This looks if the command add a special post part."""
1005
1006 if line.strip():
1007 try:
1008 cmd, subline = line.split(None, 1)
1009 except ValueError:
1010 pass
1011 else:
1012 if hasattr(self,'post_%s' %cmd):
1013 stop = getattr(self, 'post_%s' % cmd)(stop, subline)
1014 return stop
1015
1039
1040
1041
1042
1043 - def ask(self, question, default, choices=[], path_msg=None,
1044 timeout = True, fct_timeout=None, ask_class=None, alias={},
1045 first_cmd=None, text_format='4', **opt):
1046 """ ask a question with some pre-define possibility
1047 path info is
1048 """
1049
1050 if path_msg:
1051 path_msg = [path_msg]
1052 else:
1053 path_msg = []
1054
1055 if timeout is True:
1056 try:
1057 timeout = self.options['timeout']
1058 except Exception:
1059 pass
1060
1061
1062 if choices + path_msg:
1063 question += ' ['
1064 question += "\033[%sm%s\033[0m, " % (text_format, default)
1065 for data in choices[:9] + path_msg:
1066 if default == data:
1067 continue
1068 else:
1069 question += "%s, " % data
1070
1071 if len(choices) > 9:
1072 question += '... , '
1073 question = question[:-2]+']'
1074 else:
1075 question += "[\033[%sm%s\033[0m] " % (text_format, default)
1076 if ask_class:
1077 obj = ask_class
1078 elif path_msg:
1079 obj = OneLinePathCompletion
1080 else:
1081 obj = SmartQuestion
1082
1083 if alias:
1084 choices += alias.keys()
1085
1086 question_instance = obj(question, allow_arg=choices, default=default,
1087 mother_interface=self, **opt)
1088
1089 if first_cmd:
1090 if isinstance(first_cmd, str):
1091 question_instance.onecmd(first_cmd)
1092 else:
1093 for line in first_cmd:
1094 question_instance.onecmd(line)
1095 if not self.haspiping:
1096 if hasattr(obj, "haspiping"):
1097 obj.haspiping = self.haspiping
1098
1099
1100
1101
1102 answer = self.check_answer_in_input_file(question_instance, default, path_msg)
1103 if answer is not None:
1104 if answer in alias:
1105 answer = alias[answer]
1106 if ask_class:
1107 line=answer
1108 answer = question_instance.default(line)
1109 question_instance.postcmd(answer, line)
1110 return question_instance.answer
1111 if hasattr(question_instance, 'check_answer_consistency'):
1112 question_instance.check_answer_consistency()
1113 return answer
1114
1115 question = question_instance.question
1116 value = Cmd.timed_input(question, default, timeout=timeout,
1117 fct=question_instance, fct_timeout=fct_timeout)
1118
1119 try:
1120 if value in alias:
1121 value = alias[value]
1122 except TypeError:
1123 pass
1124
1125 if value == default and ask_class:
1126 value = question_instance.default(default)
1127 return value
1128
1138
1140 """check import command"""
1141
1142 if '-f' in args:
1143 self.force = True
1144 args.remove('-f')
1145 if args[0] != 'command':
1146 args.set(0, 'command')
1147 if len(args) != 2:
1148 raise self.InvalidCmd('import command requires one filepath argument')
1149 if not os.path.exists(args[1]):
1150 raise 'No such file or directory %s' % args[1]
1151
1152
1212
1214 """store a line of the input file which should be executed by the higher mother"""
1215
1216 if self.mother:
1217 self.mother.store_line(line)
1218 else:
1219 self.stored_line = line
1220
1222 """return stored line and clean it"""
1223 if self.mother:
1224 value = self.mother.get_stored_line()
1225 self.mother.stored_line = None
1226 else:
1227 value = self.stored_line
1228 self.stored_line = None
1229 return value
1230
1231
1232
1234 """ """
1235
1236 if self.child:
1237 return self.child.nice_error_handling(error, line)
1238
1239 os.chdir(self.__initpos)
1240
1241 self.log = False
1242 if os.path.exists(self.debug_output):
1243 os.remove(self.debug_output)
1244 try:
1245 super(Cmd,self).onecmd('history %s' % self.debug_output.replace(' ', '\ '))
1246 except Exception, error:
1247 logger.error(error)
1248
1249 debug_file = open(self.debug_output, 'a')
1250 traceback.print_exc(file=debug_file)
1251 if hasattr(error, 'filename'):
1252 debug_file.write("Related File: %s\n" % error.filename)
1253
1254 if self.history and line == self.history[-1]:
1255 error_text = 'Command \"%s\" interrupted with error:\n' % line
1256 elif self.history:
1257 error_text = 'Command \"%s\" interrupted in sub-command:\n' %line
1258 error_text += '\"%s\" with error:\n' % self.history[-1]
1259 else:
1260 error_text = ''
1261 error_text += '%s : %s\n' % (error.__class__.__name__,
1262 str(error).replace('\n','\n\t'))
1263 error_text += self.error_debug % {'debug':self.debug_output}
1264 logger_stderr.critical(error_text)
1265
1266
1267
1268 try:
1269 self.do_display('options', debug_file)
1270 except Exception, error:
1271 debug_file.write('Fail to write options with error %s' % error)
1272
1273
1274 for card in ['proc_card_mg5.dat','param_card.dat', 'run_card.dat']:
1275 try:
1276 ff = open(pjoin(self.me_dir, 'Cards', card))
1277 debug_file.write(ff.read())
1278 ff.close()
1279 except Exception:
1280 pass
1281
1282
1283 if self.use_rawinput == False:
1284 return True
1285 return False
1286
1287
1288
1290 if self.child:
1291 return self.child.nice_user_error(error, line)
1292
1293 os.chdir(self.__initpos)
1294 if not self.history or line == self.history[-1]:
1295 error_text = 'Command \"%s\" interrupted with error:\n' % line
1296 else:
1297 error_text = 'Command \"%s\" interrupted in sub-command:\n' %line
1298 error_text += '\"%s\" with error:\n' % self.history[-1]
1299 error_text += '%s : %s' % (error.__class__.__name__,
1300 str(error).replace('\n','\n\t'))
1301 logger_stderr.error(error_text)
1302
1303 if self.use_rawinput == False:
1304 return True
1305
1306 self.history.pop()
1307 return False
1308
1340
1342 """Interpret the argument as though it had been typed in response
1343 to the prompt.
1344
1345 The return value is a flag indicating whether interpretation of
1346 commands by the interpreter should stop.
1347
1348 This allow to pass extra argument for internal call.
1349 """
1350 if '~/' in line and os.environ.has_key('HOME'):
1351 line = line.replace('~/', '%s/' % os.environ['HOME'])
1352 if '#' in line:
1353 line = line.split('#')[0]
1354
1355 line = os.path.expandvars(line)
1356 cmd, arg, line = self.parseline(line)
1357 if not line:
1358 return self.emptyline()
1359 if cmd is None:
1360 return self.default(line)
1361 self.lastcmd = line
1362 if cmd == '':
1363 return self.default(line)
1364 else:
1365 try:
1366 func = getattr(self, 'do_' + cmd)
1367 except AttributeError:
1368 return self.default(line)
1369 return func(arg, **opt)
1370
1407
1408
1409
1410 - def onecmd(self, line, **opt):
1411 """catch all error and stop properly command accordingly"""
1412
1413 try:
1414 return self.onecmd_orig(line, **opt)
1415 except BaseException, error:
1416 self.error_handling(error, line)
1417
1418
1420 """action to perform to close nicely on a keyboard interupt"""
1421 pass
1422
1423 - def exec_cmd(self, line, errorhandling=False, printcmd=True,
1424 precmd=False, postcmd=True,
1425 child=True, **opt):
1445
1447 """for third party call, call the line with pre and postfix treatment
1448 with global error handling"""
1449
1450 return self.exec_cmd(line, errorhandling=True, precmd=True)
1451
1453 """If empty line, do nothing. Default is repeat previous command."""
1454 pass
1455
1456 - def default(self, line, log=True):
1457 """Default action if line is not recognized"""
1458
1459
1460 if log:
1461 logger.warning("Command \"%s\" not recognized, please try again" % \
1462 line.split()[0])
1463 if line.strip() in ['q', '.q', 'stop']:
1464 logger.info("If you want to quit mg5 please type \"exit\".")
1465
1466 if self.history and self.history[-1] == line:
1467 self.history.pop()
1468
1469
1470 - def do_history(self, line):
1471 """write in a file the suite of command that was used"""
1472
1473 args = self.split_arg(line)
1474
1475 self.check_history(args)
1476
1477 if len(args) == 0:
1478 logger.info('\n'.join(self.history))
1479 return
1480 elif args[0] == 'clean':
1481 self.history = []
1482 logger.info('History is cleaned')
1483 return
1484 elif args[0] == '.':
1485 output_file = os.path.join(self._export_dir, 'Cards', \
1486 'proc_card_mg5.dat')
1487 output_file = open(output_file, 'w')
1488 else:
1489 output_file = open(args[0], 'w')
1490
1491
1492 text = self.get_history_header()
1493 text += ('\n'.join(self.history) + '\n')
1494
1495
1496 output_file.write(text)
1497 output_file.close()
1498
1499 if self.log:
1500 logger.info("History written to " + output_file.name)
1501
1502 - def compile(self, *args, **opts):
1506
1507 - def avoid_history_duplicate(self, line, no_break=[]):
1508 """remove all line in history (but the last) starting with line.
1509 up to the point when a line didn't start by something in no_break.
1510 (reading in reverse order)"""
1511
1512 new_history = []
1513 for i in range(1, len(self.history)+1):
1514 cur_line = self.history[-i]
1515 if i == 1:
1516 new_history.append(cur_line)
1517 elif not any((cur_line.startswith(text) for text in no_break)):
1518 to_add = self.history[:-i+1]
1519 to_add.reverse()
1520 new_history += to_add
1521 break
1522 elif cur_line.startswith(line):
1523 continue
1524 else:
1525 new_history.append(cur_line)
1526
1527 new_history.reverse()
1528 self.history[:] = new_history
1529
1530
1532
1533 if self.history:
1534 self.history.pop()
1535
1536
1537 previous_store_line = self.get_stored_line()
1538
1539
1540 if isinstance(filepath, str):
1541 commandline = open(filepath).readlines()
1542 else:
1543 commandline = filepath
1544 oldinputfile = self.inputfile
1545 oldraw = self.use_rawinput
1546 self.inputfile = (l for l in commandline)
1547 self.use_rawinput = False
1548
1549
1550
1551 for line in self.inputfile:
1552
1553 line = line.replace('\n', '').strip()
1554
1555 if line:
1556 self.exec_cmd(line, precmd=True)
1557 stored = self.get_stored_line()
1558 while stored:
1559 line = stored
1560 self.exec_cmd(line, precmd=True)
1561 stored = self.get_stored_line()
1562
1563
1564 if self.child:
1565 self.child.exec_cmd('quit')
1566 self.inputfile = oldinputfile
1567 self.use_rawinput = oldraw
1568
1569
1570 cmd = self
1571 while hasattr(cmd, 'mother') and cmd.mother:
1572 cmd = cmd.mother
1573 cmd.stored_line = previous_store_line
1574 return
1575
1577 """Default history header"""
1578
1579 return self.history_header
1580
1581 - def postloop(self):
1582 """ """
1583
1584 if self.use_rawinput and self.completekey:
1585 try:
1586 import readline
1587 readline.set_completer(self.old_completer)
1588 del self.old_completer
1589 except ImportError:
1590 pass
1591 except AttributeError:
1592 pass
1593
1594 args = self.split_arg(self.lastcmd)
1595 if args and args[0] in ['quit','exit']:
1596 if 'all' in args:
1597 return True
1598 if len(args) >1 and args[1].isdigit():
1599 if args[1] not in ['0', '1']:
1600 return True
1601
1602 return False
1603
1604
1605
1606
1607 @staticmethod
1614
1615 signal.signal(signal.SIGALRM, handle_alarm)
1616
1617 if fct is None:
1618 fct = raw_input
1619
1620 if timeout:
1621 signal.alarm(timeout)
1622 question += '[%ss to answer] ' % (timeout)
1623 try:
1624 result = fct(question)
1625 except TimeOutError:
1626 if noerror:
1627 logger.info('\nuse %s' % default)
1628 if fct_timeout:
1629 fct_timeout(True)
1630 return default
1631 else:
1632 signal.alarm(0)
1633 raise
1634 finally:
1635 signal.alarm(0)
1636 if fct_timeout:
1637 fct_timeout(False)
1638 return result
1639
1640
1641
1642
1643
1644
1645
1647 """Not in help: exit the mainloop() """
1648
1649 if self.child:
1650 self.child.exec_cmd('quit ' + line, printcmd=False)
1651 return
1652 elif self.mother:
1653 self.mother.child = None
1654 if line == 'all':
1655 pass
1656 elif line:
1657 level = int(line) - 1
1658 if level:
1659 self.mother.lastcmd = 'quit %s' % level
1660 logger.info(' ')
1661 return True
1662
1663
1664 do_EOF = do_quit
1665 do_exit = do_quit
1666
1668 """Not in help: propose some usefull possible action """
1669
1670
1671 if line:
1672 return super(Cmd, self).do_help(line)
1673
1674
1675 names = self.get_names()
1676 cmds = {}
1677 names.sort()
1678
1679 prevname = ''
1680 for name in names:
1681 if name[:3] == 'do_':
1682 if name == prevname:
1683 continue
1684 prevname = name
1685 cmdname=name[3:]
1686 try:
1687 doc = getattr(self.cmd, name).__doc__
1688 except Exception:
1689 doc = None
1690 if not doc:
1691 doc = getattr(self, name).__doc__
1692 if not doc:
1693 tag = "Documented commands"
1694 elif ':' in doc:
1695 tag = doc.split(':',1)[0]
1696 else:
1697 tag = "Documented commands"
1698 if tag in cmds:
1699 cmds[tag].append(cmdname)
1700 else:
1701 cmds[tag] = [cmdname]
1702
1703 self.stdout.write("%s\n"%str(self.doc_leader))
1704 for tag in self.helporder:
1705 if tag not in cmds:
1706 continue
1707 header = "%s (type help <topic>):" % tag
1708 self.print_topics(header, cmds[tag], 15,80)
1709 for name, item in cmds.items():
1710 if name in self.helporder:
1711 continue
1712 if name == "Not in help":
1713 continue
1714 header = "%s (type help <topic>):" % name
1715 self.print_topics(header, item, 15,80)
1716
1717
1718
1719 if len(self.history) == 0:
1720 last_action_2 = last_action = 'start'
1721 else:
1722 last_action_2 = last_action = 'none'
1723
1724 pos = 0
1725 authorize = self.next_possibility.keys()
1726 while last_action_2 not in authorize and last_action not in authorize:
1727 pos += 1
1728 if pos > len(self.history):
1729 last_action_2 = last_action = 'start'
1730 break
1731
1732 args = self.history[-1 * pos].split()
1733 last_action = args[0]
1734 if len(args)>1:
1735 last_action_2 = '%s %s' % (last_action, args[1])
1736 else:
1737 last_action_2 = 'none'
1738
1739 logger.info('Contextual Help')
1740 logger.info('===============')
1741 if last_action_2 in authorize:
1742 options = self.next_possibility[last_action_2]
1743 elif last_action in authorize:
1744 options = self.next_possibility[last_action]
1745 else:
1746 return
1747 text = 'The following command(s) may be useful in order to continue.\n'
1748 for option in options:
1749 text+='\t %s \n' % option
1750 logger.info(text)
1751
1753 """Advanced commands: basic display"""
1754
1755 args = self.split_arg(line)
1756
1757
1758 if len(args) == 0:
1759 self.help_display()
1760 raise self.InvalidCmd, 'display require at least one argument'
1761
1762 if args[0] == "options":
1763 outstr = "Value of current Options:\n"
1764 for key, value in self.options.items():
1765 outstr += '%25s \t:\t%s\n' %(key,value)
1766 output.write(outstr)
1767
1768 elif args[0] == "variable":
1769 outstr = "Value of Internal Variable:\n"
1770 try:
1771 var = eval(args[1])
1772 except Exception:
1773 outstr += 'GLOBAL:\nVariable %s is not a global variable\n' % args[1]
1774 else:
1775 outstr += 'GLOBAL:\n'
1776 outstr += misc.nice_representation(var, nb_space=4)
1777
1778 try:
1779 var = eval('self.%s' % args[1])
1780 except Exception:
1781 outstr += 'LOCAL:\nVariable %s is not a local variable\n' % args[1]
1782 else:
1783 outstr += 'LOCAL:\n'
1784 outstr += misc.nice_representation(var, nb_space=4)
1785 split = args[1].split('.')
1786 for i, name in enumerate(split):
1787 try:
1788 __import__('.'.join(split[:i+1]))
1789 exec('%s=sys.modules[\'%s\']' % (split[i], '.'.join(split[:i+1])))
1790 except ImportError:
1791 try:
1792 var = eval(args[1])
1793 except Exception, error:
1794 outstr += 'EXTERNAL:\nVariable %s is not a external variable\n' % args[1]
1795 break
1796 else:
1797 outstr += 'EXTERNAL:\n'
1798 outstr += misc.nice_representation(var, nb_space=4)
1799 else:
1800 var = eval(args[1])
1801 outstr += 'EXTERNAL:\n'
1802 outstr += misc.nice_representation(var, nb_space=4)
1803
1804 pydoc.pager(outstr)
1805
1806
1807 - def do_save(self, line, check=True):
1808 """Save the configuration file"""
1809
1810 args = self.split_arg(line)
1811
1812 if check:
1813 Cmd.check_save(self, args)
1814
1815
1816 if 'HOME' in os.environ and os.environ['HOME'] and \
1817 os.path.exists(pjoin(os.environ['HOME'], '.mg5', 'mg5_configuration.txt')):
1818 base = pjoin(os.environ['HOME'], '.mg5', 'mg5_configuration.txt')
1819 if hasattr(self, 'me_dir'):
1820 basedir = self.me_dir
1821 elif not MADEVENT:
1822 basedir = MG5DIR
1823 else:
1824 basedir = os.getcwd()
1825 elif MADEVENT:
1826
1827 for config_file in ['me5_configuration.txt', 'amcatnlo_configuration.txt']:
1828 if os.path.exists(pjoin(self.me_dir, 'Cards', config_file)):
1829 base = pjoin(self.me_dir, 'Cards', config_file)
1830 basedir = self.me_dir
1831 else:
1832 if hasattr(self, 'me_dir'):
1833 base = pjoin(self.me_dir, 'Cards', 'me5_configuration.txt')
1834 if len(args) == 0 and os.path.exists(base):
1835 self.write_configuration(base, base, self.me_dir)
1836 base = pjoin(MG5DIR, 'input', 'mg5_configuration.txt')
1837 basedir = MG5DIR
1838
1839 if len(args) == 0:
1840 args.append(base)
1841 self.write_configuration(args[0], base, basedir, self.options)
1842
1844 """Write the configuration file"""
1845
1846
1847
1848
1849 logger.info('save configuration file to %s' % filepath)
1850 to_write = to_keep.keys()
1851 text = ""
1852 has_mg5_path = False
1853
1854 for line in file(basefile):
1855 if '=' in line:
1856 data, value = line.split('=',1)
1857 else:
1858 text += line
1859 continue
1860 data = data.strip()
1861 if data.startswith('#'):
1862 key = data[1:].strip()
1863 else:
1864 key = data
1865 if '#' in value:
1866 value, comment = value.split('#',1)
1867 else:
1868 comment = ''
1869 if key in to_keep:
1870 value = str(to_keep[key])
1871 else:
1872 text += line
1873 continue
1874 if key == 'mg5_path':
1875 has_mg5_path = True
1876 try:
1877 to_write.remove(key)
1878 except Exception:
1879 pass
1880 if '_path' in key:
1881
1882
1883 if not os.path.isabs(value):
1884 value = os.path.realpath(os.path.join(basedir, value))
1885 text += '%s = %s # %s \n' % (key, value, comment)
1886
1887 for key in to_write:
1888 if key in to_keep:
1889 text += '%s = %s \n' % (key, to_keep[key])
1890
1891 if not MADEVENT and not has_mg5_path:
1892 text += """\n# MG5 MAIN DIRECTORY\n"""
1893 text += "mg5_path = %s\n" % MG5DIR
1894
1895 writer = open(filepath,'w')
1896 writer.write(text)
1897 writer.close()
1898
1903 """CMD command with shell activate"""
1904
1905
1907 "Run a shell command"
1908
1909 if line.strip() is '':
1910 self.help_shell()
1911 else:
1912 logging.info("running shell command: " + line)
1913 subprocess.call(line, shell=True)
1914
1916 """ add path for shell """
1917
1918
1919
1920 if len(self.split_arg(line[0:begidx])) > 1 and line[begidx - 1] == os.path.sep:
1921 if not text:
1922 text = ''
1923 output = self.path_completion(text,
1924 base_dir=\
1925 self.split_arg(line[0:begidx])[-1])
1926 else:
1927 output = self.path_completion(text)
1928 return output
1929
1931 """help for the shell"""
1932 logger.info("-- run the shell command CMD and catch output",'$MG:color:BLUE')
1933 logger.info("syntax: shell CMD (or ! CMD)",'$MG:color:BLACK')
1934
1942 """ a class for answering a question with the path autocompletion"""
1943
1944 allowpath = False
1946 """Initializing before starting the main loop"""
1947 self.prompt = '>'
1948 self.value = None
1949 BasicCmd.preloop(self)
1950
1951 @property
1954
1955 - def __init__(self, question, allow_arg=[], default=None,
1956 mother_interface=None, *arg, **opt):
1957 self.question = question
1958 self.wrong_answer = 0
1959 self.allow_arg = [str(a) for a in allow_arg]
1960 self.history_header = ''
1961 self.default_value = str(default)
1962 self.mother_interface = mother_interface
1963
1964 if 'case' in opt:
1965 self.casesensitive = opt['case']
1966 del opt['case']
1967 elif 'casesensitive' in opt:
1968 self.casesensitive = opt['casesensitive']
1969 del opt['casesensitive']
1970 else:
1971 self.casesensistive = True
1972 super(SmartQuestion, self).__init__(*arg, **opt)
1973
1974 - def __call__(self, question, reprint_opt=True, **opts):
1975
1976 self.question = question
1977 for key,value in opts:
1978 setattr(self, key, value)
1979 if reprint_opt:
1980 print question
1981 return self.cmdloop()
1982
1983
1985 prev_timer = signal.alarm(0)
1986 if prev_timer:
1987 nb_back = len(line)
1988 self.stdout.write('\b'*nb_back + '[timer stopped]\n')
1989 self.stdout.write(line)
1990 self.stdout.flush()
1991 try:
1992 out = {}
1993 out[' Options'] = Cmd.list_completion(text, self.allow_arg)
1994 out[' Recognized command'] = BasicCmd.completenames(self, text)
1995
1996 return self.deal_multiple_categories(out)
1997 except Exception, error:
1998 print error
1999
2000 completedefault = completenames
2001
2003
2004
2005 return dir(self)
2006
2007 - def onecmd(self, line, **opt):
2008 """catch all error and stop properly command accordingly
2009 Interpret the argument as though it had been typed in response
2010 to the prompt.
2011
2012 The return value is a flag indicating whether interpretation of
2013 commands by the interpreter should stop.
2014
2015 This allow to pass extra argument for internal call.
2016 """
2017 try:
2018 if '~/' in line and os.environ.has_key('HOME'):
2019 line = line.replace('~/', '%s/' % os.environ['HOME'])
2020 line = os.path.expandvars(line)
2021 cmd, arg, line = self.parseline(line)
2022 if not line:
2023 return self.emptyline()
2024 if cmd is None:
2025 return self.default(line)
2026 self.lastcmd = line
2027 if cmd == '':
2028 return self.default(line)
2029 else:
2030 try:
2031 func = getattr(self, 'do_' + cmd)
2032 except AttributeError:
2033 return self.default(line)
2034 return func(arg, **opt)
2035 except Exception as error:
2036 logger.warning(error)
2037 if __debug__:
2038 raise
2039
2040 - def reask(self, reprint_opt=True):
2041 pat = re.compile('\[(\d*)s to answer\]')
2042 prev_timer = signal.alarm(0)
2043
2044 if prev_timer:
2045 if pat.search(self.question):
2046 timeout = int(pat.search(self.question).groups()[0])
2047 else:
2048 timeout=20
2049 print
2050 signal.alarm(timeout)
2051 if reprint_opt:
2052 if not prev_timer:
2053 self.question = pat.sub('',self.question)
2054 print self.question
2055
2056 if self.mother_interface:
2057 answer = self.mother_interface.check_answer_in_input_file(self, 'EOF',
2058 path=self.allowpath)
2059 if answer:
2060 stop = self.default(answer)
2061 self.postcmd(stop, answer)
2062 return False
2063
2064 return False
2065
2067
2068 text=line
2069 out ={}
2070 out['Options'] = Cmd.list_completion(text, self.allow_arg)
2071 out['command'] = BasicCmd.completenames(self, text)
2072
2073 if not text:
2074 if out['Options']:
2075 logger.info( "Here is the list of all valid options:", '$MG:color:BLACK')
2076 logger.info( " "+ "\n ".join(out['Options']))
2077 if out['command']:
2078 logger.info( "Here is the list of command available:", '$MG:color:BLACK')
2079 logger.info( " "+ "\n ".join(out['command']))
2080 else:
2081 if out['Options']:
2082 logger.info( "Here is the list of all valid options starting with \'%s\'" % text, '$MG:color:BLACK')
2083 logger.info( " "+ "\n ".join(out['Options']))
2084 if out['command']:
2085 logger.info( "Here is the list of command available starting with \'%s\':" % text, '$MG:color:BLACK')
2086 logger.info( " "+ "\n ".join(out['command']))
2087 elif not out['Options']:
2088 logger.info( "No possibility starting with \'%s\'" % text, '$MG:color:BLACK')
2089 logger.info( "You can type help XXX, to see all command starting with XXX", '$MG:color:BLACK')
2093
2095 """Default action if line is not recognized"""
2096
2097 if line.strip() == '' and self.default_value is not None:
2098 self.value = self.default_value
2099 else:
2100 self.value = line
2101
2103 """If empty line, return default"""
2104
2105 if self.default_value is not None:
2106 self.value = self.default_value
2107
2108
2109 - def postcmd(self, stop, line):
2110
2111 try:
2112 if self.value in self.allow_arg:
2113 return True
2114 elif str(self.value) == 'EOF':
2115 self.value = self.default_value
2116 return True
2117 elif line and hasattr(self, 'do_%s' % line.split()[0]):
2118 return self.reask()
2119 elif self.value == 'repeat':
2120 return self.reask()
2121 elif len(self.allow_arg)==0:
2122 return True
2123 elif not self.casesensitive:
2124 for ans in self.allow_arg:
2125 if ans.lower() == self.value.lower():
2126 self.value = ans
2127 return True
2128 break
2129 else:
2130 raise Exception
2131 else:
2132 raise Exception
2133 except Exception,error:
2134 if self.wrong_answer < 100:
2135 self.wrong_answer += 1
2136 logger.warning("""%s not valid argument. Valid argument are in (%s).""" \
2137 % (self.value,','.join(self.allow_arg)))
2138 logger.warning('please retry')
2139 return False
2140 else:
2141 self.value = self.default_value
2142 return True
2143
2147
2153
2158 """ a class for answering a question with the path autocompletion"""
2159
2160 completion_prefix=''
2161 allowpath=True
2162
2163 - def completenames(self, text, line, begidx, endidx, formatting=True):
2164 prev_timer = signal.alarm(0)
2165 if prev_timer:
2166 nb_back = len(line)
2167 self.stdout.write('\b'*nb_back + '[timer stopped]\n')
2168 self.stdout.write(line)
2169 self.stdout.flush()
2170
2171 try:
2172 out = {}
2173 out[' Options'] = Cmd.list_completion(text, self.allow_arg)
2174 out[' Path from ./'] = Cmd.path_completion(text, only_dirs = False)
2175 out[' Recognized command'] = BasicCmd.completenames(self, text)
2176
2177 return self.deal_multiple_categories(out, formatting)
2178 except Exception, error:
2179 print error
2180
2186
2188 prev_timer = signal.alarm(0)
2189 if prev_timer:
2190 nb_back = len(line)
2191 self.stdout.write('\b'*nb_back + '[timer stopped]\n')
2192 self.stdout.write(line)
2193 self.stdout.flush()
2194 try:
2195 args = Cmd.split_arg(line[0:begidx])
2196 except Exception, error:
2197 print error
2198
2199
2200 if args[-1].endswith(os.path.sep):
2201
2202 return Cmd.path_completion(text,
2203 os.path.join('.',*[a for a in args \
2204 if a.endswith(os.path.sep)]))
2205 self.completenames(line+text)
2206
2207
2208 - def postcmd(self, stop, line):
2209 try:
2210 if self.value in self.allow_arg:
2211 return True
2212 elif self.value and os.path.isfile(self.value):
2213 return os.path.relpath(self.value)
2214 elif self.value and str(self.value) == 'EOF':
2215 self.value = self.default_value
2216 return True
2217 elif line and hasattr(self, 'do_%s' % line.split()[0]):
2218
2219 reprint_opt = True
2220 elif self.value == 'repeat':
2221 reprint_opt = True
2222 else:
2223 raise Exception
2224 except Exception, error:
2225 print """not valid argument. Valid argument are file path or value in (%s).""" \
2226 % ','.join(self.allow_arg)
2227 print 'please retry'
2228 reprint_opt = False
2229
2230 if line != 'EOF':
2231 return self.reask(reprint_opt)
2232
2239
2240
2241
2242
2243 -class CmdFile(file):
2244 """ a class for command input file -in order to debug cmd \n problem"""
2245
2252
2254 """readline method treating correctly a line whithout \n at the end
2255 (add it)
2256 """
2257 if self.lines:
2258 line = self.lines.pop(0)
2259 else:
2260 return ''
2261
2262 if line.endswith('\n'):
2263 return line
2264 else:
2265 return line + '\n'
2266
2269
2272