|
230
|
1 """Variant on standard library's cmd with extra features.
|
|
|
2
|
|
|
3 To use, simply import cmd2.Cmd instead of cmd.Cmd; use precisely as though you
|
|
|
4 were using the standard library's cmd, while enjoying the extra features.
|
|
|
5
|
|
|
6 Searchable command history (commands: "hi", "li", "run")
|
|
|
7 Load commands from file, save to file, edit commands in file
|
|
|
8 Multi-line commands
|
|
|
9 Case-insensitive commands
|
|
|
10 Special-character shortcut commands (beyond cmd's "@" and "!")
|
|
|
11 Settable environment parameters
|
|
|
12 Optional _onchange_{paramname} called when environment parameter changes
|
|
|
13 Parsing commands with `optparse` options (flags)
|
|
|
14 Redirection to file with >, >>; input from file with <
|
|
|
15 Easy transcript-based testing of applications (see example/example.py)
|
|
|
16
|
|
|
17 Note that redirection with > and | will only work if `self.stdout.write()`
|
|
|
18 is used in place of `print`. The standard library's `cmd` module is
|
|
|
19 written to use `self.stdout.write()`,
|
|
|
20
|
|
|
21 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
|
|
|
22
|
|
|
23 mercurial repository at http://www.assembla.com/wiki/show/python-cmd2
|
|
|
24 CHANGES:
|
|
|
25 As of 0.3.0, options should be specified as `optparse` options. See README.txt.
|
|
|
26 flagReader.py options are still supported for backward compatibility
|
|
|
27 """
|
|
|
28 import cmd, re, os, sys, optparse, subprocess, tempfile, pyparsing, doctest
|
|
233
|
29 import unittest, string, datetime, urllib, inspect, code
|
|
230
|
30 from optparse import make_option
|
|
|
31 __version__ = '0.4.8'
|
|
|
32
|
|
|
33 class OptionParser(optparse.OptionParser):
|
|
|
34 def exit(self, status=0, msg=None):
|
|
|
35 self.values._exit = True
|
|
|
36 if msg:
|
|
|
37 print msg
|
|
|
38
|
|
|
39 def print_help(self, *args, **kwargs):
|
|
|
40 # now, I need to call help of the calling function. Hmm.
|
|
|
41 try:
|
|
|
42 print self._func.__doc__
|
|
|
43 except AttributeError:
|
|
|
44 pass
|
|
|
45 optparse.OptionParser.print_help(self, *args, **kwargs)
|
|
|
46
|
|
|
47 def error(self, msg):
|
|
|
48 """error(msg : string)
|
|
|
49
|
|
|
50 Print a usage message incorporating 'msg' to stderr and exit.
|
|
|
51 If you override this in a subclass, it should not return -- it
|
|
|
52 should either exit or raise an exception.
|
|
|
53 """
|
|
|
54 raise
|
|
|
55
|
|
|
56 def remainingArgs(oldArgs, newArgList):
|
|
|
57 '''
|
|
|
58 >>> remainingArgs('-f bar bar cow', ['bar', 'cow'])
|
|
|
59 'bar cow'
|
|
|
60 '''
|
|
|
61 pattern = '\s+'.join(re.escape(a) for a in newArgList) + '\s*$'
|
|
|
62 matchObj = re.search(pattern, oldArgs)
|
|
|
63 return oldArgs[matchObj.start():]
|
|
|
64
|
|
|
65 def options(option_list):
|
|
|
66 def option_setup(func):
|
|
|
67 optionParser = OptionParser()
|
|
|
68 for opt in option_list:
|
|
|
69 optionParser.add_option(opt)
|
|
|
70 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
|
|
|
71 optionParser._func = func
|
|
|
72 def newFunc(instance, arg):
|
|
|
73 try:
|
|
|
74 opts, newArgList = optionParser.parse_args(arg.split()) # doesn't understand quoted strings shouldn't be dissected!
|
|
|
75 newArgs = remainingArgs(arg, newArgList) # should it permit flags after args?
|
|
|
76 except (optparse.OptionValueError, optparse.BadOptionError,
|
|
|
77 optparse.OptionError, optparse.AmbiguousOptionError,
|
|
|
78 optparse.OptionConflictError), e:
|
|
|
79 print e
|
|
|
80 optionParser.print_help()
|
|
|
81 return
|
|
|
82 if hasattr(opts, '_exit'):
|
|
|
83 return None
|
|
|
84 if hasattr(arg, 'parser'):
|
|
|
85 terminator = arg.parsed.terminator
|
|
|
86 try:
|
|
|
87 if arg.parsed.terminator[0] == '\n':
|
|
|
88 terminator = arg.parsed.terminator[0]
|
|
|
89 except IndexError:
|
|
|
90 pass
|
|
|
91 arg = arg.parser('%s %s%s%s' % (arg.parsed.command, newArgs,
|
|
|
92 terminator, arg.parsed.suffix))
|
|
|
93 else:
|
|
|
94 arg = newArgs
|
|
|
95 result = func(instance, arg, opts)
|
|
|
96 return result
|
|
|
97 newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
|
|
|
98 return newFunc
|
|
|
99 return option_setup
|
|
|
100
|
|
|
101 class PasteBufferError(EnvironmentError):
|
|
|
102 if sys.platform[:3] == 'win':
|
|
|
103 errmsg = """Redirecting to or from paste buffer requires pywin32
|
|
|
104 to be installed on operating system.
|
|
|
105 Download from http://sourceforge.net/projects/pywin32/"""
|
|
|
106 else:
|
|
|
107 errmsg = """Redirecting to or from paste buffer requires xclip
|
|
|
108 to be installed on operating system.
|
|
|
109 On Debian/Ubuntu, 'sudo apt-get install xclip' will install it."""
|
|
|
110 def __init__(self):
|
|
|
111 Exception.__init__(self, self.errmsg)
|
|
|
112
|
|
|
113 '''check here if functions exist; otherwise, stub out'''
|
|
|
114 pastebufferr = """Redirecting to or from paste buffer requires %s
|
|
|
115 to be installed on operating system.
|
|
|
116 %s"""
|
|
|
117 if subprocess.mswindows:
|
|
|
118 try:
|
|
|
119 import win32clipboard
|
|
|
120 def getPasteBuffer():
|
|
|
121 win32clipboard.OpenClipboard(0)
|
|
|
122 try:
|
|
|
123 result = win32clipboard.GetClipboardData()
|
|
|
124 except TypeError:
|
|
|
125 result = '' #non-text
|
|
|
126 win32clipboard.CloseClipboard()
|
|
|
127 return result
|
|
|
128 def writeToPasteBuffer(txt):
|
|
|
129 win32clipboard.OpenClipboard(0)
|
|
|
130 win32clipboard.EmptyClipboard()
|
|
|
131 win32clipboard.SetClipboardText(txt)
|
|
|
132 win32clipboard.CloseClipboard()
|
|
|
133 except ImportError:
|
|
|
134 def getPasteBuffer(*args):
|
|
|
135 raise OSError, pastebufferr % ('pywin32', 'Download from http://sourceforge.net/projects/pywin32/')
|
|
|
136 setPasteBuffer = getPasteBuffer
|
|
|
137 else:
|
|
|
138 can_clip = False
|
|
|
139 try:
|
|
|
140 subprocess.check_call('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
141 can_clip = True
|
|
|
142 except AttributeError: # check_call not defined, Python < 2.5
|
|
|
143 teststring = 'Testing for presence of xclip.'
|
|
|
144 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
145 xclipproc.stdin.write(teststring)
|
|
|
146 xclipproc.stdin.close()
|
|
|
147 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
148 if xclipproc.stdout.read() == teststring:
|
|
|
149 can_clip = True
|
|
|
150 except (subprocess.CalledProcessError, OSError, IOError):
|
|
|
151 pass
|
|
|
152 if can_clip:
|
|
|
153 def getPasteBuffer():
|
|
|
154 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
155 return xclipproc.stdout.read()
|
|
|
156 def writeToPasteBuffer(txt):
|
|
|
157 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
158 xclipproc.stdin.write(txt)
|
|
|
159 xclipproc.stdin.close()
|
|
|
160 # but we want it in both the "primary" and "mouse" clipboards
|
|
|
161 xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
162 xclipproc.stdin.write(txt)
|
|
|
163 xclipproc.stdin.close()
|
|
|
164 else:
|
|
|
165 def getPasteBuffer(*args):
|
|
|
166 raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"')
|
|
|
167 setPasteBuffer = getPasteBuffer
|
|
|
168 writeToPasteBuffer = getPasteBuffer
|
|
|
169
|
|
|
170 pyparsing.ParserElement.setDefaultWhitespaceChars(' \t')
|
|
|
171
|
|
|
172 class ParsedString(str):
|
|
|
173 pass
|
|
|
174
|
|
|
175 class SkipToLast(pyparsing.SkipTo):
|
|
|
176 def parseImpl( self, instring, loc, doActions=True ):
|
|
|
177 resultStore = []
|
|
|
178 startLoc = loc
|
|
|
179 instrlen = len(instring)
|
|
|
180 expr = self.expr
|
|
|
181 failParse = False
|
|
|
182 while loc <= instrlen:
|
|
|
183 try:
|
|
|
184 if self.failOn:
|
|
|
185 failParse = True
|
|
|
186 self.failOn.tryParse(instring, loc)
|
|
|
187 failParse = False
|
|
|
188 loc = expr._skipIgnorables( instring, loc )
|
|
|
189 expr._parse( instring, loc, doActions=False, callPreParse=False )
|
|
|
190 skipText = instring[startLoc:loc]
|
|
|
191 if self.includeMatch:
|
|
|
192 loc,mat = expr._parse(instring,loc,doActions,callPreParse=False)
|
|
|
193 if mat:
|
|
|
194 skipRes = ParseResults( skipText )
|
|
|
195 skipRes += mat
|
|
|
196 resultStore.append((loc, [ skipRes ]))
|
|
|
197 else:
|
|
|
198 resultStore,append((loc, [ skipText ]))
|
|
|
199 else:
|
|
|
200 resultStore.append((loc, [ skipText ]))
|
|
|
201 loc += 1
|
|
|
202 except (pyparsing.ParseException,IndexError):
|
|
|
203 if failParse:
|
|
|
204 raise
|
|
|
205 else:
|
|
|
206 loc += 1
|
|
|
207 if resultStore:
|
|
|
208 return resultStore[-1]
|
|
|
209 else:
|
|
|
210 exc = self.myException
|
|
|
211 exc.loc = loc
|
|
|
212 exc.pstr = instring
|
|
|
213 raise exc
|
|
|
214
|
|
|
215 def replace_with_file_contents(fname):
|
|
|
216 if fname:
|
|
|
217 try:
|
|
|
218 result = open(os.path.expanduser(fname[0])).read()
|
|
|
219 except IOError:
|
|
|
220 result = '< %s' % fname[0] # wasn't a file after all
|
|
|
221 else:
|
|
|
222 result = getPasteBuffer()
|
|
233
|
223 return result
|
|
|
224
|
|
230
|
225 class Cmd(cmd.Cmd):
|
|
|
226 echo = False
|
|
|
227 case_insensitive = True
|
|
|
228 continuation_prompt = '> '
|
|
|
229 timing = False
|
|
|
230 legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit # make sure your terminators are not in here!
|
|
|
231 shortcuts = {'?': 'help', '!': 'shell', '@': 'load' }
|
|
|
232 excludeFromHistory = '''run r list l history hi ed edit li eof'''.split()
|
|
|
233 noSpecialParse = 'set ed edit exit'.split()
|
|
|
234 defaultExtension = 'txt'
|
|
|
235 default_file_name = 'command.txt'
|
|
|
236 abbrev = True
|
|
233
|
237 nonpythoncommand = 'cmd'
|
|
230
|
238 settable = ['prompt', 'continuation_prompt', 'default_file_name', 'editor',
|
|
|
239 'case_insensitive', 'echo', 'timing', 'abbrev']
|
|
|
240 settable.sort()
|
|
|
241
|
|
|
242 editor = os.environ.get('EDITOR')
|
|
|
243 _STOP_AND_EXIT = 2
|
|
|
244 if not editor:
|
|
|
245 if sys.platform[:3] == 'win':
|
|
|
246 editor = 'notepad'
|
|
|
247 else:
|
|
|
248 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
|
|
|
249 if not os.system('which %s' % (editor)):
|
|
|
250 break
|
|
|
251
|
|
|
252 def do_cmdenvironment(self, args):
|
|
|
253 '''Summary report of interactive parameters.'''
|
|
|
254 self.stdout.write("""
|
|
|
255 Commands are %(casesensitive)scase-sensitive.
|
|
|
256 Commands may be terminated with: %(terminators)s
|
|
|
257 Settable parameters: %(settable)s
|
|
|
258 """ %
|
|
|
259 { 'casesensitive': (self.case_insensitive and 'not ') or '',
|
|
|
260 'terminators': str(self.terminators),
|
|
|
261 'settable': ' '.join(self.settable)
|
|
|
262 })
|
|
|
263
|
|
|
264 def do_help(self, arg):
|
|
|
265 try:
|
|
|
266 fn = getattr(self, 'do_' + arg)
|
|
|
267 if fn and fn.optionParser:
|
|
|
268 fn.optionParser.print_help(file=self.stdout)
|
|
|
269 return
|
|
|
270 except AttributeError:
|
|
|
271 pass
|
|
|
272 cmd.Cmd.do_help(self, arg)
|
|
|
273
|
|
|
274 def __init__(self, *args, **kwargs):
|
|
|
275 cmd.Cmd.__init__(self, *args, **kwargs)
|
|
|
276 self.history = History()
|
|
|
277 self._init_parser()
|
|
|
278 self.pystate = {}
|
|
|
279
|
|
|
280 def do_shortcuts(self, args):
|
|
|
281 """Lists single-key shortcuts available."""
|
|
|
282 result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in self.shortcuts.items())
|
|
|
283 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
|
|
|
284
|
|
|
285 prefixParser = pyparsing.Empty()
|
|
|
286 commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment])
|
|
|
287 commentGrammars.addParseAction(lambda x: '')
|
|
|
288 commentInProgress = ((pyparsing.White() | pyparsing.lineStart) +
|
|
|
289 pyparsing.Literal('/*') + pyparsing.SkipTo(pyparsing.stringEnd))
|
|
|
290 # `blah/*` means `everything in directory `blah`, not comment
|
|
|
291 terminators = [';']
|
|
|
292 blankLinesAllowed = False
|
|
|
293 multilineCommands = []
|
|
|
294
|
|
|
295 def _init_parser(self):
|
|
|
296 r'''
|
|
|
297 >>> c = Cmd()
|
|
|
298 >>> c.multilineCommands = ['multiline']
|
|
|
299 >>> c.case_insensitive = True
|
|
|
300 >>> c._init_parser()
|
|
|
301 >>> print c.parser.parseString('').dump()
|
|
|
302 []
|
|
|
303 >>> print c.parser.parseString('/* empty command */').dump()
|
|
|
304 []
|
|
|
305 >>> print c.parser.parseString('plainword').dump()
|
|
|
306 ['plainword', '']
|
|
|
307 - command: plainword
|
|
|
308 - statement: ['plainword', '']
|
|
|
309 - command: plainword
|
|
|
310 >>> print c.parser.parseString('termbare;').dump()
|
|
|
311 ['termbare', '', ';', '']
|
|
|
312 - command: termbare
|
|
|
313 - statement: ['termbare', '', ';']
|
|
|
314 - command: termbare
|
|
|
315 - terminator: ;
|
|
|
316 - terminator: ;
|
|
|
317 >>> print c.parser.parseString('termbare; suffx').dump()
|
|
|
318 ['termbare', '', ';', 'suffx']
|
|
|
319 - command: termbare
|
|
|
320 - statement: ['termbare', '', ';']
|
|
|
321 - command: termbare
|
|
|
322 - terminator: ;
|
|
|
323 - suffix: suffx
|
|
|
324 - terminator: ;
|
|
|
325 >>> print c.parser.parseString('barecommand').dump()
|
|
|
326 ['barecommand', '']
|
|
|
327 - command: barecommand
|
|
|
328 - statement: ['barecommand', '']
|
|
|
329 - command: barecommand
|
|
|
330 >>> print c.parser.parseString('COMmand with args').dump()
|
|
|
331 ['command', 'with args']
|
|
|
332 - args: with args
|
|
|
333 - command: command
|
|
|
334 - statement: ['command', 'with args']
|
|
|
335 - args: with args
|
|
|
336 - command: command
|
|
|
337 >>> print c.parser.parseString('command with args and terminator; and suffix').dump()
|
|
|
338 ['command', 'with args and terminator', ';', 'and suffix']
|
|
|
339 - args: with args and terminator
|
|
|
340 - command: command
|
|
|
341 - statement: ['command', 'with args and terminator', ';']
|
|
|
342 - args: with args and terminator
|
|
|
343 - command: command
|
|
|
344 - terminator: ;
|
|
|
345 - suffix: and suffix
|
|
|
346 - terminator: ;
|
|
|
347 >>> print c.parser.parseString('simple | piped').dump()
|
|
|
348 ['simple', '', '|', ' piped']
|
|
|
349 - command: simple
|
|
|
350 - pipeTo: piped
|
|
|
351 - statement: ['simple', '']
|
|
|
352 - command: simple
|
|
|
353 >>> print c.parser.parseString('double-pipe || is not a pipe').dump()
|
|
|
354 ['double', '-pipe || is not a pipe']
|
|
|
355 - args: -pipe || is not a pipe
|
|
|
356 - command: double
|
|
|
357 - statement: ['double', '-pipe || is not a pipe']
|
|
|
358 - args: -pipe || is not a pipe
|
|
|
359 - command: double
|
|
|
360 >>> print c.parser.parseString('command with args, terminator;sufx | piped').dump()
|
|
|
361 ['command', 'with args, terminator', ';', 'sufx', '|', ' piped']
|
|
|
362 - args: with args, terminator
|
|
|
363 - command: command
|
|
|
364 - pipeTo: piped
|
|
|
365 - statement: ['command', 'with args, terminator', ';']
|
|
|
366 - args: with args, terminator
|
|
|
367 - command: command
|
|
|
368 - terminator: ;
|
|
|
369 - suffix: sufx
|
|
|
370 - terminator: ;
|
|
|
371 >>> print c.parser.parseString('output into > afile.txt').dump()
|
|
|
372 ['output', 'into', '>', 'afile.txt']
|
|
|
373 - args: into
|
|
|
374 - command: output
|
|
|
375 - output: >
|
|
|
376 - outputTo: afile.txt
|
|
|
377 - statement: ['output', 'into']
|
|
|
378 - args: into
|
|
|
379 - command: output
|
|
|
380 >>> print c.parser.parseString('output into;sufx | pipethrume plz > afile.txt').dump()
|
|
|
381 ['output', 'into', ';', 'sufx', '|', ' pipethrume plz', '>', 'afile.txt']
|
|
|
382 - args: into
|
|
|
383 - command: output
|
|
|
384 - output: >
|
|
|
385 - outputTo: afile.txt
|
|
|
386 - pipeTo: pipethrume plz
|
|
|
387 - statement: ['output', 'into', ';']
|
|
|
388 - args: into
|
|
|
389 - command: output
|
|
|
390 - terminator: ;
|
|
|
391 - suffix: sufx
|
|
|
392 - terminator: ;
|
|
|
393 >>> print c.parser.parseString('output to paste buffer >> ').dump()
|
|
|
394 ['output', 'to paste buffer', '>>', '']
|
|
|
395 - args: to paste buffer
|
|
|
396 - command: output
|
|
|
397 - output: >>
|
|
|
398 - statement: ['output', 'to paste buffer']
|
|
|
399 - args: to paste buffer
|
|
|
400 - command: output
|
|
|
401 >>> print c.parser.parseString('ignore the /* commented | > */ stuff;').dump()
|
|
|
402 ['ignore', 'the /* commented | > */ stuff', ';', '']
|
|
|
403 - args: the /* commented | > */ stuff
|
|
|
404 - command: ignore
|
|
|
405 - statement: ['ignore', 'the /* commented | > */ stuff', ';']
|
|
|
406 - args: the /* commented | > */ stuff
|
|
|
407 - command: ignore
|
|
|
408 - terminator: ;
|
|
|
409 - terminator: ;
|
|
|
410 >>> print c.parser.parseString('has > inside;').dump()
|
|
|
411 ['has', '> inside', ';', '']
|
|
|
412 - args: > inside
|
|
|
413 - command: has
|
|
|
414 - statement: ['has', '> inside', ';']
|
|
|
415 - args: > inside
|
|
|
416 - command: has
|
|
|
417 - terminator: ;
|
|
|
418 - terminator: ;
|
|
|
419 >>> print c.parser.parseString('multiline has > inside an unfinished command').dump()
|
|
|
420 ['multiline', ' has > inside an unfinished command']
|
|
|
421 - multilineCommand: multiline
|
|
|
422 >>> print c.parser.parseString('multiline has > inside;').dump()
|
|
|
423 ['multiline', 'has > inside', ';', '']
|
|
|
424 - args: has > inside
|
|
|
425 - multilineCommand: multiline
|
|
|
426 - statement: ['multiline', 'has > inside', ';']
|
|
|
427 - args: has > inside
|
|
|
428 - multilineCommand: multiline
|
|
|
429 - terminator: ;
|
|
|
430 - terminator: ;
|
|
|
431 >>> print c.parser.parseString('multiline command /* with comment in progress;').dump()
|
|
|
432 ['multiline', ' command /* with comment in progress;']
|
|
|
433 - multilineCommand: multiline
|
|
|
434 >>> print c.parser.parseString('multiline command /* with comment complete */ is done;').dump()
|
|
|
435 ['multiline', 'command /* with comment complete */ is done', ';', '']
|
|
|
436 - args: command /* with comment complete */ is done
|
|
|
437 - multilineCommand: multiline
|
|
|
438 - statement: ['multiline', 'command /* with comment complete */ is done', ';']
|
|
|
439 - args: command /* with comment complete */ is done
|
|
|
440 - multilineCommand: multiline
|
|
|
441 - terminator: ;
|
|
|
442 - terminator: ;
|
|
|
443 >>> print c.parser.parseString('multiline command ends\n\n').dump()
|
|
|
444 ['multiline', 'command ends', '\n', '\n']
|
|
|
445 - args: command ends
|
|
|
446 - multilineCommand: multiline
|
|
|
447 - statement: ['multiline', 'command ends', '\n', '\n']
|
|
|
448 - args: command ends
|
|
|
449 - multilineCommand: multiline
|
|
|
450 - terminator: ['\n', '\n']
|
|
|
451 - terminator: ['\n', '\n']
|
|
|
452 '''
|
|
|
453 outputParser = (pyparsing.Literal('>>') | (pyparsing.WordStart() + '>') | pyparsing.Regex('[^=]>'))('output')
|
|
|
454
|
|
|
455 terminatorParser = pyparsing.Or([(hasattr(t, 'parseString') and t) or pyparsing.Literal(t) for t in self.terminators])('terminator')
|
|
|
456 stringEnd = pyparsing.stringEnd ^ '\nEOF'
|
|
|
457 self.multilineCommand = pyparsing.Or([pyparsing.Keyword(c, caseless=self.case_insensitive) for c in self.multilineCommands])('multilineCommand')
|
|
|
458 oneLineCommand = (~self.multilineCommand + pyparsing.Word(self.legalChars))('command')
|
|
|
459 pipe = pyparsing.Keyword('|', identChars='|')
|
|
|
460 self.commentGrammars.ignore(pyparsing.quotedString).setParseAction(lambda x: '')
|
|
|
461 self.commentInProgress.ignore(pyparsing.quotedString).ignore(pyparsing.cStyleComment)
|
|
|
462 afterElements = \
|
|
|
463 pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \
|
|
|
464 pyparsing.Optional(outputParser + pyparsing.SkipTo(stringEnd).setParseAction(lambda x: x[0].strip())('outputTo'))
|
|
|
465 if self.case_insensitive:
|
|
|
466 self.multilineCommand.setParseAction(lambda x: x[0].lower())
|
|
|
467 oneLineCommand.setParseAction(lambda x: x[0].lower())
|
|
|
468 if self.blankLinesAllowed:
|
|
|
469 self.blankLineTerminationParser = pyparsing.NoMatch
|
|
|
470 else:
|
|
|
471 self.blankLineTerminator = (pyparsing.lineEnd + pyparsing.lineEnd)('terminator')
|
|
|
472 self.blankLineTerminator.setResultsName('terminator')
|
|
|
473 self.blankLineTerminationParser = ((self.multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(self.blankLineTerminator).setParseAction(lambda x: x[0].strip())('args') + self.blankLineTerminator)('statement')
|
|
|
474 self.multilineParser = (((self.multilineCommand ^ oneLineCommand) + SkipToLast(terminatorParser).setParseAction(lambda x: x[0].strip())('args') + terminatorParser)('statement') +
|
|
|
475 pyparsing.SkipTo(outputParser ^ pipe ^ stringEnd).setParseAction(lambda x: x[0].strip())('suffix') + afterElements)
|
|
|
476 self.singleLineParser = ((oneLineCommand + pyparsing.SkipTo(terminatorParser ^ stringEnd ^ pipe ^ outputParser).setParseAction(lambda x:x[0].strip())('args'))('statement') +
|
|
|
477 pyparsing.Optional(terminatorParser) + afterElements)
|
|
|
478 #self.multilineParser = self.multilineParser.setResultsName('multilineParser')
|
|
|
479 #self.singleLineParser = self.singleLineParser.setResultsName('singleLineParser')
|
|
|
480 #self.blankLineTerminationParser = self.blankLineTerminationParser.setResultsName('blankLineTerminatorParser')
|
|
|
481 self.parser = (
|
|
|
482 stringEnd |
|
|
|
483 self.prefixParser + self.multilineParser |
|
|
|
484 self.prefixParser + self.singleLineParser |
|
|
|
485 self.prefixParser + self.blankLineTerminationParser |
|
|
|
486 self.prefixParser + self.multilineCommand + pyparsing.SkipTo(stringEnd)
|
|
|
487 )
|
|
|
488 self.parser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
|
|
|
489
|
|
|
490 inputMark = pyparsing.Literal('<')
|
|
|
491 inputMark.setParseAction(lambda x: '')
|
|
|
492 fileName = pyparsing.Word(self.legalChars + '/\\')
|
|
|
493 inputFrom = fileName('inputFrom')
|
|
|
494 inputFrom.setParseAction(replace_with_file_contents)
|
|
|
495 # a not-entirely-satisfactory way of distinguishing < as in "import from" from <
|
|
|
496 # as in "lesser than"
|
|
|
497 self.inputParser = inputMark + pyparsing.Optional(inputFrom) + pyparsing.Optional('>') + \
|
|
|
498 pyparsing.Optional(fileName) + (pyparsing.stringEnd | '|')
|
|
|
499 self.inputParser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
|
|
|
500
|
|
|
501 def preparse(self, raw, **kwargs):
|
|
|
502 return raw
|
|
|
503
|
|
|
504 def parsed(self, raw, **kwargs):
|
|
|
505 if isinstance(raw, ParsedString):
|
|
|
506 p = raw
|
|
|
507 else:
|
|
|
508 raw = self.preparse(raw, **kwargs)
|
|
|
509 s = self.inputParser.transformString(raw.lstrip())
|
|
|
510 for (shortcut, expansion) in self.shortcuts.items():
|
|
|
511 if s.lower().startswith(shortcut):
|
|
|
512 s = s.replace(shortcut, expansion + ' ', 1)
|
|
|
513 break
|
|
|
514 result = self.parser.parseString(s)
|
|
|
515 result['command'] = result.multilineCommand or result.command
|
|
|
516 result['raw'] = raw
|
|
|
517 result['clean'] = self.commentGrammars.transformString(result.args)
|
|
|
518 result['expanded'] = s
|
|
|
519 p = ParsedString(result.clean)
|
|
|
520 p.parsed = result
|
|
|
521 p.parser = self.parsed
|
|
|
522 for (key, val) in kwargs.items():
|
|
|
523 p.parsed[key] = val
|
|
|
524 return p
|
|
|
525
|
|
|
526 def postparsing_precmd(self, statement):
|
|
|
527 stop = 0
|
|
|
528 return stop, statement
|
|
|
529 def postparsing_postcmd(self, stop):
|
|
|
530 return stop
|
|
|
531 def onecmd(self, line):
|
|
|
532 """Interpret the argument as though it had been typed in response
|
|
|
533 to the prompt.
|
|
|
534
|
|
|
535 This may be overridden, but should not normally need to be;
|
|
|
536 see the precmd() and postcmd() methods for useful execution hooks.
|
|
|
537 The return value is a flag indicating whether interpretation of
|
|
|
538 commands by the interpreter should stop.
|
|
|
539
|
|
|
540 This (`cmd2`) version of `onecmd` already override's `cmd`'s `onecmd`.
|
|
|
541
|
|
|
542 """
|
|
|
543 if not line:
|
|
|
544 return self.emptyline()
|
|
|
545 if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line):
|
|
|
546 return 0 # command was empty except for comments
|
|
|
547 try:
|
|
|
548 statement = self.parsed(line)
|
|
|
549 while statement.parsed.multilineCommand and (statement.parsed.terminator == ''):
|
|
|
550 statement = '%s\n%s' % (statement.parsed.raw,
|
|
|
551 self.pseudo_raw_input(self.continuation_prompt))
|
|
|
552 statement = self.parsed(statement)
|
|
|
553 except Exception, e:
|
|
|
554 print e
|
|
|
555 return 0
|
|
|
556
|
|
|
557 try:
|
|
|
558 (stop, statement) = self.postparsing_precmd(statement)
|
|
|
559 except Exception, e:
|
|
|
560 print str(e)
|
|
|
561 return 0
|
|
|
562 if stop:
|
|
|
563 return self.postparsing_postcmd(stop)
|
|
|
564
|
|
|
565 if not statement.parsed.command:
|
|
|
566 return self.postparsing_postcmd(stop=0)
|
|
|
567
|
|
|
568 statekeeper = None
|
|
|
569
|
|
|
570 if statement.parsed.pipeTo:
|
|
|
571 redirect = subprocess.Popen(statement.parsed.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
|
|
|
572 statekeeper = Statekeeper(self, ('stdout',))
|
|
|
573 self.stdout = redirect.stdin
|
|
|
574 elif statement.parsed.output:
|
|
|
575 statekeeper = Statekeeper(self, ('stdout',))
|
|
|
576 if statement.parsed.outputTo:
|
|
|
577 mode = 'w'
|
|
|
578 if statement.parsed.output == '>>':
|
|
|
579 mode = 'a'
|
|
|
580 try:
|
|
|
581 self.stdout = open(os.path.expanduser(statement.parsed.outputTo), mode)
|
|
|
582 except OSError, e:
|
|
|
583 print e
|
|
|
584 return self.postparsing_postcmd(stop=0)
|
|
|
585 else:
|
|
|
586 statekeeper = Statekeeper(self, ('stdout',))
|
|
|
587 self.stdout = tempfile.TemporaryFile()
|
|
|
588 if statement.parsed.output == '>>':
|
|
|
589 self.stdout.write(getPasteBuffer())
|
|
|
590 try:
|
|
|
591 # "heart" of the command, replace's cmd's onecmd()
|
|
|
592 self.lastcmd = statement.parsed.expanded
|
|
|
593 try:
|
|
|
594 func = getattr(self, 'do_' + statement.parsed.command)
|
|
|
595 except AttributeError:
|
|
|
596 func = None
|
|
|
597 if self.abbrev: # accept shortened versions of commands
|
|
232
|
598 funcs = [f for (fname, function) in inspect.getmembers(self, inspect.ismethod)
|
|
230
|
599 if fname.startswith('do_' + statement.parsed.command)]
|
|
|
600 if len(funcs) == 1:
|
|
|
601 func = funcs[0]
|
|
|
602 if not func:
|
|
|
603 return self.postparsing_postcmd(self.default(statement))
|
|
|
604 timestart = datetime.datetime.now()
|
|
|
605 stop = func(statement)
|
|
|
606 if self.timing:
|
|
|
607 print 'Elapsed: %s' % str(datetime.datetime.now() - timestart)
|
|
|
608 except Exception, e:
|
|
|
609 print e
|
|
|
610 try:
|
|
|
611 if statement.parsed.command not in self.excludeFromHistory:
|
|
|
612 self.history.append(statement.parsed.raw)
|
|
|
613 finally:
|
|
|
614 if statekeeper:
|
|
|
615 if statement.parsed.output and not statement.parsed.outputTo:
|
|
|
616 self.stdout.seek(0)
|
|
|
617 try:
|
|
|
618 writeToPasteBuffer(self.stdout.read())
|
|
|
619 except Exception, e:
|
|
|
620 print str(e)
|
|
|
621 elif statement.parsed.pipeTo:
|
|
|
622 for result in redirect.communicate():
|
|
|
623 statekeeper.stdout.write(result or '')
|
|
|
624 self.stdout.close()
|
|
|
625 statekeeper.restore()
|
|
|
626
|
|
|
627 return self.postparsing_postcmd(stop)
|
|
|
628
|
|
|
629 def pseudo_raw_input(self, prompt):
|
|
|
630 """copied from cmd's cmdloop; like raw_input, but accounts for changed stdin, stdout"""
|
|
|
631
|
|
|
632 if self.use_rawinput:
|
|
|
633 try:
|
|
|
634 line = raw_input(prompt)
|
|
|
635 except EOFError:
|
|
|
636 line = 'EOF'
|
|
|
637 else:
|
|
|
638 self.stdout.write(prompt)
|
|
|
639 self.stdout.flush()
|
|
|
640 line = self.stdin.readline()
|
|
|
641 if not len(line):
|
|
|
642 line = 'EOF'
|
|
|
643 else:
|
|
|
644 if line[-1] == '\n': # this was always true in Cmd
|
|
|
645 line = line[:-1]
|
|
|
646 return line
|
|
|
647
|
|
|
648 def cmdloop(self, intro=None):
|
|
|
649 """Repeatedly issue a prompt, accept input, parse an initial prefix
|
|
|
650 off the received input, and dispatch to action methods, passing them
|
|
|
651 the remainder of the line as argument.
|
|
|
652 """
|
|
|
653
|
|
|
654 # An almost perfect copy from Cmd; however, the pseudo_raw_input portion
|
|
|
655 # has been split out so that it can be called separately
|
|
|
656
|
|
|
657 self.preloop()
|
|
|
658 if self.use_rawinput and self.completekey:
|
|
|
659 try:
|
|
|
660 import readline
|
|
|
661 self.old_completer = readline.get_completer()
|
|
|
662 readline.set_completer(self.complete)
|
|
|
663 readline.parse_and_bind(self.completekey+": complete")
|
|
|
664 except ImportError:
|
|
|
665 pass
|
|
|
666 try:
|
|
|
667 if intro is not None:
|
|
|
668 self.intro = intro
|
|
|
669 if self.intro:
|
|
|
670 self.stdout.write(str(self.intro)+"\n")
|
|
|
671 stop = None
|
|
|
672 while not stop:
|
|
|
673 if self.cmdqueue:
|
|
|
674 line = self.cmdqueue.pop(0)
|
|
|
675 else:
|
|
|
676 line = self.pseudo_raw_input(self.prompt)
|
|
|
677 if (self.echo) and (isinstance(self.stdin, file)):
|
|
|
678 self.stdout.write(line + '\n')
|
|
|
679 line = self.precmd(line)
|
|
|
680 stop = self.onecmd(line)
|
|
|
681 stop = self.postcmd(stop, line)
|
|
|
682 self.postloop()
|
|
|
683 finally:
|
|
|
684 if self.use_rawinput and self.completekey:
|
|
|
685 try:
|
|
|
686 import readline
|
|
|
687 readline.set_completer(self.old_completer)
|
|
|
688 except ImportError:
|
|
|
689 pass
|
|
|
690 return stop
|
|
|
691
|
|
|
692 def do_EOF(self, arg):
|
|
|
693 return True
|
|
|
694 do_eof = do_EOF
|
|
|
695
|
|
|
696 def showParam(self, param):
|
|
|
697 any_shown = False
|
|
|
698 param = param.strip().lower()
|
|
|
699 for p in self.settable:
|
|
|
700 if p.startswith(param):
|
|
|
701 val = getattr(self, p)
|
|
|
702 self.stdout.write('%s: %s\n' % (p, str(getattr(self, p))))
|
|
|
703 any_shown = True
|
|
|
704 if not any_shown:
|
|
|
705 print "Parameter '%s' not supported (type 'show' for list of parameters)." % param
|
|
|
706
|
|
|
707 def do_quit(self, arg):
|
|
|
708 return self._STOP_AND_EXIT
|
|
|
709 do_exit = do_quit
|
|
|
710 do_q = do_quit
|
|
|
711
|
|
|
712 def do_show(self, arg):
|
|
|
713 '''Shows value of a parameter.'''
|
|
|
714 if arg.strip():
|
|
|
715 self.showParam(arg)
|
|
|
716 else:
|
|
|
717 for param in self.settable:
|
|
|
718 self.showParam(param)
|
|
|
719
|
|
|
720 def do_set(self, arg):
|
|
|
721 '''Sets a cmd2 parameter. Accepts abbreviated parameter names so long as there is no ambiguity.
|
|
|
722 Call without arguments for a list of settable parameters with their values.'''
|
|
|
723 try:
|
|
|
724 paramName, val = arg.split(None, 1)
|
|
|
725 paramName = paramName.strip().lower()
|
|
|
726 hits = [paramName in p for p in self.settable]
|
|
|
727 if hits.count(True) == 1:
|
|
|
728 paramName = self.settable[hits.index(True)]
|
|
|
729 currentVal = getattr(self, paramName)
|
|
|
730 if (val[0] == val[-1]) and val[0] in ("'", '"'):
|
|
|
731 val = val[1:-1]
|
|
|
732 else:
|
|
|
733 val = cast(currentVal, val)
|
|
|
734 setattr(self, paramName, val)
|
|
|
735 self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
|
|
|
736 if currentVal != val:
|
|
|
737 try:
|
|
|
738 onchange_hook = getattr(self, '_onchange_%s' % paramName)
|
|
|
739 onchange_hook(old=currentVal, new=val)
|
|
|
740 except AttributeError:
|
|
|
741 pass
|
|
|
742 else:
|
|
|
743 self.do_show(paramName)
|
|
|
744 except (ValueError, AttributeError, NotSettableError), e:
|
|
|
745 self.do_show(arg)
|
|
|
746
|
|
|
747 def do_pause(self, arg):
|
|
|
748 'Displays the specified text then waits for the user to press RETURN.'
|
|
|
749 raw_input(arg + '\n')
|
|
|
750
|
|
|
751 def do_shell(self, arg):
|
|
|
752 'execute a command as if at the OS prompt.'
|
|
|
753 os.system(arg)
|
|
|
754
|
|
231
|
755 def _attempt_py_command(self, arg):
|
|
|
756 try:
|
|
|
757 result = eval(arg, self.pystate)
|
|
|
758 print repr(result)
|
|
|
759 except SyntaxError:
|
|
|
760 exec(arg, self.pystate)
|
|
|
761 return
|
|
|
762
|
|
233
|
763 def do_py(self, arg):
|
|
230
|
764 '''
|
|
|
765 py <command>: Executes a Python command.
|
|
233
|
766 py: Enters interactive Python mode; end with `Ctrl-D`, `quit()`, or `exit()`.
|
|
|
767 Do not end with Ctrl-Z, or it will end your entire cmd2 session!
|
|
|
768 Non-python commands can be issued with cmd('your non-python command here').
|
|
230
|
769 '''
|
|
|
770 if arg.strip():
|
|
233
|
771 interp = code.InteractiveInterpreter(locals=self.pystate)
|
|
|
772 interp.runcode(arg)
|
|
230
|
773 else:
|
|
233
|
774 interp = code.InteractiveConsole(locals=self.pystate)
|
|
|
775 def quit():
|
|
|
776 interp.push(chr(4))
|
|
|
777 self.pystate['quit'] = quit
|
|
|
778 self.pystate['exit'] = quit
|
|
|
779 self.pystate[self.nonpythoncommand] = self.onecmd
|
|
|
780 interp.interact()
|
|
|
781
|
|
230
|
782 def do_history(self, arg):
|
|
|
783 """history [arg]: lists past commands issued
|
|
|
784
|
|
|
785 no arg -> list all
|
|
|
786 arg is integer -> list one history item, by index
|
|
|
787 arg is string -> string search
|
|
|
788 arg is /enclosed in forward-slashes/ -> regular expression search
|
|
|
789 """
|
|
|
790 if arg:
|
|
|
791 history = self.history.get(arg)
|
|
|
792 else:
|
|
|
793 history = self.history
|
|
|
794 for hi in history:
|
|
|
795 self.stdout.write(hi.pr())
|
|
|
796 def last_matching(self, arg):
|
|
|
797 try:
|
|
|
798 if arg:
|
|
|
799 return self.history.get(arg)[-1]
|
|
|
800 else:
|
|
|
801 return self.history[-1]
|
|
|
802 except IndexError:
|
|
|
803 return None
|
|
|
804 def do_list(self, arg):
|
|
|
805 """list [arg]: lists last command issued
|
|
|
806
|
|
|
807 no arg -> list absolute last
|
|
|
808 arg is integer -> list one history item, by index
|
|
|
809 - arg, arg - (integer) -> list up to or after #arg
|
|
|
810 arg is string -> list last command matching string search
|
|
|
811 arg is /enclosed in forward-slashes/ -> regular expression search
|
|
|
812 """
|
|
|
813 try:
|
|
|
814 self.stdout.write(self.last_matching(arg).pr())
|
|
|
815 except:
|
|
|
816 pass
|
|
|
817 do_hi = do_history
|
|
|
818 do_l = do_list
|
|
|
819 do_li = do_list
|
|
|
820
|
|
|
821 def do_ed(self, arg):
|
|
|
822 """ed: edit most recent command in text editor
|
|
|
823 ed [N]: edit numbered command from history
|
|
|
824 ed [filename]: edit specified file name
|
|
|
825
|
|
|
826 commands are run after editor is closed.
|
|
|
827 "set edit (program-name)" or set EDITOR environment variable
|
|
|
828 to control which editing program is used."""
|
|
|
829 if not self.editor:
|
|
|
830 print "please use 'set editor' to specify your text editing program of choice."
|
|
|
831 return
|
|
|
832 filename = self.default_file_name
|
|
|
833 if arg:
|
|
|
834 try:
|
|
|
835 buffer = self.last_matching(int(arg))
|
|
|
836 except ValueError:
|
|
|
837 filename = arg
|
|
|
838 buffer = ''
|
|
|
839 else:
|
|
|
840 buffer = self.history[-1]
|
|
|
841
|
|
|
842 if buffer:
|
|
|
843 f = open(os.path.expanduser(filename), 'w')
|
|
|
844 f.write(buffer or '')
|
|
|
845 f.close()
|
|
|
846
|
|
|
847 os.system('%s %s' % (self.editor, filename))
|
|
|
848 self.do__load(filename)
|
|
|
849 do_edit = do_ed
|
|
|
850
|
|
|
851 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") +
|
|
|
852 pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") +
|
|
|
853 pyparsing.stringEnd)
|
|
|
854 def do_save(self, arg):
|
|
|
855 """`save [N] [filename.ext]`
|
|
|
856 Saves command from history to file.
|
|
|
857 N => Number of command (from history), or `*`;
|
|
|
858 most recent command if omitted"""
|
|
|
859
|
|
|
860 try:
|
|
|
861 args = self.saveparser.parseString(arg)
|
|
|
862 except pyparsing.ParseException:
|
|
|
863 print self.do_save.__doc__
|
|
|
864 return
|
|
|
865 fname = args.fname or self.default_file_name
|
|
|
866 if args.idx == '*':
|
|
|
867 saveme = '\n\n'.join(self.history[:])
|
|
|
868 elif args.idx:
|
|
|
869 saveme = self.history[int(args.idx)-1]
|
|
|
870 else:
|
|
|
871 saveme = self.history[-1]
|
|
|
872 try:
|
|
|
873 f = open(os.path.expanduser(fname), 'w')
|
|
|
874 f.write(saveme)
|
|
|
875 f.close()
|
|
|
876 print 'Saved to %s' % (fname)
|
|
|
877 except Exception, e:
|
|
|
878 print 'Error saving %s: %s' % (fname, str(e))
|
|
|
879
|
|
|
880 urlre = re.compile('(https?://[-\\w\\./]+)')
|
|
|
881 def do_load(self, fname=None):
|
|
|
882 """Runs script of command(s) from a file or URL."""
|
|
|
883 if fname is None:
|
|
|
884 fname = self.default_file_name
|
|
|
885 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuation_prompt'))
|
|
|
886 try:
|
|
|
887 if isinstance(fname, file):
|
|
|
888 target = open(fname, 'r')
|
|
|
889 else:
|
|
|
890 match = self.urlre.match(fname)
|
|
|
891 if match:
|
|
|
892 target = urllib.urlopen(match.group(1))
|
|
|
893 else:
|
|
|
894 fname = os.path.expanduser(fname)
|
|
|
895 try:
|
|
|
896 target = open(os.path.expanduser(fname), 'r')
|
|
|
897 except IOError, e:
|
|
|
898 target = open('%s.%s' % (os.path.expanduser(fname),
|
|
|
899 self.defaultExtension), 'r')
|
|
|
900 except IOError, e:
|
|
|
901 print 'Problem accessing script from %s: \n%s' % (fname, e)
|
|
|
902 keepstate.restore()
|
|
|
903 return
|
|
|
904 self.stdin = target
|
|
|
905 self.use_rawinput = False
|
|
|
906 self.prompt = self.continuation_prompt = ''
|
|
|
907 stop = self.cmdloop()
|
|
|
908 self.stdin.close()
|
|
|
909 keepstate.restore()
|
|
|
910 self.lastcmd = ''
|
|
|
911 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT
|
|
|
912 do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython
|
|
|
913
|
|
|
914 def do_run(self, arg):
|
|
|
915 """run [arg]: re-runs an earlier command
|
|
|
916
|
|
|
917 no arg -> run most recent command
|
|
|
918 arg is integer -> run one history item, by index
|
|
|
919 arg is string -> run most recent command by string search
|
|
|
920 arg is /enclosed in forward-slashes/ -> run most recent by regex
|
|
|
921 """
|
|
|
922 'run [N]: runs the SQL that was run N commands ago'
|
|
|
923 runme = self.last_matching(arg)
|
|
|
924 print runme
|
|
|
925 if runme:
|
|
|
926 runme = self.precmd(runme)
|
|
|
927 stop = self.onecmd(runme)
|
|
|
928 stop = self.postcmd(stop, runme)
|
|
|
929 do_r = do_run
|
|
|
930
|
|
|
931 def fileimport(self, statement, source):
|
|
|
932 try:
|
|
|
933 f = open(os.path.expanduser(source))
|
|
|
934 except IOError:
|
|
|
935 self.stdout.write("Couldn't read from file %s\n" % source)
|
|
|
936 return ''
|
|
|
937 data = f.read()
|
|
|
938 f.close()
|
|
|
939 return data
|
|
|
940
|
|
|
941 class HistoryItem(str):
|
|
|
942 def __init__(self, instr):
|
|
|
943 str.__init__(self)
|
|
|
944 self.lowercase = self.lower()
|
|
|
945 self.idx = None
|
|
|
946 def pr(self):
|
|
|
947 return '-------------------------[%d]\n%s\n' % (self.idx, str(self))
|
|
|
948
|
|
|
949 class History(list):
|
|
|
950 rangeFrom = re.compile(r'^([\d])+\s*\-$')
|
|
|
951 def append(self, new):
|
|
|
952 new = HistoryItem(new)
|
|
|
953 list.append(self, new)
|
|
|
954 new.idx = len(self)
|
|
|
955 def extend(self, new):
|
|
|
956 for n in new:
|
|
|
957 self.append(n)
|
|
|
958 def get(self, getme):
|
|
|
959 try:
|
|
|
960 getme = int(getme)
|
|
|
961 if getme < 0:
|
|
|
962 return self[:(-1 * getme)]
|
|
|
963 else:
|
|
|
964 return [self[getme-1]]
|
|
|
965 except IndexError:
|
|
|
966 return []
|
|
|
967 except (ValueError, TypeError):
|
|
|
968 getme = getme.strip()
|
|
|
969 mtch = self.rangeFrom.search(getme)
|
|
|
970 if mtch:
|
|
|
971 return self[(int(mtch.group(1))-1):]
|
|
|
972 if getme.startswith(r'/') and getme.endswith(r'/'):
|
|
|
973 finder = re.compile(getme[1:-1], re.DOTALL | re.MULTILINE | re.IGNORECASE)
|
|
|
974 def isin(hi):
|
|
|
975 return finder.search(hi)
|
|
|
976 else:
|
|
|
977 def isin(hi):
|
|
|
978 return (getme.lower() in hi.lowercase)
|
|
|
979 return [itm for itm in self if isin(itm)]
|
|
|
980
|
|
|
981 class NotSettableError(Exception):
|
|
|
982 pass
|
|
|
983
|
|
|
984 def cast(current, new):
|
|
|
985 """Tries to force a new value into the same type as the current."""
|
|
|
986 typ = type(current)
|
|
|
987 if typ == bool:
|
|
|
988 try:
|
|
|
989 return bool(int(new))
|
|
|
990 except ValueError, TypeError:
|
|
|
991 pass
|
|
|
992 try:
|
|
|
993 new = new.lower()
|
|
|
994 except:
|
|
|
995 pass
|
|
|
996 if (new=='on') or (new[0] in ('y','t')):
|
|
|
997 return True
|
|
|
998 if (new=='off') or (new[0] in ('n','f')):
|
|
|
999 return False
|
|
|
1000 else:
|
|
|
1001 try:
|
|
|
1002 return typ(new)
|
|
|
1003 except:
|
|
|
1004 pass
|
|
|
1005 print "Problem setting parameter (now %s) to %s; incorrect type?" % (current, new)
|
|
|
1006 return current
|
|
|
1007
|
|
|
1008 class Statekeeper(object):
|
|
|
1009 def __init__(self, obj, attribs):
|
|
|
1010 self.obj = obj
|
|
|
1011 self.attribs = attribs
|
|
|
1012 self.save()
|
|
|
1013 def save(self):
|
|
|
1014 for attrib in self.attribs:
|
|
|
1015 setattr(self, attrib, getattr(self.obj, attrib))
|
|
|
1016 def restore(self):
|
|
|
1017 for attrib in self.attribs:
|
|
|
1018 setattr(self.obj, attrib, getattr(self, attrib))
|
|
|
1019
|
|
|
1020 class Borg(object):
|
|
|
1021 '''All instances of any Borg subclass will share state.
|
|
|
1022 from Python Cookbook, 2nd Ed., recipe 6.16'''
|
|
|
1023 _shared_state = {}
|
|
|
1024 def __new__(cls, *a, **k):
|
|
|
1025 obj = object.__new__(cls, *a, **k)
|
|
|
1026 obj.__dict__ = cls._shared_state
|
|
|
1027 return obj
|
|
|
1028
|
|
|
1029 class OutputTrap(Borg):
|
|
|
1030 '''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing.
|
|
|
1031 Call `tearDown()` to return to normal output.'''
|
|
|
1032 def __init__(self):
|
|
|
1033 self.old_stdout = sys.stdout
|
|
|
1034 self.trap = tempfile.TemporaryFile()
|
|
|
1035 sys.stdout = self.trap
|
|
|
1036 def read(self):
|
|
|
1037 self.trap.seek(0)
|
|
|
1038 result = self.trap.read()
|
|
|
1039 self.trap.truncate(0)
|
|
|
1040 return result.strip('\x00')
|
|
|
1041 def tearDown(self):
|
|
|
1042 sys.stdout = self.old_stdout
|
|
|
1043
|
|
|
1044 class Cmd2TestCase(unittest.TestCase):
|
|
|
1045 '''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class
|
|
|
1046 that will execute the commands in transcriptFileName and expect the results shown.
|
|
|
1047 See example.py'''
|
|
|
1048 CmdApp = None
|
|
|
1049 transcriptFileName = ''
|
|
|
1050 def setUp(self):
|
|
|
1051 if self.CmdApp:
|
|
|
1052 self.outputTrap = OutputTrap()
|
|
|
1053 self.cmdapp = self.CmdApp()
|
|
|
1054 try:
|
|
|
1055 tfile = open(os.path.expanduser(self.transcriptFileName))
|
|
|
1056 self.transcript = iter(tfile.readlines())
|
|
|
1057 tfile.close()
|
|
|
1058 except IOError:
|
|
|
1059 self.transcript = []
|
|
|
1060 def assertEqualEnough(self, got, expected, message):
|
|
|
1061 got = got.strip().splitlines()
|
|
|
1062 expected = expected.strip().splitlines()
|
|
|
1063 self.assertEqual(len(got), len(expected), message)
|
|
|
1064 for (linegot, lineexpected) in zip(got, expected):
|
|
|
1065 matchme = re.escape(lineexpected.strip()).replace('\\*', '.*'). \
|
|
|
1066 replace('\\ ', ' ')
|
|
|
1067 self.assert_(re.match(matchme, linegot.strip()), message)
|
|
|
1068 def testall(self):
|
|
|
1069 if self.CmdApp:
|
|
|
1070 lineNum = 0
|
|
|
1071 try:
|
|
|
1072 line = self.transcript.next()
|
|
|
1073 while True:
|
|
|
1074 while not line.startswith(self.cmdapp.prompt):
|
|
|
1075 line = self.transcript.next()
|
|
|
1076 command = [line[len(self.cmdapp.prompt):]]
|
|
|
1077 line = self.transcript.next()
|
|
|
1078 while line.startswith(self.cmdapp.continuation_prompt):
|
|
|
1079 command.append(line[len(self.cmdapp.continuation_prompt):])
|
|
|
1080 line = self.transcript.next()
|
|
|
1081 command = ''.join(command)
|
|
|
1082 self.cmdapp.onecmd(command)
|
|
|
1083 result = self.outputTrap.read()
|
|
|
1084 if line.startswith(self.cmdapp.prompt):
|
|
|
1085 self.assertEqualEnough(result.strip(), '',
|
|
|
1086 '\nFile %s, line %d\nCommand was:\n%s\nExpected: (nothing) \nGot:\n%s\n' %
|
|
|
1087 (self.transcriptFileName, lineNum, command, result))
|
|
|
1088 continue
|
|
|
1089 expected = []
|
|
|
1090 while not line.startswith(self.cmdapp.prompt):
|
|
|
1091 expected.append(line)
|
|
|
1092 line = self.transcript.next()
|
|
|
1093 expected = ''.join(expected)
|
|
|
1094 self.assertEqualEnough(expected.strip(), result.strip(),
|
|
|
1095 '\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' %
|
|
|
1096 (self.transcriptFileName, lineNum, command, expected, result))
|
|
|
1097 # this needs to account for a line-by-line strip()ping
|
|
|
1098 except StopIteration:
|
|
|
1099 pass
|
|
|
1100 # catch the final output?
|
|
|
1101 def tearDown(self):
|
|
|
1102 if self.CmdApp:
|
|
|
1103 self.outputTrap.tearDown()
|
|
|
1104
|
|
|
1105 if __name__ == '__main__':
|
|
|
1106 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE)
|
|
|
1107 #c = Cmd()
|
