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