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