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