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