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