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