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