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