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