annotate cmd2.py @ 257:d62bb3dd58a0

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