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