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