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