Mercurial > python-cmd2
annotate cmd2.py @ 213:500955dece3f
parameter onchange hook comment
author | catherine@Elli.myhome.westell.com |
---|---|
date | Sat, 14 Mar 2009 20:05:15 -0400 |
parents | 9c4c4d012a92 |
children | 68c03076c9e7 |
rev | line source |
---|---|
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
1 """Variant on standard library's cmd with extra features. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
2 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
3 To use, simply import cmd2.Cmd instead of cmd.Cmd; use precisely as though you |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
4 were using the standard library's cmd, while enjoying the extra features. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
5 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
6 Searchable command history (commands: "hi", "li", "run") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
7 Load commands from file, save to file, edit commands in file |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
8 Multi-line commands |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
9 Case-insensitive commands |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
10 Special-character shortcut commands (beyond cmd's "@" and "!") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
11 Settable environment parameters |
213
500955dece3f
parameter onchange hook comment
catherine@Elli.myhome.westell.com
parents:
212
diff
changeset
|
12 Optional _onchange_{paramname} called when environment parameter changes |
13 | 13 Parsing commands with `optparse` options (flags) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
14 Redirection to file with >, >>; input from file with < |
112
e3b8eaadea56
going to collapse down out of overdone package structure
catherine@Elli.myhome.westell.com
parents:
109
diff
changeset
|
15 Easy transcript-based testing of applications (see example/example.py) |
13 | 16 |
84
416ea36af789
fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents:
83
diff
changeset
|
17 Note that redirection with > and | will only work if `self.stdout.write()` |
416ea36af789
fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents:
83
diff
changeset
|
18 is used in place of `print`. The standard library's `cmd` module is |
416ea36af789
fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents:
83
diff
changeset
|
19 written to use `self.stdout.write()`, |
416ea36af789
fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents:
83
diff
changeset
|
20 |
14 | 21 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
22 |
126 | 23 mercurial repository at http://www.assembla.com/wiki/show/python-cmd2 |
14 | 24 CHANGES: |
25 As of 0.3.0, options should be specified as `optparse` options. See README.txt. | |
26 flagReader.py options are still supported for backward compatibility | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
27 """ |
192
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
28 import cmd, re, os, sys, optparse, subprocess, tempfile, pyparsing, doctest |
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
29 import unittest, string, datetime |
10 | 30 from optparse import make_option |
211 | 31 __version__ = '0.4.8' |
10 | 32 |
11 | 33 class OptionParser(optparse.OptionParser): |
34 def exit(self, status=0, msg=None): | |
38 | 35 self.values._exit = True |
11 | 36 if msg: |
15 | 37 print msg |
211 | 38 |
39 def print_help(self, *args, **kwargs): | |
40 # now, I need to call help of the calling function. Hmm. | |
41 try: | |
42 print self._func.__doc__ | |
43 except AttributeError: | |
44 pass | |
45 optparse.OptionParser.print_help(self, *args, **kwargs) | |
11 | 46 |
47 def error(self, msg): | |
48 """error(msg : string) | |
49 | |
50 Print a usage message incorporating 'msg' to stderr and exit. | |
51 If you override this in a subclass, it should not return -- it | |
52 should either exit or raise an exception. | |
53 """ | |
15 | 54 raise |
11 | 55 |
187 | 56 def remainingArgs(oldArgs, newArgList): |
57 ''' | |
58 >>> remainingArgs('-f bar bar cow', ['bar', 'cow']) | |
59 'bar cow' | |
60 ''' | |
189 | 61 pattern = '\s+'.join(re.escape(a) for a in newArgList) + '\s*$' |
187 | 62 matchObj = re.search(pattern, oldArgs) |
63 return oldArgs[matchObj.start():] | |
64 | |
10 | 65 def options(option_list): |
66 def option_setup(func): | |
11 | 67 optionParser = OptionParser() |
10 | 68 for opt in option_list: |
69 optionParser.add_option(opt) | |
12 | 70 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_')) |
211 | 71 optionParser._func = func |
10 | 72 def newFunc(instance, arg): |
73 try: | |
190 | 74 opts, newArgList = optionParser.parse_args(arg.split()) # doesn't understand quoted strings shouldn't be dissected! |
75 newArgs = remainingArgs(arg, newArgList) # should it permit flags after args? | |
20 | 76 except (optparse.OptionValueError, optparse.BadOptionError, |
77 optparse.OptionError, optparse.AmbiguousOptionError, | |
78 optparse.OptionConflictError), e: | |
10 | 79 print e |
80 optionParser.print_help() | |
38 | 81 return |
82 if hasattr(opts, '_exit'): | |
83 return None | |
187 | 84 terminator = arg.parsed.terminator |
85 try: | |
86 if arg.parsed.terminator[0] == '\n': | |
87 terminator = arg.parsed.terminator[0] | |
88 except IndexError: | |
89 pass | |
90 arg = arg.parser('%s %s%s%s' % (arg.parsed.command, newArgs, terminator, arg.parsed.suffix)) | |
37
a974e2f44cbe
made redirectors work with app-specific StatementEndPattern
catherine@localhost
parents:
36
diff
changeset
|
91 result = func(instance, arg, opts) |
159 | 92 return result |
10 | 93 newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help()) |
94 return newFunc | |
95 return option_setup | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
96 |
27 | 97 class PasteBufferError(EnvironmentError): |
98 if sys.platform[:3] == 'win': | |
99 errmsg = """Redirecting to or from paste buffer requires pywin32 | |
100 to be installed on operating system. | |
101 Download from http://sourceforge.net/projects/pywin32/""" | |
102 else: | |
103 errmsg = """Redirecting to or from paste buffer requires xclip | |
104 to be installed on operating system. | |
105 On Debian/Ubuntu, 'sudo apt-get install xclip' will install it.""" | |
28
28b3fb301d3d
almost working, but problem with check_call
catherine@cordelia
parents:
27
diff
changeset
|
106 def __init__(self): |
27 | 107 Exception.__init__(self, self.errmsg) |
108 | |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
109 '''check here if functions exist; otherwise, stub out''' |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
110 pastebufferr = """Redirecting to or from paste buffer requires %s |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
111 to be installed on operating system. |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
112 %s""" |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
113 if subprocess.mswindows: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
114 try: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
115 import win32clipboard |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
116 def getPasteBuffer(): |
28
28b3fb301d3d
almost working, but problem with check_call
catherine@cordelia
parents:
27
diff
changeset
|
117 win32clipboard.OpenClipboard(0) |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
118 try: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
119 result = win32clipboard.GetClipboardData() |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
120 except TypeError: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
121 result = '' #non-text |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
122 win32clipboard.CloseClipboard() |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
123 return result |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
124 def writeToPasteBuffer(txt): |
28
28b3fb301d3d
almost working, but problem with check_call
catherine@cordelia
parents:
27
diff
changeset
|
125 win32clipboard.OpenClipboard(0) |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
126 win32clipboard.EmptyClipboard() |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
127 win32clipboard.SetClipboardText(txt) |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
128 win32clipboard.CloseClipboard() |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
129 except ImportError: |
106 | 130 def getPasteBuffer(*args): |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
131 raise OSError, pastebufferr % ('pywin32', 'Download from http://sourceforge.net/projects/pywin32/') |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
132 setPasteBuffer = getPasteBuffer |
27 | 133 else: |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
134 can_clip = False |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
135 try: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
136 subprocess.check_call('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
137 can_clip = True |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
138 except AttributeError: # check_call not defined, Python < 2.5 |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
139 teststring = 'Testing for presence of xclip.' |
31 | 140 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
141 xclipproc.stdin.write(teststring) |
31 | 142 xclipproc.stdin.close() |
143 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) | |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
144 if xclipproc.stdout.read() == teststring: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
145 can_clip = True |
56
f844b6c78192
fixing (hopefully) broken pipe error for headless systems
catherine.devlin@gmail.com
parents:
54
diff
changeset
|
146 except (subprocess.CalledProcessError, OSError, IOError): |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
147 pass |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
148 if can_clip: |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
149 def getPasteBuffer(): |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
150 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
151 return xclipproc.stdout.read() |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
152 def writeToPasteBuffer(txt): |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
153 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
154 xclipproc.stdin.write(txt) |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
155 xclipproc.stdin.close() |
83
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
156 # but we want it in both the "primary" and "mouse" clipboards |
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
157 xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) |
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
158 xclipproc.stdin.write(txt) |
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
159 xclipproc.stdin.close() |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
160 else: |
106 | 161 def getPasteBuffer(*args): |
29
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
162 raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"') |
c4bd5f1a6968
paste buffer working on linux and windows
catherine@cordelia
parents:
28
diff
changeset
|
163 setPasteBuffer = getPasteBuffer |
106 | 164 writeToPasteBuffer = getPasteBuffer |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
165 |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
166 pyparsing.ParserElement.setDefaultWhitespaceChars(' \t') |
154 | 167 |
157 | 168 class ParsedString(str): |
169 pass | |
170 | |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
171 class SkipToLast(pyparsing.SkipTo): |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
172 def parseImpl( self, instring, loc, doActions=True ): |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
173 resultStore = [] |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
174 startLoc = loc |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
175 instrlen = len(instring) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
176 expr = self.expr |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
177 failParse = False |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
178 while loc <= instrlen: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
179 try: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
180 if self.failOn: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
181 failParse = True |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
182 self.failOn.tryParse(instring, loc) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
183 failParse = False |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
184 loc = expr._skipIgnorables( instring, loc ) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
185 expr._parse( instring, loc, doActions=False, callPreParse=False ) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
186 skipText = instring[startLoc:loc] |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
187 if self.includeMatch: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
188 loc,mat = expr._parse(instring,loc,doActions,callPreParse=False) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
189 if mat: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
190 skipRes = ParseResults( skipText ) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
191 skipRes += mat |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
192 resultStore.append((loc, [ skipRes ])) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
193 else: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
194 resultStore,append((loc, [ skipText ])) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
195 else: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
196 resultStore.append((loc, [ skipText ])) |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
197 loc += 1 |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
198 except (pyparsing.ParseException,IndexError): |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
199 if failParse: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
200 raise |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
201 else: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
202 loc += 1 |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
203 if resultStore: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
204 return resultStore[-1] |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
205 else: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
206 exc = self.myException |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
207 exc.loc = loc |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
208 exc.pstr = instring |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
209 raise exc |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
210 |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
211 def replace_with_file_contents(fname): |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
212 if fname: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
213 try: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
214 result = open(os.path.expanduser(fname[0])).read() |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
215 except IOError: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
216 result = '< %s' % fname[0] # wasn't a file after all |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
217 else: |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
218 result = getPasteBuffer() |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
219 return result |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
220 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
221 class Cmd(cmd.Cmd): |
103 | 222 echo = False |
207 | 223 case_insensitive = True |
224 continuation_prompt = '> ' | |
192
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
225 timing = False |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
226 legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit # make sure your terminators are not in here! |
137 | 227 shortcuts = {'?': 'help', '!': 'shell', '@': 'load' } |
106 | 228 excludeFromHistory = '''run r list l history hi ed edit li eof'''.split() |
229 noSpecialParse = 'set ed edit exit'.split() | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
230 defaultExtension = 'txt' |
207 | 231 default_file_name = 'command.txt' |
232 settable = ['prompt', 'continuation_prompt', 'default_file_name', 'editor', 'case_insensitive', | |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
233 'echo', 'timing'] |
199 | 234 settable.sort() |
169 | 235 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
236 editor = os.environ.get('EDITOR') |
42 | 237 _STOP_AND_EXIT = 2 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
238 if not editor: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
239 if sys.platform[:3] == 'win': |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
240 editor = 'notepad' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
241 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
242 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']: |
47 | 243 if not os.system('which %s' % (editor)): |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
244 break |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
245 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
246 def do_cmdenvironment(self, args): |
193 | 247 '''Summary report of interactive parameters.''' |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
248 self.stdout.write(""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
249 Commands are %(casesensitive)scase-sensitive. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
250 Commands may be terminated with: %(terminators)s |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
251 Settable parameters: %(settable)s |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
252 """ % |
207 | 253 { 'casesensitive': (self.case_insensitive and 'not ') or '', |
171 | 254 'terminators': str(self.terminators), |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
255 'settable': ' '.join(self.settable) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
256 }) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
257 |
10 | 258 def do_help(self, arg): |
259 try: | |
260 fn = getattr(self, 'do_' + arg) | |
261 if fn and fn.optionParser: | |
262 fn.optionParser.print_help(file=self.stdout) | |
211 | 263 return |
10 | 264 except AttributeError: |
265 pass | |
211 | 266 cmd.Cmd.do_help(self, arg) |
10 | 267 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
268 def __init__(self, *args, **kwargs): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
269 cmd.Cmd.__init__(self, *args, **kwargs) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
270 self.history = History() |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
271 self._init_parser() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
272 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
273 def do_shortcuts(self, args): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
274 """Lists single-key shortcuts available.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
275 result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in self.shortcuts.items()) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
276 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
277 |
137 | 278 commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment]) |
153 | 279 commentGrammars.addParseAction(lambda x: '') |
136 | 280 commentInProgress = pyparsing.Literal('/*') + pyparsing.SkipTo(pyparsing.stringEnd) |
171 | 281 terminators = [';'] |
282 blankLinesAllowed = False | |
153 | 283 multilineCommands = [] |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
284 |
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
285 def _init_parser(self): |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
286 r''' |
146 | 287 >>> c = Cmd() |
153 | 288 >>> c.multilineCommands = ['multiline'] |
207 | 289 >>> c.case_insensitive = True |
153 | 290 >>> c._init_parser() |
158 | 291 >>> print c.parser.parseString('').dump() |
292 [] | |
293 >>> print c.parser.parseString('/* empty command */').dump() | |
294 [] | |
295 >>> print c.parser.parseString('plainword').dump() | |
296 ['plainword', ''] | |
297 - command: plainword | |
298 - statement: ['plainword', ''] | |
299 - command: plainword | |
157 | 300 >>> print c.parser.parseString('termbare;').dump() |
158 | 301 ['termbare', '', ';', ''] |
302 - command: termbare | |
303 - statement: ['termbare', '', ';'] | |
304 - command: termbare | |
305 - terminator: ; | |
306 - terminator: ; | |
157 | 307 >>> print c.parser.parseString('termbare; suffx').dump() |
158 | 308 ['termbare', '', ';', 'suffx'] |
309 - command: termbare | |
310 - statement: ['termbare', '', ';'] | |
311 - command: termbare | |
312 - terminator: ; | |
313 - suffix: suffx | |
314 - terminator: ; | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
315 >>> print c.parser.parseString('barecommand').dump() |
153 | 316 ['barecommand', ''] |
317 - command: barecommand | |
318 - statement: ['barecommand', ''] | |
319 - command: barecommand | |
320 >>> print c.parser.parseString('COMmand with args').dump() | |
157 | 321 ['command', 'with args'] |
322 - args: with args | |
153 | 323 - command: command |
157 | 324 - statement: ['command', 'with args'] |
325 - args: with args | |
153 | 326 - command: command |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
327 >>> print c.parser.parseString('command with args and terminator; and suffix').dump() |
158 | 328 ['command', 'with args and terminator', ';', 'and suffix'] |
153 | 329 - args: with args and terminator |
330 - command: command | |
331 - statement: ['command', 'with args and terminator', ';'] | |
332 - args: with args and terminator | |
333 - command: command | |
334 - terminator: ; | |
158 | 335 - suffix: and suffix |
336 - terminator: ; | |
153 | 337 >>> print c.parser.parseString('simple | piped').dump() |
157 | 338 ['simple', '', '|', ' piped'] |
153 | 339 - command: simple |
157 | 340 - pipeTo: piped |
153 | 341 - statement: ['simple', ''] |
342 - command: simple | |
199 | 343 >>> print c.parser.parseString('double-pipe || is not a pipe').dump() |
344 ['double', '-pipe || is not a pipe'] | |
345 - args: -pipe || is not a pipe | |
346 - command: double | |
347 - statement: ['double', '-pipe || is not a pipe'] | |
348 - args: -pipe || is not a pipe | |
349 - command: double | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
350 >>> print c.parser.parseString('command with args, terminator;sufx | piped').dump() |
157 | 351 ['command', 'with args, terminator', ';', 'sufx', '|', ' piped'] |
153 | 352 - args: with args, terminator |
353 - command: command | |
157 | 354 - pipeTo: piped |
153 | 355 - statement: ['command', 'with args, terminator', ';'] |
356 - args: with args, terminator | |
357 - command: command | |
358 - terminator: ; | |
359 - suffix: sufx | |
155 | 360 - terminator: ; |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
361 >>> print c.parser.parseString('output into > afile.txt').dump() |
157 | 362 ['output', 'into', '>', 'afile.txt'] |
153 | 363 - args: into |
364 - command: output | |
365 - output: > | |
155 | 366 - outputTo: afile.txt |
157 | 367 - statement: ['output', 'into'] |
368 - args: into | |
369 - command: output | |
370 >>> print c.parser.parseString('output into;sufx | pipethrume plz > afile.txt').dump() | |
371 ['output', 'into', ';', 'sufx', '|', ' pipethrume plz', '>', 'afile.txt'] | |
372 - args: into | |
373 - command: output | |
374 - output: > | |
375 - outputTo: afile.txt | |
376 - pipeTo: pipethrume plz | |
153 | 377 - statement: ['output', 'into', ';'] |
378 - args: into | |
379 - command: output | |
380 - terminator: ; | |
381 - suffix: sufx | |
382 - terminator: ; | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
383 >>> print c.parser.parseString('output to paste buffer >> ').dump() |
157 | 384 ['output', 'to paste buffer', '>>', ''] |
385 - args: to paste buffer | |
153 | 386 - command: output |
387 - output: >> | |
157 | 388 - statement: ['output', 'to paste buffer'] |
389 - args: to paste buffer | |
153 | 390 - command: output |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
391 >>> print c.parser.parseString('ignore the /* commented | > */ stuff;').dump() |
153 | 392 ['ignore', 'the /* commented | > */ stuff', ';', ''] |
393 - args: the /* commented | > */ stuff | |
394 - command: ignore | |
395 - statement: ['ignore', 'the /* commented | > */ stuff', ';'] | |
396 - args: the /* commented | > */ stuff | |
397 - command: ignore | |
398 - terminator: ; | |
399 - terminator: ; | |
400 >>> print c.parser.parseString('has > inside;').dump() | |
401 ['has', '> inside', ';', ''] | |
402 - args: > inside | |
403 - command: has | |
404 - statement: ['has', '> inside', ';'] | |
405 - args: > inside | |
406 - command: has | |
407 - terminator: ; | |
408 - terminator: ; | |
409 >>> print c.parser.parseString('multiline has > inside an unfinished command').dump() | |
173 | 410 ['multiline', ' has > inside an unfinished command'] |
153 | 411 - multilineCommand: multiline |
412 >>> print c.parser.parseString('multiline has > inside;').dump() | |
413 ['multiline', 'has > inside', ';', ''] | |
414 - args: has > inside | |
415 - multilineCommand: multiline | |
416 - statement: ['multiline', 'has > inside', ';'] | |
417 - args: has > inside | |
418 - multilineCommand: multiline | |
419 - terminator: ; | |
420 - terminator: ; | |
421 >>> print c.parser.parseString('multiline command /* with comment in progress;').dump() | |
173 | 422 ['multiline', ' command /* with comment in progress;'] |
153 | 423 - multilineCommand: multiline |
424 >>> print c.parser.parseString('multiline command /* with comment complete */ is done;').dump() | |
425 ['multiline', 'command /* with comment complete */ is done', ';', ''] | |
426 - args: command /* with comment complete */ is done | |
427 - multilineCommand: multiline | |
428 - statement: ['multiline', 'command /* with comment complete */ is done', ';'] | |
429 - args: command /* with comment complete */ is done | |
430 - multilineCommand: multiline | |
431 - terminator: ; | |
158 | 432 - terminator: ; |
186 | 433 >>> print c.parser.parseString('multiline command ends\n\n').dump() |
434 ['multiline', 'command ends', '\n', '\n'] | |
435 - args: command ends | |
436 - multilineCommand: multiline | |
437 - statement: ['multiline', 'command ends', '\n', '\n'] | |
438 - args: command ends | |
439 - multilineCommand: multiline | |
440 - terminator: ['\n', '\n'] | |
441 - terminator: ['\n', '\n'] | |
153 | 442 ''' |
195
455ebe415d5e
do not interpret => as having the redirector >
catherine@dellzilla
parents:
194
diff
changeset
|
443 outputParser = (pyparsing.Literal('>>') | (pyparsing.WordStart() + '>') | pyparsing.Regex('[^=]>'))('output') |
455ebe415d5e
do not interpret => as having the redirector >
catherine@dellzilla
parents:
194
diff
changeset
|
444 |
171 | 445 terminatorParser = pyparsing.Or([(hasattr(t, 'parseString') and t) or pyparsing.Literal(t) for t in self.terminators])('terminator') |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
446 stringEnd = pyparsing.stringEnd ^ '\nEOF' |
207 | 447 self.multilineCommand = pyparsing.Or([pyparsing.Keyword(c, caseless=self.case_insensitive) for c in self.multilineCommands])('multilineCommand') |
186 | 448 oneLineCommand = (~self.multilineCommand + pyparsing.Word(self.legalChars))('command') |
160 | 449 pipe = pyparsing.Keyword('|', identChars='|') |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
450 self.commentGrammars.ignore(pyparsing.quotedString).setParseAction(lambda x: '') |
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
451 self.commentInProgress.ignore(pyparsing.quotedString).ignore(pyparsing.cStyleComment) |
153 | 452 afterElements = \ |
160 | 453 pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \ |
155 | 454 pyparsing.Optional(outputParser + pyparsing.SkipTo(stringEnd).setParseAction(lambda x: x[0].strip())('outputTo')) |
207 | 455 if self.case_insensitive: |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
456 self.multilineCommand.setParseAction(lambda x: x[0].lower()) |
153 | 457 oneLineCommand.setParseAction(lambda x: x[0].lower()) |
171 | 458 if self.blankLinesAllowed: |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
459 self.blankLineTerminationParser = pyparsing.NoMatch |
171 | 460 else: |
186 | 461 self.blankLineTerminator = (pyparsing.lineEnd + pyparsing.lineEnd)('terminator') |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
462 self.blankLineTerminator.setResultsName('terminator') |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
463 self.blankLineTerminationParser = ((self.multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(self.blankLineTerminator).setParseAction(lambda x: x[0].strip())('args') + self.blankLineTerminator)('statement') |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
464 self.multilineParser = (((self.multilineCommand ^ oneLineCommand) + SkipToLast(terminatorParser).setParseAction(lambda x: x[0].strip())('args') + terminatorParser)('statement') + |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
465 pyparsing.SkipTo(outputParser ^ pipe ^ stringEnd).setParseAction(lambda x: x[0].strip())('suffix') + afterElements) |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
466 self.singleLineParser = ((oneLineCommand + pyparsing.SkipTo(terminatorParser ^ stringEnd ^ pipe ^ outputParser).setParseAction(lambda x:x[0].strip())('args'))('statement') + |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
467 pyparsing.Optional(terminatorParser) + afterElements) |
186 | 468 #self.multilineParser = self.multilineParser.setResultsName('multilineParser') |
469 #self.singleLineParser = self.singleLineParser.setResultsName('singleLineParser') | |
470 #self.blankLineTerminationParser = self.blankLineTerminationParser.setResultsName('blankLineTerminatorParser') | |
153 | 471 self.parser = ( |
173 | 472 stringEnd | |
184
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
473 self.multilineParser | |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
474 self.singleLineParser | |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
475 self.blankLineTerminationParser | |
d1a87c14675b
putting parsing variables under self
catherine@Elli.myhome.westell.com
parents:
183
diff
changeset
|
476 self.multilineCommand + pyparsing.SkipTo(stringEnd) |
153 | 477 ) |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
478 self.parser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress) |
169 | 479 |
154 | 480 inputMark = pyparsing.Literal('<') |
481 inputMark.setParseAction(lambda x: '') | |
204 | 482 fileName = pyparsing.Word(self.legalChars + '/\\') |
483 inputFrom = fileName('inputFrom') | |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
484 inputFrom.setParseAction(replace_with_file_contents) |
204 | 485 # a not-entirely-satisfactory way of distinguishing < as in "import from" from < |
486 # as in "lesser than" | |
487 self.inputParser = inputMark + pyparsing.Optional(inputFrom) + pyparsing.Optional('>') + \ | |
488 pyparsing.Optional(fileName) + (pyparsing.stringEnd | '|') | |
203
68a609fc516b
limit < infile slurp to cases where infile found
catherine@dellzilla
parents:
202
diff
changeset
|
489 self.inputParser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress) |
153 | 490 |
165 | 491 def parsed(self, raw, **kwargs): |
162
c50615cf814f
merged with changes from work
catherine@Elli.myhome.westell.com
parents:
161
diff
changeset
|
492 if isinstance(raw, ParsedString): |
165 | 493 p = raw |
494 else: | |
171 | 495 s = self.inputParser.transformString(raw.lstrip()) |
165 | 496 for (shortcut, expansion) in self.shortcuts.items(): |
201 | 497 if s.lower().startswith(shortcut): |
165 | 498 s = s.replace(shortcut, expansion + ' ', 1) |
499 break | |
500 result = self.parser.parseString(s) | |
501 result['command'] = result.multilineCommand or result.command | |
502 result['raw'] = raw | |
503 result['clean'] = self.commentGrammars.transformString(result.args) | |
504 result['expanded'] = s | |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
505 p = ParsedString(result.clean) |
165 | 506 p.parsed = result |
507 p.parser = self.parsed | |
508 for (key, val) in kwargs.items(): | |
509 p.parsed[key] = val | |
157 | 510 return p |
511 | |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
512 def onecmd(self, line): |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
513 """Interpret the argument as though it had been typed in response |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
514 to the prompt. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
515 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
516 This may be overridden, but should not normally need to be; |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
517 see the precmd() and postcmd() methods for useful execution hooks. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
518 The return value is a flag indicating whether interpretation of |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
519 commands by the interpreter should stop. |
157 | 520 |
521 This (`cmd2`) version of `onecmd` already override's `cmd`'s `onecmd`. | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
522 |
3 | 523 """ |
83
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
524 if not line: |
157 | 525 return self.emptyline() |
135
7c0a89fccf2b
broken; midway through comments
catherine@Elli.myhome.westell.com
parents:
134
diff
changeset
|
526 if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line): |
179
321e0cc35661
oh no... must accept prompt changes
catherine@Elli.myhome.westell.com
parents:
177
diff
changeset
|
527 return 0 # command was empty except for comments |
154 | 528 try: |
529 statement = self.parsed(line) | |
170
310ebf4baa7a
\n endings still squirrely; watch blank spaces in saved files
catherine@dellzilla
parents:
169
diff
changeset
|
530 while statement.parsed.multilineCommand and (statement.parsed.terminator == ''): |
192
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
531 statement = '%s\n%s' % (statement.parsed.raw, |
207 | 532 self.pseudo_raw_input(self.continuation_prompt)) |
192
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
533 statement = self.parsed(statement) |
154 | 534 except Exception, e: |
535 print e | |
536 return 0 | |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
537 |
177 | 538 if not statement.parsed.command: |
175 | 539 return 0 |
540 | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
541 statekeeper = None |
25 | 542 stop = 0 |
154 | 543 |
157 | 544 if statement.parsed.pipeTo: |
545 redirect = subprocess.Popen(statement.parsed.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) | |
51 | 546 statekeeper = Statekeeper(self, ('stdout',)) |
47 | 547 self.stdout = redirect.stdin |
157 | 548 elif statement.parsed.output: |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
549 statekeeper = Statekeeper(self, ('stdout',)) |
157 | 550 if statement.parsed.outputTo: |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
551 mode = 'w' |
157 | 552 if statement.parsed.output == '>>': |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
553 mode = 'a' |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
554 try: |
202 | 555 self.stdout = open(os.path.expanduser(statement.parsed.outputTo), mode) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
556 except OSError, e: |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
557 print e |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
558 return 0 |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
559 else: |
51 | 560 statekeeper = Statekeeper(self, ('stdout',)) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
561 self.stdout = tempfile.TemporaryFile() |
157 | 562 if statement.parsed.output == '>>': |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
563 self.stdout.write(getPasteBuffer()) |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
564 try: |
157 | 565 # "heart" of the command, replace's cmd's onecmd() |
566 self.lastcmd = statement.parsed.expanded | |
567 try: | |
568 func = getattr(self, 'do_' + statement.parsed.command) | |
569 except AttributeError: | |
570 return self.default(statement) | |
192
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
571 timestart = datetime.datetime.now() |
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
572 stop = func(statement) |
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
573 if self.timing: |
c0d4c7ba14a9
added settable timings param
catherine@Elli.myhome.westell.com
parents:
191
diff
changeset
|
574 print 'Elapsed: %s' % str(datetime.datetime.now() - timestart) |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
575 except Exception, e: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
576 print e |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
577 try: |
157 | 578 if statement.parsed.command not in self.excludeFromHistory: |
579 self.history.append(statement.parsed.raw) | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
580 finally: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
581 if statekeeper: |
157 | 582 if statement.parsed.output and not statement.parsed.outputTo: |
27 | 583 self.stdout.seek(0) |
134
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
584 try: |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
585 writeToPasteBuffer(self.stdout.read()) |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
586 except Exception, e: |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
587 print str(e) |
157 | 588 elif statement.parsed.pipeTo: |
52
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
589 for result in redirect.communicate(): |
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
590 statekeeper.stdout.write(result or '') |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
591 self.stdout.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
592 statekeeper.restore() |
52
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
593 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
594 return stop |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
595 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
596 def pseudo_raw_input(self, prompt): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
597 """copied from cmd's cmdloop; like raw_input, but accounts for changed stdin, stdout""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
598 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
599 if self.use_rawinput: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
600 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
601 line = raw_input(prompt) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
602 except EOFError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
603 line = 'EOF' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
604 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
605 self.stdout.write(prompt) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
606 self.stdout.flush() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
607 line = self.stdin.readline() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
608 if not len(line): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
609 line = 'EOF' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
610 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
611 if line[-1] == '\n': # this was always true in Cmd |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
612 line = line[:-1] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
613 return line |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
614 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
615 def cmdloop(self, intro=None): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
616 """Repeatedly issue a prompt, accept input, parse an initial prefix |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
617 off the received input, and dispatch to action methods, passing them |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
618 the remainder of the line as argument. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
619 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
620 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
621 # An almost perfect copy from Cmd; however, the pseudo_raw_input portion |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
622 # has been split out so that it can be called separately |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
623 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
624 self.preloop() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
625 if self.use_rawinput and self.completekey: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
626 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
627 import readline |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
628 self.old_completer = readline.get_completer() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
629 readline.set_completer(self.complete) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
630 readline.parse_and_bind(self.completekey+": complete") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
631 except ImportError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
632 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
633 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
634 if intro is not None: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
635 self.intro = intro |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
636 if self.intro: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
637 self.stdout.write(str(self.intro)+"\n") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
638 stop = None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
639 while not stop: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
640 if self.cmdqueue: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
641 line = self.cmdqueue.pop(0) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
642 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
643 line = self.pseudo_raw_input(self.prompt) |
103 | 644 if (self.echo) and (isinstance(self.stdin, file)): |
645 self.stdout.write(line + '\n') | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
646 line = self.precmd(line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
647 stop = self.onecmd(line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
648 stop = self.postcmd(stop, line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
649 self.postloop() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
650 finally: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
651 if self.use_rawinput and self.completekey: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
652 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
653 import readline |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
654 readline.set_completer(self.old_completer) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
655 except ImportError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
656 pass |
43 | 657 return stop |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
658 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
659 def do_EOF(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
660 return True |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
661 do_eof = do_EOF |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
662 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
663 def showParam(self, param): |
206 | 664 any_shown = False |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
665 param = param.strip().lower() |
199 | 666 for p in self.settable: |
667 if p.startswith(param): | |
668 val = getattr(self, p) | |
669 self.stdout.write('%s: %s\n' % (p, str(getattr(self, p)))) | |
206 | 670 any_shown = True |
671 if not any_shown: | |
672 print "Parameter '%s' not supported (type 'show' for list of parameters)." % param | |
199 | 673 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
674 def do_quit(self, arg): |
43 | 675 return self._STOP_AND_EXIT |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
676 do_exit = do_quit |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
677 do_q = do_quit |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
678 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
679 def do_show(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
680 'Shows value of a parameter' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
681 if arg.strip(): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
682 self.showParam(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
683 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
684 for param in self.settable: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
685 self.showParam(param) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
686 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
687 def do_set(self, arg): |
199 | 688 '''Sets a cmd2 parameter. Accepts abbreviated parameter names so long as there is no ambiguity. |
689 Call without arguments for a list of settable parameters with their values.''' | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
690 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
691 paramName, val = arg.split(None, 1) |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
692 paramName = paramName.strip().lower() |
199 | 693 hits = [paramName in p for p in self.settable] |
694 if hits.count(True) == 1: | |
695 paramName = self.settable[hits.index(True)] | |
696 currentVal = getattr(self, paramName) | |
697 if (val[0] == val[-1]) and val[0] in ("'", '"'): | |
698 val = val[1:-1] | |
699 else: | |
700 val = cast(currentVal, val) | |
701 setattr(self, paramName, val) | |
702 self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val)) | |
212 | 703 if currentVal != val: |
704 try: | |
705 onchange_hook = getattr(self, '_onchange_%s' % paramName) | |
706 onchange_hook(old=currentVal, new=val) | |
707 except AttributeError: | |
708 pass | |
199 | 709 else: |
710 self.do_show(paramName) | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
711 except (ValueError, AttributeError, NotSettableError), e: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
712 self.do_show(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
713 |
182
1c21db096f49
switched literal newline to lineEnd
catherine@Elli.myhome.westell.com
parents:
181
diff
changeset
|
714 def do_pause(self, arg): |
1c21db096f49
switched literal newline to lineEnd
catherine@Elli.myhome.westell.com
parents:
181
diff
changeset
|
715 'Displays the specified text then waits for the user to press RETURN.' |
1c21db096f49
switched literal newline to lineEnd
catherine@Elli.myhome.westell.com
parents:
181
diff
changeset
|
716 raw_input(arg + '\n') |
1c21db096f49
switched literal newline to lineEnd
catherine@Elli.myhome.westell.com
parents:
181
diff
changeset
|
717 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
718 def do_shell(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
719 'execute a command as if at the OS prompt.' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
720 os.system(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
721 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
722 def do_history(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
723 """history [arg]: lists past commands issued |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
724 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
725 no arg -> list all |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
726 arg is integer -> list one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
727 arg is string -> string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
728 arg is /enclosed in forward-slashes/ -> regular expression search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
729 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
730 if arg: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
731 history = self.history.get(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
732 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
733 history = self.history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
734 for hi in history: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
735 self.stdout.write(hi.pr()) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
736 def last_matching(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
737 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
738 if arg: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
739 return self.history.get(arg)[-1] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
740 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
741 return self.history[-1] |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
742 except IndexError: |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
743 return None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
744 def do_list(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
745 """list [arg]: lists last command issued |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
746 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
747 no arg -> list absolute last |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
748 arg is integer -> list one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
749 - arg, arg - (integer) -> list up to or after #arg |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
750 arg is string -> list last command matching string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
751 arg is /enclosed in forward-slashes/ -> regular expression search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
752 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
753 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
754 self.stdout.write(self.last_matching(arg).pr()) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
755 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
756 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
757 do_hi = do_history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
758 do_l = do_list |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
759 do_li = do_list |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
760 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
761 def do_ed(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
762 """ed: edit most recent command in text editor |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
763 ed [N]: edit numbered command from history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
764 ed [filename]: edit specified file name |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
765 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
766 commands are run after editor is closed. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
767 "set edit (program-name)" or set EDITOR environment variable |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
768 to control which editing program is used.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
769 if not self.editor: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
770 print "please use 'set editor' to specify your text editing program of choice." |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
771 return |
207 | 772 filename = self.default_file_name |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
773 if arg: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
774 try: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
775 buffer = self.last_matching(int(arg)) |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
776 except ValueError: |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
777 filename = arg |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
778 buffer = '' |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
779 else: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
780 buffer = self.history[-1] |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
781 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
782 if buffer: |
202 | 783 f = open(os.path.expanduser(filename), 'w') |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
784 f.write(buffer or '') |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
785 f.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
786 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
787 os.system('%s %s' % (self.editor, filename)) |
48 | 788 self.do__load(filename) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
789 do_edit = do_ed |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
790 |
91 | 791 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") + |
157 | 792 pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") + |
91 | 793 pyparsing.stringEnd) |
794 def do_save(self, arg): | |
795 """`save [N] [filename.ext]` | |
796 Saves command from history to file. | |
797 N => Number of command (from history), or `*`; | |
798 most recent command if omitted""" | |
799 | |
800 try: | |
801 args = self.saveparser.parseString(arg) | |
802 except pyparsing.ParseException: | |
803 print self.do_save.__doc__ | |
804 return | |
207 | 805 fname = args.fname or self.default_file_name |
91 | 806 if args.idx == '*': |
807 saveme = '\n\n'.join(self.history[:]) | |
808 elif args.idx: | |
809 saveme = self.history[int(args.idx)-1] | |
810 else: | |
811 saveme = self.history[-1] | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
812 try: |
202 | 813 f = open(os.path.expanduser(fname), 'w') |
91 | 814 f.write(saveme) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
815 f.close() |
91 | 816 print 'Saved to %s' % (fname) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
817 except Exception, e: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
818 print 'Error saving %s: %s' % (fname, str(e)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
819 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
820 def do_load(self, fname=None): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
821 """Runs command(s) from a file.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
822 if fname is None: |
207 | 823 fname = self.default_file_name |
200
05c0e28306d3
expanding ~ in file names
catherine@Elli.myhome.westell.com
parents:
199
diff
changeset
|
824 fname = os.path.expanduser(fname) |
207 | 825 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuation_prompt')) |
41 | 826 if isinstance(fname, file): |
827 self.stdin = fname | |
828 else: | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
829 try: |
202 | 830 self.stdin = open(os.path.expanduser(fname), 'r') |
41 | 831 except IOError, e: |
832 try: | |
202 | 833 self.stdin = open('%s.%s' % (os.path.expanduser(fname), self.defaultExtension), 'r') |
41 | 834 except IOError: |
835 print 'Problem opening file %s: \n%s' % (fname, e) | |
836 keepstate.restore() | |
837 return | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
838 self.use_rawinput = False |
207 | 839 self.prompt = self.continuation_prompt = '' |
42 | 840 stop = self.cmdloop() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
841 self.stdin.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
842 keepstate.restore() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
843 self.lastcmd = '' |
48 | 844 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT |
845 do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython | |
43 | 846 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
847 def do_run(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
848 """run [arg]: re-runs an earlier command |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
849 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
850 no arg -> run most recent command |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
851 arg is integer -> run one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
852 arg is string -> run most recent command by string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
853 arg is /enclosed in forward-slashes/ -> run most recent by regex |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
854 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
855 'run [N]: runs the SQL that was run N commands ago' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
856 runme = self.last_matching(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
857 print runme |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
858 if runme: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
859 runme = self.precmd(runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
860 stop = self.onecmd(runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
861 stop = self.postcmd(stop, runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
862 do_r = do_run |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
863 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
864 def fileimport(self, statement, source): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
865 try: |
202 | 866 f = open(os.path.expanduser(source)) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
867 except IOError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
868 self.stdout.write("Couldn't read from file %s\n" % source) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
869 return '' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
870 data = f.read() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
871 f.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
872 return data |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
873 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
874 class HistoryItem(str): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
875 def __init__(self, instr): |
121
fe432d010ecc
going to attempt 2.4 and 2.6 compatibility
catherine@dellzilla
parents:
119
diff
changeset
|
876 str.__init__(self) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
877 self.lowercase = self.lower() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
878 self.idx = None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
879 def pr(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
880 return '-------------------------[%d]\n%s\n' % (self.idx, str(self)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
881 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
882 class History(list): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
883 rangeFrom = re.compile(r'^([\d])+\s*\-$') |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
884 def append(self, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
885 new = HistoryItem(new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
886 list.append(self, new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
887 new.idx = len(self) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
888 def extend(self, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
889 for n in new: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
890 self.append(n) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
891 def get(self, getme): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
892 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
893 getme = int(getme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
894 if getme < 0: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
895 return self[:(-1 * getme)] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
896 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
897 return [self[getme-1]] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
898 except IndexError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
899 return [] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
900 except (ValueError, TypeError): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
901 getme = getme.strip() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
902 mtch = self.rangeFrom.search(getme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
903 if mtch: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
904 return self[(int(mtch.group(1))-1):] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
905 if getme.startswith(r'/') and getme.endswith(r'/'): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
906 finder = re.compile(getme[1:-1], re.DOTALL | re.MULTILINE | re.IGNORECASE) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
907 def isin(hi): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
908 return finder.search(hi) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
909 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
910 def isin(hi): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
911 return (getme.lower() in hi.lowercase) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
912 return [itm for itm in self if isin(itm)] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
913 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
914 class NotSettableError(Exception): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
915 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
916 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
917 def cast(current, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
918 """Tries to force a new value into the same type as the current.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
919 typ = type(current) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
920 if typ == bool: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
921 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
922 return bool(int(new)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
923 except ValueError, TypeError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
924 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
925 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
926 new = new.lower() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
927 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
928 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
929 if (new=='on') or (new[0] in ('y','t')): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
930 return True |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
931 if (new=='off') or (new[0] in ('n','f')): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
932 return False |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
933 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
934 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
935 return typ(new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
936 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
937 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
938 print "Problem setting parameter (now %s) to %s; incorrect type?" % (current, new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
939 return current |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
940 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
941 class Statekeeper(object): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
942 def __init__(self, obj, attribs): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
943 self.obj = obj |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
944 self.attribs = attribs |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
945 self.save() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
946 def save(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
947 for attrib in self.attribs: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
948 setattr(self, attrib, getattr(self.obj, attrib)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
949 def restore(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
950 for attrib in self.attribs: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
951 setattr(self.obj, attrib, getattr(self, attrib)) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
952 |
104 | 953 class Borg(object): |
954 '''All instances of any Borg subclass will share state. | |
955 from Python Cookbook, 2nd Ed., recipe 6.16''' | |
956 _shared_state = {} | |
957 def __new__(cls, *a, **k): | |
958 obj = object.__new__(cls, *a, **k) | |
959 obj.__dict__ = cls._shared_state | |
960 return obj | |
961 | |
962 class OutputTrap(Borg): | |
963 '''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing. | |
964 Call `tearDown()` to return to normal output.''' | |
965 def __init__(self): | |
105 | 966 self.old_stdout = sys.stdout |
104 | 967 self.trap = tempfile.TemporaryFile() |
968 sys.stdout = self.trap | |
105 | 969 def read(self): |
104 | 970 self.trap.seek(0) |
971 result = self.trap.read() | |
105 | 972 self.trap.truncate(0) |
973 return result.strip('\x00') | |
104 | 974 def tearDown(self): |
975 sys.stdout = self.old_stdout | |
976 | |
977 class Cmd2TestCase(unittest.TestCase): | |
978 '''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class | |
109 | 979 that will execute the commands in transcriptFileName and expect the results shown. |
980 See example.py''' | |
104 | 981 CmdApp = None |
982 transcriptFileName = '' | |
983 def setUp(self): | |
984 if self.CmdApp: | |
105 | 985 self.outputTrap = OutputTrap() |
104 | 986 self.cmdapp = self.CmdApp() |
173 | 987 try: |
202 | 988 tfile = open(os.path.expanduser(self.transcriptFileName)) |
180 | 989 self.transcript = iter(tfile.readlines()) |
173 | 990 tfile.close() |
991 except IOError: | |
992 self.transcript = [] | |
181
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
993 def assertEqualEnough(self, got, expected, message): |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
994 got = got.strip().splitlines() |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
995 expected = expected.strip().splitlines() |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
996 self.assertEqual(len(got), len(expected), message) |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
997 for (linegot, lineexpected) in zip(got, expected): |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
998 matchme = re.escape(lineexpected.strip()).replace('\\*', '.*'). \ |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
999 replace('\\ ', ' ') |
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
1000 self.assert_(re.match(matchme, linegot.strip()), message) |
104 | 1001 def testall(self): |
180 | 1002 if self.CmdApp: |
1003 lineNum = 0 | |
1004 try: | |
1005 line = self.transcript.next() | |
1006 while True: | |
1007 while not line.startswith(self.cmdapp.prompt): | |
1008 line = self.transcript.next() | |
1009 command = [line[len(self.cmdapp.prompt):]] | |
1010 line = self.transcript.next() | |
207 | 1011 while line.startswith(self.cmdapp.continuation_prompt): |
1012 command.append(line[len(self.cmdapp.continuation_prompt):]) | |
180 | 1013 line = self.transcript.next() |
1014 command = ''.join(command) | |
1015 self.cmdapp.onecmd(command) | |
1016 result = self.outputTrap.read() | |
1017 if line.startswith(self.cmdapp.prompt): | |
181
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
1018 self.assertEqualEnough(result.strip(), '', |
180 | 1019 '\nFile %s, line %d\nCommand was:\n%s\nExpected: (nothing) \nGot:\n%s\n' % |
1020 (self.transcriptFileName, lineNum, command, result)) | |
1021 continue | |
1022 expected = [] | |
1023 while not line.startswith(self.cmdapp.prompt): | |
1024 expected.append(line) | |
1025 line = self.transcript.next() | |
1026 expected = ''.join(expected) | |
181
24eff658997b
accepts wildcards in tests, maybe?
catherine@Elli.myhome.westell.com
parents:
180
diff
changeset
|
1027 self.assertEqualEnough(expected.strip(), result.strip(), |
180 | 1028 '\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' % |
1029 (self.transcriptFileName, lineNum, command, expected, result)) | |
1030 # this needs to account for a line-by-line strip()ping | |
1031 except StopIteration: | |
1032 pass | |
1033 # catch the final output? | |
104 | 1034 def tearDown(self): |
1035 if self.CmdApp: | |
1036 self.outputTrap.tearDown() | |
1037 | |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
1038 if __name__ == '__main__': |
158 | 1039 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE) |
1040 #c = Cmd() |