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