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