Mercurial > python-cmd2
annotate cmd2.py @ 177:f2b1643b5173 0.4.4
argh, zero-arg commands were dying
author | catherine@dellzilla |
---|---|
date | Fri, 12 Dec 2008 16:10:38 -0500 |
parents | 645467c0d3f9 |
children | 321e0cc35661 |
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 | |
165 | 64 arg = arg.parser('%s %s%s%s' % (arg.parsed.command, newArgs, arg.parsed.terminator, arg.parsed.suffix)) |
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 = '> ' |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
179 legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit # 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' |
170
310ebf4baa7a
\n endings still squirrely; watch blank spaces in saved files
catherine@dellzilla
parents:
169
diff
changeset
|
185 settable = ['prompt', 'continuationPrompt', 'defaultFileName', 'editor', 'caseInsensitive', 'echo'] |
169 | 186 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
187 editor = os.environ.get('EDITOR') |
42 | 188 _STOP_AND_EXIT = 2 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
189 if not editor: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
190 if sys.platform[:3] == 'win': |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
191 editor = 'notepad' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
192 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
193 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']: |
47 | 194 if not os.system('which %s' % (editor)): |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
195 break |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
196 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
197 def do_cmdenvironment(self, args): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
198 self.stdout.write(""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
199 Commands are %(casesensitive)scase-sensitive. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
200 Commands may be terminated with: %(terminators)s |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
201 Settable parameters: %(settable)s |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
202 """ % |
2
1ea887b51cad
python 2.4 compatibility
catherine@DellZilla.myhome.westell.com
parents:
0
diff
changeset
|
203 { 'casesensitive': ('not ' and self.caseInsensitive) or '', |
171 | 204 'terminators': str(self.terminators), |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
205 'settable': ' '.join(self.settable) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
206 }) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
207 |
10 | 208 def do_help(self, arg): |
209 cmd.Cmd.do_help(self, arg) | |
210 try: | |
211 fn = getattr(self, 'do_' + arg) | |
212 if fn and fn.optionParser: | |
213 fn.optionParser.print_help(file=self.stdout) | |
214 except AttributeError: | |
215 pass | |
216 | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
217 def __init__(self, *args, **kwargs): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
218 cmd.Cmd.__init__(self, *args, **kwargs) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
219 self.history = History() |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
220 self._init_parser() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
221 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
222 def do_shortcuts(self, args): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
223 """Lists single-key shortcuts available.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
224 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
|
225 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
|
226 |
137 | 227 commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment]) |
153 | 228 commentGrammars.addParseAction(lambda x: '') |
136 | 229 commentInProgress = pyparsing.Literal('/*') + pyparsing.SkipTo(pyparsing.stringEnd) |
171 | 230 terminators = [';'] |
231 blankLinesAllowed = False | |
153 | 232 multilineCommands = [] |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
233 |
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
234 def _init_parser(self): |
146 | 235 ''' |
236 >>> c = Cmd() | |
153 | 237 >>> c.multilineCommands = ['multiline'] |
238 >>> c.caseInsensitive = True | |
239 >>> c._init_parser() | |
158 | 240 >>> print c.parser.parseString('').dump() |
241 [] | |
242 >>> print c.parser.parseString('/* empty command */').dump() | |
243 [] | |
244 >>> print c.parser.parseString('plainword').dump() | |
245 ['plainword', ''] | |
246 - command: plainword | |
247 - statement: ['plainword', ''] | |
248 - command: plainword | |
157 | 249 >>> print c.parser.parseString('termbare;').dump() |
158 | 250 ['termbare', '', ';', ''] |
251 - command: termbare | |
252 - statement: ['termbare', '', ';'] | |
253 - command: termbare | |
254 - terminator: ; | |
255 - terminator: ; | |
157 | 256 >>> print c.parser.parseString('termbare; suffx').dump() |
158 | 257 ['termbare', '', ';', 'suffx'] |
258 - command: termbare | |
259 - statement: ['termbare', '', ';'] | |
260 - command: termbare | |
261 - terminator: ; | |
262 - suffix: suffx | |
263 - terminator: ; | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
264 >>> print c.parser.parseString('barecommand').dump() |
153 | 265 ['barecommand', ''] |
266 - command: barecommand | |
267 - statement: ['barecommand', ''] | |
268 - command: barecommand | |
269 >>> print c.parser.parseString('COMmand with args').dump() | |
157 | 270 ['command', 'with args'] |
271 - args: with args | |
153 | 272 - command: command |
157 | 273 - statement: ['command', 'with args'] |
274 - args: with args | |
153 | 275 - command: command |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
276 >>> print c.parser.parseString('command with args and terminator; and suffix').dump() |
158 | 277 ['command', 'with args and terminator', ';', 'and suffix'] |
153 | 278 - args: with args and terminator |
279 - command: command | |
280 - statement: ['command', 'with args and terminator', ';'] | |
281 - args: with args and terminator | |
282 - command: command | |
283 - terminator: ; | |
158 | 284 - suffix: and suffix |
285 - terminator: ; | |
153 | 286 >>> print c.parser.parseString('simple | piped').dump() |
157 | 287 ['simple', '', '|', ' piped'] |
153 | 288 - command: simple |
157 | 289 - pipeTo: piped |
153 | 290 - statement: ['simple', ''] |
291 - command: simple | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
292 >>> print c.parser.parseString('command with args, terminator;sufx | piped').dump() |
157 | 293 ['command', 'with args, terminator', ';', 'sufx', '|', ' piped'] |
153 | 294 - args: with args, terminator |
295 - command: command | |
157 | 296 - pipeTo: piped |
153 | 297 - statement: ['command', 'with args, terminator', ';'] |
298 - args: with args, terminator | |
299 - command: command | |
300 - terminator: ; | |
301 - suffix: sufx | |
155 | 302 - terminator: ; |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
303 >>> print c.parser.parseString('output into > afile.txt').dump() |
157 | 304 ['output', 'into', '>', 'afile.txt'] |
153 | 305 - args: into |
306 - command: output | |
307 - output: > | |
155 | 308 - outputTo: afile.txt |
157 | 309 - statement: ['output', 'into'] |
310 - args: into | |
311 - command: output | |
312 >>> print c.parser.parseString('output into;sufx | pipethrume plz > afile.txt').dump() | |
313 ['output', 'into', ';', 'sufx', '|', ' pipethrume plz', '>', 'afile.txt'] | |
314 - args: into | |
315 - command: output | |
316 - output: > | |
317 - outputTo: afile.txt | |
318 - pipeTo: pipethrume plz | |
153 | 319 - statement: ['output', 'into', ';'] |
320 - args: into | |
321 - command: output | |
322 - terminator: ; | |
323 - suffix: sufx | |
324 - terminator: ; | |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
325 >>> print c.parser.parseString('output to paste buffer >> ').dump() |
157 | 326 ['output', 'to paste buffer', '>>', ''] |
327 - args: to paste buffer | |
153 | 328 - command: output |
329 - output: >> | |
157 | 330 - statement: ['output', 'to paste buffer'] |
331 - args: to paste buffer | |
153 | 332 - command: output |
152
693d11072e8e
hmm, complications with gt within statements
catherine@Elli.myhome.westell.com
parents:
151
diff
changeset
|
333 >>> print c.parser.parseString('ignore the /* commented | > */ stuff;').dump() |
153 | 334 ['ignore', 'the /* commented | > */ stuff', ';', ''] |
335 - args: the /* commented | > */ stuff | |
336 - command: ignore | |
337 - statement: ['ignore', 'the /* commented | > */ stuff', ';'] | |
338 - args: the /* commented | > */ stuff | |
339 - command: ignore | |
340 - terminator: ; | |
341 - terminator: ; | |
342 >>> print c.parser.parseString('has > inside;').dump() | |
343 ['has', '> inside', ';', ''] | |
344 - args: > inside | |
345 - command: has | |
346 - statement: ['has', '> inside', ';'] | |
347 - args: > inside | |
348 - command: has | |
349 - terminator: ; | |
350 - terminator: ; | |
351 >>> print c.parser.parseString('multiline has > inside an unfinished command').dump() | |
173 | 352 ['multiline', ' has > inside an unfinished command'] |
153 | 353 - multilineCommand: multiline |
354 >>> print c.parser.parseString('multiline has > inside;').dump() | |
355 ['multiline', 'has > inside', ';', ''] | |
356 - args: has > inside | |
357 - multilineCommand: multiline | |
358 - statement: ['multiline', 'has > inside', ';'] | |
359 - args: has > inside | |
360 - multilineCommand: multiline | |
361 - terminator: ; | |
362 - terminator: ; | |
363 >>> print c.parser.parseString('multiline command /* with comment in progress;').dump() | |
173 | 364 ['multiline', ' command /* with comment in progress;'] |
153 | 365 - multilineCommand: multiline |
366 >>> print c.parser.parseString('multiline command /* with comment complete */ is done;').dump() | |
367 ['multiline', 'command /* with comment complete */ is done', ';', ''] | |
368 - args: command /* with comment complete */ is done | |
369 - multilineCommand: multiline | |
370 - statement: ['multiline', 'command /* with comment complete */ is done', ';'] | |
371 - args: command /* with comment complete */ is done | |
372 - multilineCommand: multiline | |
373 - terminator: ; | |
158 | 374 - terminator: ; |
153 | 375 ''' |
146 | 376 outputParser = pyparsing.oneOf(['>>','>'])('output') |
171 | 377 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
|
378 stringEnd = pyparsing.stringEnd ^ '\nEOF' |
153 | 379 multilineCommand = pyparsing.Or([pyparsing.Keyword(c, caseless=self.caseInsensitive) for c in self.multilineCommands])('multilineCommand') |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
380 oneLineCommand = pyparsing.Word(self.legalChars)('command') |
160 | 381 pipe = pyparsing.Keyword('|', identChars='|') |
168 | 382 self.commentGrammars.ignore(pyparsing.sglQuotedString).ignore(pyparsing.dblQuotedString).setParseAction(lambda x: '') |
383 self.commentInProgress.ignore(pyparsing.sglQuotedString).ignore(pyparsing.dblQuotedString).ignore(pyparsing.cStyleComment) | |
153 | 384 afterElements = \ |
160 | 385 pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \ |
155 | 386 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
|
387 if self.caseInsensitive: |
153 | 388 multilineCommand.setParseAction(lambda x: x[0].lower()) |
389 oneLineCommand.setParseAction(lambda x: x[0].lower()) | |
171 | 390 if self.blankLinesAllowed: |
173 | 391 blankLineTerminationParser = pyparsing.NoMatch |
171 | 392 else: |
174 | 393 blankLineTerminator = (pyparsing.Literal('\n')('terminator') + stringEnd) |
173 | 394 blankLineTerminationParser = ((multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(blankLineTerminator).setParseAction(lambda x: x[0].strip())('args') + blankLineTerminator)('statement') |
395 multilineParser = (((multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(terminatorParser).setParseAction(lambda x: x[0].strip())('args') + terminatorParser)('statement') + | |
170
310ebf4baa7a
\n endings still squirrely; watch blank spaces in saved files
catherine@dellzilla
parents:
169
diff
changeset
|
396 pyparsing.SkipTo(outputParser ^ pipe ^ stringEnd).setParseAction(lambda x: x[0].strip())('suffix') + afterElements) |
173 | 397 singleLineParser = ((oneLineCommand + pyparsing.SkipTo(terminatorParser ^ stringEnd ^ pipe ^ outputParser).setParseAction(lambda x:x[0].strip())('args'))('statement') + |
170
310ebf4baa7a
\n endings still squirrely; watch blank spaces in saved files
catherine@dellzilla
parents:
169
diff
changeset
|
398 pyparsing.Optional(terminatorParser) + afterElements) |
153 | 399 self.parser = ( |
173 | 400 stringEnd | |
401 multilineParser | | |
402 multilineCommand + pyparsing.SkipTo(stringEnd) | | |
174 | 403 singleLineParser | |
404 blankLineTerminationParser | |
153 | 405 ) |
169 | 406 self.parser.ignore(pyparsing.sglQuotedString).ignore(pyparsing.dblQuotedString).ignore(self.commentGrammars).ignore(self.commentInProgress) |
407 | |
154 | 408 inputMark = pyparsing.Literal('<') |
409 inputMark.setParseAction(lambda x: '') | |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
410 inputFrom = pyparsing.Word(self.legalChars + '/\\')('inputFrom') |
154 | 411 inputFrom.setParseAction(lambda x: (x and open(x[0]).read()) or getPasteBuffer()) |
412 self.inputParser = inputMark + pyparsing.Optional(inputFrom) | |
413 self.inputParser.ignore(pyparsing.sglQuotedString).ignore(pyparsing.dblQuotedString).ignore(self.commentGrammars).ignore(self.commentInProgress) | |
153 | 414 |
165 | 415 def parsed(self, raw, **kwargs): |
162
c50615cf814f
merged with changes from work
catherine@Elli.myhome.westell.com
parents:
161
diff
changeset
|
416 if isinstance(raw, ParsedString): |
165 | 417 p = raw |
418 else: | |
171 | 419 s = self.inputParser.transformString(raw.lstrip()) |
165 | 420 for (shortcut, expansion) in self.shortcuts.items(): |
421 if s.startswith(shortcut): | |
422 s = s.replace(shortcut, expansion + ' ', 1) | |
423 break | |
424 result = self.parser.parseString(s) | |
425 result['command'] = result.multilineCommand or result.command | |
426 result['raw'] = raw | |
427 result['clean'] = self.commentGrammars.transformString(result.args) | |
428 result['expanded'] = s | |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
429 p = ParsedString(result.clean) |
165 | 430 p.parsed = result |
431 p.parser = self.parsed | |
432 for (key, val) in kwargs.items(): | |
433 p.parsed[key] = val | |
157 | 434 return p |
435 | |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
436 def onecmd(self, line): |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
437 """Interpret the argument as though it had been typed in response |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
438 to the prompt. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
439 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
440 This may be overridden, but should not normally need to be; |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
441 see the precmd() and postcmd() methods for useful execution hooks. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
442 The return value is a flag indicating whether interpretation of |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
443 commands by the interpreter should stop. |
157 | 444 |
445 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
|
446 |
3 | 447 """ |
83
2176ce847939
merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents:
82
diff
changeset
|
448 if not line: |
157 | 449 return self.emptyline() |
135
7c0a89fccf2b
broken; midway through comments
catherine@Elli.myhome.westell.com
parents:
134
diff
changeset
|
450 if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line): |
157 | 451 return 0 |
154 | 452 try: |
453 statement = self.parsed(line) | |
170
310ebf4baa7a
\n endings still squirrely; watch blank spaces in saved files
catherine@dellzilla
parents:
169
diff
changeset
|
454 while statement.parsed.multilineCommand and (statement.parsed.terminator == ''): |
166
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
455 statement = self.parsed('%s\n%s' % (statement.parsed.raw, |
a3414ac38677
so close - now problem with terminator in string
catherine@dellzilla
parents:
165
diff
changeset
|
456 self.pseudo_raw_input(self.continuationPrompt))) |
154 | 457 except Exception, e: |
458 print e | |
459 return 0 | |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
460 |
177 | 461 if not statement.parsed.command: |
175 | 462 return 0 |
463 | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
464 statekeeper = None |
25 | 465 stop = 0 |
154 | 466 |
157 | 467 if statement.parsed.pipeTo: |
468 redirect = subprocess.Popen(statement.parsed.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE) | |
51 | 469 statekeeper = Statekeeper(self, ('stdout',)) |
47 | 470 self.stdout = redirect.stdin |
157 | 471 elif statement.parsed.output: |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
472 statekeeper = Statekeeper(self, ('stdout',)) |
157 | 473 if statement.parsed.outputTo: |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
474 mode = 'w' |
157 | 475 if statement.parsed.output == '>>': |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
476 mode = 'a' |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
477 try: |
157 | 478 self.stdout = open(statement.parsed.outputTo, mode) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
479 except OSError, e: |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
480 print e |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
481 return 0 |
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
482 else: |
51 | 483 statekeeper = Statekeeper(self, ('stdout',)) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
484 self.stdout = tempfile.TemporaryFile() |
157 | 485 if statement.parsed.output == '>>': |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
486 self.stdout.write(getPasteBuffer()) |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
487 try: |
157 | 488 # "heart" of the command, replace's cmd's onecmd() |
489 self.lastcmd = statement.parsed.expanded | |
490 try: | |
491 func = getattr(self, 'do_' + statement.parsed.command) | |
492 except AttributeError: | |
493 return self.default(statement) | |
494 stop = func(statement) | |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
495 except Exception, e: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
496 print e |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
497 try: |
157 | 498 if statement.parsed.command not in self.excludeFromHistory: |
499 self.history.append(statement.parsed.raw) | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
500 finally: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
501 if statekeeper: |
157 | 502 if statement.parsed.output and not statement.parsed.outputTo: |
27 | 503 self.stdout.seek(0) |
134
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
504 try: |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
505 writeToPasteBuffer(self.stdout.read()) |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
506 except Exception, e: |
c28ae4f75c15
incorporated changes from branch at work
catherine@Elli.myhome.westell.com
parents:
133
diff
changeset
|
507 print str(e) |
157 | 508 elif statement.parsed.pipeTo: |
52
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
509 for result in redirect.communicate(): |
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
510 statekeeper.stdout.write(result or '') |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
511 self.stdout.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
512 statekeeper.restore() |
52
49de899a05a8
new unified pipe and redirect works on wc
catherine@localhost
parents:
51
diff
changeset
|
513 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
514 return stop |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
515 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
516 def pseudo_raw_input(self, prompt): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
517 """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
|
518 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
519 if self.use_rawinput: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
520 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
521 line = raw_input(prompt) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
522 except EOFError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
523 line = 'EOF' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
524 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
525 self.stdout.write(prompt) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
526 self.stdout.flush() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
527 line = self.stdin.readline() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
528 if not len(line): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
529 line = 'EOF' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
530 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
531 if line[-1] == '\n': # this was always true in Cmd |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
532 line = line[:-1] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
533 return line |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
534 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
535 def cmdloop(self, intro=None): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
536 """Repeatedly issue a prompt, accept input, parse an initial prefix |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
537 off the received input, and dispatch to action methods, passing them |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
538 the remainder of the line as argument. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
539 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
540 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
541 # 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
|
542 # has been split out so that it can be called separately |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
543 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
544 self.preloop() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
545 if self.use_rawinput and self.completekey: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
546 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
547 import readline |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
548 self.old_completer = readline.get_completer() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
549 readline.set_completer(self.complete) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
550 readline.parse_and_bind(self.completekey+": complete") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
551 except ImportError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
552 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
553 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
554 if intro is not None: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
555 self.intro = intro |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
556 if self.intro: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
557 self.stdout.write(str(self.intro)+"\n") |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
558 stop = None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
559 while not stop: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
560 if self.cmdqueue: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
561 line = self.cmdqueue.pop(0) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
562 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
563 line = self.pseudo_raw_input(self.prompt) |
103 | 564 if (self.echo) and (isinstance(self.stdin, file)): |
565 self.stdout.write(line + '\n') | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
566 line = self.precmd(line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
567 stop = self.onecmd(line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
568 stop = self.postcmd(stop, line) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
569 self.postloop() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
570 finally: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
571 if self.use_rawinput and self.completekey: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
572 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
573 import readline |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
574 readline.set_completer(self.old_completer) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
575 except ImportError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
576 pass |
43 | 577 return stop |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
578 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
579 def do_EOF(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
580 return True |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
581 do_eof = do_EOF |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
582 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
583 def showParam(self, param): |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
584 param = param.strip().lower() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
585 if param in self.settable: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
586 val = getattr(self, param) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
587 self.stdout.write('%s: %s\n' % (param, str(getattr(self, param)))) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
588 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
589 def do_quit(self, arg): |
43 | 590 return self._STOP_AND_EXIT |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
591 do_exit = do_quit |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
592 do_q = do_quit |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
593 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
594 def do_show(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
595 'Shows value of a parameter' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
596 if arg.strip(): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
597 self.showParam(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
598 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
599 for param in self.settable: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
600 self.showParam(param) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
601 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
602 def do_set(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
603 'Sets a parameter' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
604 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
605 paramName, val = arg.split(None, 1) |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
606 paramName = paramName.strip().lower() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
607 if paramName not in self.settable: |
106 | 608 raise NotSettableError |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
609 currentVal = getattr(self, paramName) |
106 | 610 if (val[0] == val[-1]) and val[0] in ("'", '"'): |
611 val = val[1:-1] | |
612 else: | |
163
61a57c44cd93
ugh - parsing stripping command causes real trouble
catherine@dellzilla
parents:
162
diff
changeset
|
613 val = cast(currentVal, val) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
614 setattr(self, paramName, val) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
615 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
|
616 except (ValueError, AttributeError, NotSettableError), e: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
617 self.do_show(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
618 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
619 def do_shell(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
620 'execute a command as if at the OS prompt.' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
621 os.system(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
622 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
623 def do_history(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
624 """history [arg]: lists past commands issued |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
625 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
626 no arg -> list all |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
627 arg is integer -> list one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
628 arg is string -> string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
629 arg is /enclosed in forward-slashes/ -> regular expression search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
630 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
631 if arg: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
632 history = self.history.get(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
633 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
634 history = self.history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
635 for hi in history: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
636 self.stdout.write(hi.pr()) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
637 def last_matching(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
638 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
639 if arg: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
640 return self.history.get(arg)[-1] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
641 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
642 return self.history[-1] |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
643 except IndexError: |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
644 return None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
645 def do_list(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
646 """list [arg]: lists last command issued |
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 no arg -> list absolute last |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
649 arg is integer -> list one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
650 - arg, arg - (integer) -> list up to or after #arg |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
651 arg is string -> list last command matching string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
652 arg is /enclosed in forward-slashes/ -> regular expression search |
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 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
655 self.stdout.write(self.last_matching(arg).pr()) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
656 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
657 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
658 do_hi = do_history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
659 do_l = do_list |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
660 do_li = do_list |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
661 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
662 def do_ed(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
663 """ed: edit most recent command in text editor |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
664 ed [N]: edit numbered command from history |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
665 ed [filename]: edit specified file name |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
666 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
667 commands are run after editor is closed. |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
668 "set edit (program-name)" or set EDITOR environment variable |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
669 to control which editing program is used.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
670 if not self.editor: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
671 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
|
672 return |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
673 filename = self.defaultFileName |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
674 if arg: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
675 try: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
676 buffer = self.last_matching(int(arg)) |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
677 except ValueError: |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
678 filename = arg |
133
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
679 buffer = '' |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
680 else: |
31674148b13c
just beginning to make comments work
catherine@Elli.myhome.westell.com
parents:
126
diff
changeset
|
681 buffer = self.history[-1] |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
682 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
683 if buffer: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
684 f = open(filename, 'w') |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
685 f.write(buffer or '') |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
686 f.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
687 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
688 os.system('%s %s' % (self.editor, filename)) |
48 | 689 self.do__load(filename) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
690 do_edit = do_ed |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
691 |
91 | 692 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") + |
157 | 693 pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") + |
91 | 694 pyparsing.stringEnd) |
695 def do_save(self, arg): | |
696 """`save [N] [filename.ext]` | |
697 Saves command from history to file. | |
698 N => Number of command (from history), or `*`; | |
699 most recent command if omitted""" | |
700 | |
701 try: | |
702 args = self.saveparser.parseString(arg) | |
703 except pyparsing.ParseException: | |
704 print self.do_save.__doc__ | |
705 return | |
706 fname = args.fname or self.defaultFileName | |
707 if args.idx == '*': | |
708 saveme = '\n\n'.join(self.history[:]) | |
709 elif args.idx: | |
710 saveme = self.history[int(args.idx)-1] | |
711 else: | |
712 saveme = self.history[-1] | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
713 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
714 f = open(fname, 'w') |
91 | 715 f.write(saveme) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
716 f.close() |
91 | 717 print 'Saved to %s' % (fname) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
718 except Exception, e: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
719 print 'Error saving %s: %s' % (fname, str(e)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
720 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
721 def do_load(self, fname=None): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
722 """Runs command(s) from a file.""" |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
723 if fname is None: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
724 fname = self.defaultFileName |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
725 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuationPrompt')) |
41 | 726 if isinstance(fname, file): |
727 self.stdin = fname | |
728 else: | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
729 try: |
41 | 730 self.stdin = open(fname, 'r') |
731 except IOError, e: | |
732 try: | |
733 self.stdin = open('%s.%s' % (fname, self.defaultExtension), 'r') | |
734 except IOError: | |
735 print 'Problem opening file %s: \n%s' % (fname, e) | |
736 keepstate.restore() | |
737 return | |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
738 self.use_rawinput = False |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
739 self.prompt = self.continuationPrompt = '' |
42 | 740 stop = self.cmdloop() |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
741 self.stdin.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
742 keepstate.restore() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
743 self.lastcmd = '' |
48 | 744 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT |
745 do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython | |
43 | 746 |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
747 def do_run(self, arg): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
748 """run [arg]: re-runs an earlier command |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
749 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
750 no arg -> run most recent command |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
751 arg is integer -> run one history item, by index |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
752 arg is string -> run most recent command by string search |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
753 arg is /enclosed in forward-slashes/ -> run most recent by regex |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
754 """ |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
755 'run [N]: runs the SQL that was run N commands ago' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
756 runme = self.last_matching(arg) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
757 print runme |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
758 if runme: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
759 runme = self.precmd(runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
760 stop = self.onecmd(runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
761 stop = self.postcmd(stop, runme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
762 do_r = do_run |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
763 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
764 def fileimport(self, statement, source): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
765 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
766 f = open(source) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
767 except IOError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
768 self.stdout.write("Couldn't read from file %s\n" % source) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
769 return '' |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
770 data = f.read() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
771 f.close() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
772 return data |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
773 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
774 class HistoryItem(str): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
775 def __init__(self, instr): |
121
fe432d010ecc
going to attempt 2.4 and 2.6 compatibility
catherine@dellzilla
parents:
119
diff
changeset
|
776 str.__init__(self) |
0
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
777 self.lowercase = self.lower() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
778 self.idx = None |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
779 def pr(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
780 return '-------------------------[%d]\n%s\n' % (self.idx, str(self)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
781 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
782 class History(list): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
783 rangeFrom = re.compile(r'^([\d])+\s*\-$') |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
784 def append(self, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
785 new = HistoryItem(new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
786 list.append(self, new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
787 new.idx = len(self) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
788 def extend(self, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
789 for n in new: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
790 self.append(n) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
791 def get(self, getme): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
792 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
793 getme = int(getme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
794 if getme < 0: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
795 return self[:(-1 * getme)] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
796 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
797 return [self[getme-1]] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
798 except IndexError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
799 return [] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
800 except (ValueError, TypeError): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
801 getme = getme.strip() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
802 mtch = self.rangeFrom.search(getme) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
803 if mtch: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
804 return self[(int(mtch.group(1))-1):] |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
805 if getme.startswith(r'/') and getme.endswith(r'/'): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
806 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
|
807 def isin(hi): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
808 return finder.search(hi) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
809 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
810 def isin(hi): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
811 return (getme.lower() in hi.lowercase) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
812 return [itm for itm in self if isin(itm)] |
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 class NotSettableError(Exception): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
815 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
816 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
817 def cast(current, new): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
818 """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
|
819 typ = type(current) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
820 if typ == bool: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
821 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
822 return bool(int(new)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
823 except ValueError, TypeError: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
824 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
825 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
826 new = new.lower() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
827 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
828 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
829 if (new=='on') or (new[0] in ('y','t')): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
830 return True |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
831 if (new=='off') or (new[0] in ('n','f')): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
832 return False |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
833 else: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
834 try: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
835 return typ(new) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
836 except: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
837 pass |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
838 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
|
839 return current |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
840 |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
841 class Statekeeper(object): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
842 def __init__(self, obj, attribs): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
843 self.obj = obj |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
844 self.attribs = attribs |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
845 self.save() |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
846 def save(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
847 for attrib in self.attribs: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
848 setattr(self, attrib, getattr(self.obj, attrib)) |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
849 def restore(self): |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
850 for attrib in self.attribs: |
febfdc79550b
moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff
changeset
|
851 setattr(self.obj, attrib, getattr(self, attrib)) |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
852 |
104 | 853 class Borg(object): |
854 '''All instances of any Borg subclass will share state. | |
855 from Python Cookbook, 2nd Ed., recipe 6.16''' | |
856 _shared_state = {} | |
857 def __new__(cls, *a, **k): | |
858 obj = object.__new__(cls, *a, **k) | |
859 obj.__dict__ = cls._shared_state | |
860 return obj | |
861 | |
862 class OutputTrap(Borg): | |
863 '''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing. | |
864 Call `tearDown()` to return to normal output.''' | |
865 def __init__(self): | |
105 | 866 self.old_stdout = sys.stdout |
104 | 867 self.trap = tempfile.TemporaryFile() |
868 sys.stdout = self.trap | |
105 | 869 def read(self): |
104 | 870 self.trap.seek(0) |
871 result = self.trap.read() | |
105 | 872 self.trap.truncate(0) |
873 return result.strip('\x00') | |
104 | 874 def tearDown(self): |
875 sys.stdout = self.old_stdout | |
876 | |
877 class Cmd2TestCase(unittest.TestCase): | |
878 '''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class | |
109 | 879 that will execute the commands in transcriptFileName and expect the results shown. |
880 See example.py''' | |
104 | 881 CmdApp = None |
882 transcriptFileName = '' | |
883 def setUp(self): | |
884 if self.CmdApp: | |
105 | 885 self.outputTrap = OutputTrap() |
104 | 886 self.cmdapp = self.CmdApp() |
173 | 887 try: |
888 tfile = open(self.transcriptFileName) | |
889 self.transcript = tfile.readlines() | |
890 tfile.close() | |
891 except IOError: | |
892 self.transcript = [] | |
893 def divideTranscript(self): | |
894 self.dialogue = [] | |
895 commandStart = None | |
175 | 896 response = [] |
897 command = [] | |
898 prompt = self.cmdapp.prompt.rstrip() | |
899 continuationPrompt = self.cmdapp.continuationPrompt.rstrip() | |
900 for (lineNum, line) in enumerate(self.transcript): | |
901 if line.startswith(prompt): | |
902 if command: | |
903 self.dialogue.append((commandStart, ''.join(command), ''.join(response))) | |
904 command = [line[len(prompt)+1:]] | |
905 commandStart = lineNum | |
906 response = [] | |
907 elif line.startswith(continuationPrompt): | |
908 command.append(line[len(continuationPrompt)+1:]) | |
909 else: | |
910 response.append(line) | |
104 | 911 def testall(self): |
912 if self.CmdApp: | |
173 | 913 self.divideTranscript() |
914 for (lineNum, command, expected) in self.dialogue: | |
174 | 915 self.cmdapp.onecmd(command) |
105 | 916 result = self.outputTrap.read() |
174 | 917 self.assertEqual(result.strip(), expected.strip(), |
104 | 918 '\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' % |
173 | 919 (self.transcriptFileName, lineNum, command, expected, result)) |
104 | 920 def tearDown(self): |
921 if self.CmdApp: | |
922 self.outputTrap.tearDown() | |
923 | |
79
f583663c610f
switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents:
56
diff
changeset
|
924 if __name__ == '__main__': |
158 | 925 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE) |
926 #c = Cmd() |