annotate cmd2.py @ 233:d2cc9a090b7f

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