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