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