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