python-cmd2: cmd2.py annotate

annotate cmd2.py @ 216:dcc5f871a5b6

more postparse hook work

author	catherine@dellzilla
date	Mon, 16 Mar 2009 12:32:39 -0400
parents	e9091d9a3a60
children	0a2fd4b5dad7

rev	line source
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	1 """Variant on standard library's cmd with extra features.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	2
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	3 To use, simply import cmd2.Cmd instead of cmd.Cmd; use precisely as though you
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	4 were using the standard library's cmd, while enjoying the extra features.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	5
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	6 Searchable command history (commands: "hi", "li", "run")
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	7 Load commands from file, save to file, edit commands in file
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	8 Multi-line commands
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	9 Case-insensitive commands
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	10 Special-character shortcut commands (beyond cmd's "@" and "!")
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	11 Settable environment parameters
213 500955dece3f parameter onchange hook comment catherine@Elli.myhome.westell.com parents: 212 diff changeset	12 Optional _onchange_{paramname} called when environment parameter changes
13 c6e8b645c0ab tweaking docs catherine@localhost parents: 12 diff changeset	13 Parsing commands with `optparse` options (flags)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	14 Redirection to file with >, >>; input from file with <
112 e3b8eaadea56 going to collapse down out of overdone package structure catherine@Elli.myhome.westell.com parents: 109 diff changeset	15 Easy transcript-based testing of applications (see example/example.py)
13 c6e8b645c0ab tweaking docs catherine@localhost parents: 12 diff changeset	16
84 416ea36af789 fixed bug in setting parameters catherine@Elli.myhome.westell.com parents: 83 diff changeset	17 Note that redirection with > and \| will only work if `self.stdout.write()`
416ea36af789 fixed bug in setting parameters catherine@Elli.myhome.westell.com parents: 83 diff changeset	18 is used in place of `print`. The standard library's `cmd` module is
416ea36af789 fixed bug in setting parameters catherine@Elli.myhome.westell.com parents: 83 diff changeset	19 written to use `self.stdout.write()`,
416ea36af789 fixed bug in setting parameters catherine@Elli.myhome.westell.com parents: 83 diff changeset	20
14 a242603905d9 ready to release 0.3.0 catherine@localhost parents: 13 diff changeset	21 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	22
126 197a312f2656 push to get to v 126 catherine@dellzilla parents: 124 diff changeset	23 mercurial repository at http://www.assembla.com/wiki/show/python-cmd2
14 a242603905d9 ready to release 0.3.0 catherine@localhost parents: 13 diff changeset	24 CHANGES:
a242603905d9 ready to release 0.3.0 catherine@localhost parents: 13 diff changeset	25 As of 0.3.0, options should be specified as `optparse` options. See README.txt.
a242603905d9 ready to release 0.3.0 catherine@localhost parents: 13 diff changeset	26 flagReader.py options are still supported for backward compatibility
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	27 """
192 c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	28 import cmd, re, os, sys, optparse, subprocess, tempfile, pyparsing, doctest
c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	29 import unittest, string, datetime
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	30 from optparse import make_option
211 5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	31 __version__ = '0.4.8'
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	32
11 34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	33 class OptionParser(optparse.OptionParser):
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	34 def exit(self, status=0, msg=None):
38 6d715d7a04fd proper exit after -h, -v catherine@localhost parents: 37 diff changeset	35 self.values._exit = True
11 34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	36 if msg:
15 0eb8d4e18472 fixed error handling catherine@localhost parents: 14 diff changeset	37 print msg
211 5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	38
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	39 def print_help(self, args, *kwargs):
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	40 # now, I need to call help of the calling function. Hmm.
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	41 try:
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	42 print self._func.__doc__
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	43 except AttributeError:
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	44 pass
5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	45 optparse.OptionParser.print_help(self, args, *kwargs)
11 34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	46
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	47 def error(self, msg):
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	48 """error(msg : string)
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	49
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	50 Print a usage message incorporating 'msg' to stderr and exit.
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	51 If you override this in a subclass, it should not return -- it
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	52 should either exit or raise an exception.
34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	53 """
15 0eb8d4e18472 fixed error handling catherine@localhost parents: 14 diff changeset	54 raise
11 34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	55
187 183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	56 def remainingArgs(oldArgs, newArgList):
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	57 '''
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	58 >>> remainingArgs('-f bar bar cow', ['bar', 'cow'])
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	59 'bar cow'
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	60 '''
189 06119abd352e synch catherine@Elli.myhome.westell.com parents: 187 diff changeset	61 pattern = '\s+'.join(re.escape(a) for a in newArgList) + '\s*$'
187 183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	62 matchObj = re.search(pattern, oldArgs)
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	63 return oldArgs[matchObj.start():]
183dd2fffec5 newline terminators ok catherine@Elli.myhome.westell.com parents: 186 diff changeset	64
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	65 def options(option_list):
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	66 def option_setup(func):
11 34107b79c840 working the refactor still catherine@localhost parents: 10 diff changeset	67 optionParser = OptionParser()
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	68 for opt in option_list:
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	69 optionParser.add_option(opt)
12 b636cb715925 tested catherine@localhost parents: 11 diff changeset	70 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
211 5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	71 optionParser._func = func
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	72 def newFunc(instance, arg):
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	73 try:
190 51c15fe803a4 synch catherine@Elli.myhome.westell.com parents: 189 diff changeset	74 opts, newArgList = optionParser.parse_args(arg.split()) # doesn't understand quoted strings shouldn't be dissected!
51c15fe803a4 synch catherine@Elli.myhome.westell.com parents: 189 diff changeset	75 newArgs = remainingArgs(arg, newArgList) # should it permit flags after args?
20 c8efa4369189 fixes to option parsing catherine@cordelia parents: 15 diff changeset	76 except (optparse.OptionValueError, optparse.BadOptionError,
c8efa4369189 fixes to option parsing catherine@cordelia parents: 15 diff changeset	77 optparse.OptionError, optparse.AmbiguousOptionError,
c8efa4369189 fixes to option parsing catherine@cordelia parents: 15 diff changeset	78 optparse.OptionConflictError), e:
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	79 print e
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	80 optionParser.print_help()
38 6d715d7a04fd proper exit after -h, -v catherine@localhost parents: 37 diff changeset	81 return
6d715d7a04fd proper exit after -h, -v catherine@localhost parents: 37 diff changeset	82 if hasattr(opts, '_exit'):
6d715d7a04fd proper exit after -h, -v catherine@localhost parents: 37 diff changeset	83 return None
214 68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	84 if hasattr(arg, 'parser'):
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	85 terminator = arg.parsed.terminator
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	86 try:
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	87 if arg.parsed.terminator[0] == '\n':
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	88 terminator = arg.parsed.terminator[0]
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	89 except IndexError:
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	90 pass
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	91 arg = arg.parser('%s %s%s%s' % (arg.parsed.command, newArgs,
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	92 terminator, arg.parsed.suffix))
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	93 else:
68c03076c9e7 multiple connections catherine@Elli.myhome.westell.com parents: 213 diff changeset	94 arg = newArgs
37 a974e2f44cbe made redirectors work with app-specific StatementEndPattern catherine@localhost parents: 36 diff changeset	95 result = func(instance, arg, opts)
159 5a94501b6b93 fix new bug in argument parsing catherine@dellzilla parents: 158 diff changeset	96 return result
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	97 newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	98 return newFunc
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	99 return option_setup
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	100
27 a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	101 class PasteBufferError(EnvironmentError):
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	102 if sys.platform[:3] == 'win':
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	103 errmsg = """Redirecting to or from paste buffer requires pywin32
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	104 to be installed on operating system.
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	105 Download from http://sourceforge.net/projects/pywin32/"""
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	106 else:
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	107 errmsg = """Redirecting to or from paste buffer requires xclip
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	108 to be installed on operating system.
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	109 On Debian/Ubuntu, 'sudo apt-get install xclip' will install it."""
28 28b3fb301d3d almost working, but problem with check_call catherine@cordelia parents: 27 diff changeset	110 def __init__(self):
27 a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	111 Exception.__init__(self, self.errmsg)
a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	112
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	113 '''check here if functions exist; otherwise, stub out'''
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	114 pastebufferr = """Redirecting to or from paste buffer requires %s
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	115 to be installed on operating system.
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	116 %s"""
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	117 if subprocess.mswindows:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	118 try:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	119 import win32clipboard
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	120 def getPasteBuffer():
28 28b3fb301d3d almost working, but problem with check_call catherine@cordelia parents: 27 diff changeset	121 win32clipboard.OpenClipboard(0)
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	122 try:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	123 result = win32clipboard.GetClipboardData()
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	124 except TypeError:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	125 result = '' #non-text
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	126 win32clipboard.CloseClipboard()
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	127 return result
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	128 def writeToPasteBuffer(txt):
28 28b3fb301d3d almost working, but problem with check_call catherine@cordelia parents: 27 diff changeset	129 win32clipboard.OpenClipboard(0)
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	130 win32clipboard.EmptyClipboard()
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	131 win32clipboard.SetClipboardText(txt)
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	132 win32clipboard.CloseClipboard()
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	133 except ImportError:
106 2d3232693807 prompt-setting quirks catherine@dellzilla parents: 105 diff changeset	134 def getPasteBuffer(*args):
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	135 raise OSError, pastebufferr % ('pywin32', 'Download from http://sourceforge.net/projects/pywin32/')
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	136 setPasteBuffer = getPasteBuffer
27 a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	137 else:
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	138 can_clip = False
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	139 try:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	140 subprocess.check_call('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	141 can_clip = True
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	142 except AttributeError: # check_call not defined, Python < 2.5
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	143 teststring = 'Testing for presence of xclip.'
31 dd64c0e3dbe0 fixed err in python 2.4 xclip detection catherine@localhost parents: 29 diff changeset	144 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	145 xclipproc.stdin.write(teststring)
31 dd64c0e3dbe0 fixed err in python 2.4 xclip detection catherine@localhost parents: 29 diff changeset	146 xclipproc.stdin.close()
dd64c0e3dbe0 fixed err in python 2.4 xclip detection catherine@localhost parents: 29 diff changeset	147 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	148 if xclipproc.stdout.read() == teststring:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	149 can_clip = True
56 f844b6c78192 fixing (hopefully) broken pipe error for headless systems catherine.devlin@gmail.com parents: 54 diff changeset	150 except (subprocess.CalledProcessError, OSError, IOError):
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	151 pass
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	152 if can_clip:
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	153 def getPasteBuffer():
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	154 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	155 return xclipproc.stdout.read()
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	156 def writeToPasteBuffer(txt):
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	157 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	158 xclipproc.stdin.write(txt)
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	159 xclipproc.stdin.close()
83 2176ce847939 merged copy to both clipboards in catherine@Elli.myhome.westell.com parents: 82 diff changeset	160 # but we want it in both the "primary" and "mouse" clipboards
2176ce847939 merged copy to both clipboards in catherine@Elli.myhome.westell.com parents: 82 diff changeset	161 xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
2176ce847939 merged copy to both clipboards in catherine@Elli.myhome.westell.com parents: 82 diff changeset	162 xclipproc.stdin.write(txt)
2176ce847939 merged copy to both clipboards in catherine@Elli.myhome.westell.com parents: 82 diff changeset	163 xclipproc.stdin.close()
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	164 else:
106 2d3232693807 prompt-setting quirks catherine@dellzilla parents: 105 diff changeset	165 def getPasteBuffer(*args):
29 c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	166 raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"')
c4bd5f1a6968 paste buffer working on linux and windows catherine@cordelia parents: 28 diff changeset	167 setPasteBuffer = getPasteBuffer
106 2d3232693807 prompt-setting quirks catherine@dellzilla parents: 105 diff changeset	168 writeToPasteBuffer = getPasteBuffer
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	169
f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	170 pyparsing.ParserElement.setDefaultWhitespaceChars(' \t')
154 606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	171
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	172 class ParsedString(str):
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	173 pass
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	174
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	175 class SkipToLast(pyparsing.SkipTo):
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	176 def parseImpl( self, instring, loc, doActions=True ):
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	177 resultStore = []
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	178 startLoc = loc
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	179 instrlen = len(instring)
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	180 expr = self.expr
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	181 failParse = False
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	182 while loc <= instrlen:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	183 try:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	184 if self.failOn:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	185 failParse = True
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	186 self.failOn.tryParse(instring, loc)
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	187 failParse = False
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	188 loc = expr._skipIgnorables( instring, loc )
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	189 expr._parse( instring, loc, doActions=False, callPreParse=False )
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	190 skipText = instring[startLoc:loc]
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	191 if self.includeMatch:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	192 loc,mat = expr._parse(instring,loc,doActions,callPreParse=False)
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	193 if mat:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	194 skipRes = ParseResults( skipText )
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	195 skipRes += mat
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	196 resultStore.append((loc, [ skipRes ]))
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	197 else:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	198 resultStore,append((loc, [ skipText ]))
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	199 else:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	200 resultStore.append((loc, [ skipText ]))
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	201 loc += 1
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	202 except (pyparsing.ParseException,IndexError):
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	203 if failParse:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	204 raise
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	205 else:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	206 loc += 1
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	207 if resultStore:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	208 return resultStore[-1]
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	209 else:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	210 exc = self.myException
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	211 exc.loc = loc
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	212 exc.pstr = instring
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	213 raise exc
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	214
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	215 def replace_with_file_contents(fname):
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	216 if fname:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	217 try:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	218 result = open(os.path.expanduser(fname[0])).read()
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	219 except IOError:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	220 result = '< %s' % fname[0] # wasn't a file after all
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	221 else:
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	222 result = getPasteBuffer()
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	223 return result
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	224
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	225 class Cmd(cmd.Cmd):
103 e4daf715fc31 echo on catherine@dellzilla parents: 100 diff changeset	226 echo = False
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	227 case_insensitive = True
a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	228 continuation_prompt = '> '
192 c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	229 timing = False
166 a3414ac38677 so close - now problem with terminator in string catherine@dellzilla parents: 165 diff changeset	230 legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit # make sure your terminators are not in here!
137 308e99cebbb8 comments working? catherine@dellzilla parents: 136 diff changeset	231 shortcuts = {'?': 'help', '!': 'shell', '@': 'load' }
106 2d3232693807 prompt-setting quirks catherine@dellzilla parents: 105 diff changeset	232 excludeFromHistory = '''run r list l history hi ed edit li eof'''.split()
2d3232693807 prompt-setting quirks catherine@dellzilla parents: 105 diff changeset	233 noSpecialParse = 'set ed edit exit'.split()
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	234 defaultExtension = 'txt'
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	235 default_file_name = 'command.txt'
a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	236 settable = ['prompt', 'continuation_prompt', 'default_file_name', 'editor', 'case_insensitive',
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	237 'echo', 'timing']
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	238 settable.sort()
169 429c8e984df4 all working, except \n\n terminators catherine@dellzilla parents: 168 diff changeset	239
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	240 editor = os.environ.get('EDITOR')
42 b3200c6e5763 inserting exception for quit... catherine@cordelia parents: 41 diff changeset	241 _STOP_AND_EXIT = 2
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	242 if not editor:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	243 if sys.platform[:3] == 'win':
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	244 editor = 'notepad'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	245 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	246 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
47 927bc07467de fixed misfind of editor catherine@cordelia parents: 46 diff changeset	247 if not os.system('which %s' % (editor)):
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	248 break
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	249
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	250 def do_cmdenvironment(self, args):
193 e96877b59371 tweaked docs catherine@Elli.myhome.westell.com parents: 192 diff changeset	251 '''Summary report of interactive parameters.'''
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	252 self.stdout.write("""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	253 Commands are %(casesensitive)scase-sensitive.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	254 Commands may be terminated with: %(terminators)s
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	255 Settable parameters: %(settable)s
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	256 """ %
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	257 { 'casesensitive': (self.case_insensitive and 'not ') or '',
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	258 'terminators': str(self.terminators),
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	259 'settable': ' '.join(self.settable)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	260 })
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	261
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	262 def do_help(self, arg):
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	263 try:
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	264 fn = getattr(self, 'do_' + arg)
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	265 if fn and fn.optionParser:
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	266 fn.optionParser.print_help(file=self.stdout)
211 5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	267 return
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	268 except AttributeError:
47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	269 pass
211 5da7d72e72ee print full help on -h catherine@Elli.myhome.westell.com parents: 210 diff changeset	270 cmd.Cmd.do_help(self, arg)
10 47af95ad83c7 working the refactor still catherine@localhost parents: 4 diff changeset	271
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	272 def __init__(self, args, *kwargs):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	273 cmd.Cmd.__init__(self, args, *kwargs)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	274 self.history = History()
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	275 self._init_parser()
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	276
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	277 def do_shortcuts(self, args):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	278 """Lists single-key shortcuts available."""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	279 result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in self.shortcuts.items())
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	280 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	281
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	282 prefixParser = pyparsing.Empty()
137 308e99cebbb8 comments working? catherine@dellzilla parents: 136 diff changeset	283 commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment])
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	284 commentGrammars.addParseAction(lambda x: '')
136 67558b85ab38 comments working? catherine@dellzilla parents: 135 diff changeset	285 commentInProgress = pyparsing.Literal('/*') + pyparsing.SkipTo(pyparsing.stringEnd)
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	286 terminators = [';']
0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	287 blankLinesAllowed = False
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	288 multilineCommands = []
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	289
693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	290 def _init_parser(self):
184 d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	291 r'''
146 9ffb01d8876f streamlining parsing catherine@dellzilla parents: 145 diff changeset	292 >>> c = Cmd()
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	293 >>> c.multilineCommands = ['multiline']
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	294 >>> c.case_insensitive = True
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	295 >>> c._init_parser()
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	296 >>> print c.parser.parseString('').dump()
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	297 []
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	298 >>> print c.parser.parseString('/* empty command */').dump()
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	299 []
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	300 >>> print c.parser.parseString('plainword').dump()
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	301 ['plainword', '']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	302 - command: plainword
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	303 - statement: ['plainword', '']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	304 - command: plainword
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	305 >>> print c.parser.parseString('termbare;').dump()
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	306 ['termbare', '', ';', '']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	307 - command: termbare
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	308 - statement: ['termbare', '', ';']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	309 - command: termbare
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	310 - terminator: ;
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	311 - terminator: ;
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	312 >>> print c.parser.parseString('termbare; suffx').dump()
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	313 ['termbare', '', ';', 'suffx']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	314 - command: termbare
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	315 - statement: ['termbare', '', ';']
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	316 - command: termbare
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	317 - terminator: ;
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	318 - suffix: suffx
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	319 - terminator: ;
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	320 >>> print c.parser.parseString('barecommand').dump()
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	321 ['barecommand', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	322 - command: barecommand
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	323 - statement: ['barecommand', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	324 - command: barecommand
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	325 >>> print c.parser.parseString('COMmand with args').dump()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	326 ['command', 'with args']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	327 - args: with args
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	328 - command: command
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	329 - statement: ['command', 'with args']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	330 - args: with args
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	331 - command: command
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	332 >>> print c.parser.parseString('command with args and terminator; and suffix').dump()
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	333 ['command', 'with args and terminator', ';', 'and suffix']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	334 - args: with args and terminator
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	335 - command: command
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	336 - statement: ['command', 'with args and terminator', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	337 - args: with args and terminator
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	338 - command: command
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	339 - terminator: ;
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	340 - suffix: and suffix
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	341 - terminator: ;
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	342 >>> print c.parser.parseString('simple \| piped').dump()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	343 ['simple', '', '\|', ' piped']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	344 - command: simple
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	345 - pipeTo: piped
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	346 - statement: ['simple', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	347 - command: simple
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	348 >>> print c.parser.parseString('double-pipe \|\| is not a pipe').dump()
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	349 ['double', '-pipe \|\| is not a pipe']
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	350 - args: -pipe \|\| is not a pipe
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	351 - command: double
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	352 - statement: ['double', '-pipe \|\| is not a pipe']
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	353 - args: -pipe \|\| is not a pipe
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	354 - command: double
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	355 >>> print c.parser.parseString('command with args, terminator;sufx \| piped').dump()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	356 ['command', 'with args, terminator', ';', 'sufx', '\|', ' piped']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	357 - args: with args, terminator
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	358 - command: command
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	359 - pipeTo: piped
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	360 - statement: ['command', 'with args, terminator', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	361 - args: with args, terminator
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	362 - command: command
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	363 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	364 - suffix: sufx
155 8ba5127167f5 file output working again catherine@dellzilla parents: 154 diff changeset	365 - terminator: ;
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	366 >>> print c.parser.parseString('output into > afile.txt').dump()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	367 ['output', 'into', '>', 'afile.txt']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	368 - args: into
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	369 - command: output
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	370 - output: >
155 8ba5127167f5 file output working again catherine@dellzilla parents: 154 diff changeset	371 - outputTo: afile.txt
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	372 - statement: ['output', 'into']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	373 - args: into
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	374 - command: output
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	375 >>> print c.parser.parseString('output into;sufx \| pipethrume plz > afile.txt').dump()
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	376 ['output', 'into', ';', 'sufx', '\|', ' pipethrume plz', '>', 'afile.txt']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	377 - args: into
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	378 - command: output
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	379 - output: >
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	380 - outputTo: afile.txt
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	381 - pipeTo: pipethrume plz
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	382 - statement: ['output', 'into', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	383 - args: into
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	384 - command: output
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	385 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	386 - suffix: sufx
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	387 - terminator: ;
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	388 >>> print c.parser.parseString('output to paste buffer >> ').dump()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	389 ['output', 'to paste buffer', '>>', '']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	390 - args: to paste buffer
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	391 - command: output
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	392 - output: >>
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	393 - statement: ['output', 'to paste buffer']
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	394 - args: to paste buffer
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	395 - command: output
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	396 >>> print c.parser.parseString('ignore the /* commented \| > */ stuff;').dump()
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	397 ['ignore', 'the /* commented \| > */ stuff', ';', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	398 - args: the /* commented \| > */ stuff
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	399 - command: ignore
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	400 - statement: ['ignore', 'the /* commented \| > */ stuff', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	401 - args: the /* commented \| > */ stuff
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	402 - command: ignore
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	403 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	404 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	405 >>> print c.parser.parseString('has > inside;').dump()
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	406 ['has', '> inside', ';', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	407 - args: > inside
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	408 - command: has
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	409 - statement: ['has', '> inside', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	410 - args: > inside
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	411 - command: has
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	412 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	413 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	414 >>> print c.parser.parseString('multiline has > inside an unfinished command').dump()
173 10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	415 ['multiline', ' has > inside an unfinished command']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	416 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	417 >>> print c.parser.parseString('multiline has > inside;').dump()
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	418 ['multiline', 'has > inside', ';', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	419 - args: has > inside
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	420 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	421 - statement: ['multiline', 'has > inside', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	422 - args: has > inside
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	423 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	424 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	425 - terminator: ;
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	426 >>> print c.parser.parseString('multiline command /* with comment in progress;').dump()
173 10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	427 ['multiline', ' command /* with comment in progress;']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	428 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	429 >>> print c.parser.parseString('multiline command /* with comment complete */ is done;').dump()
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	430 ['multiline', 'command /* with comment complete */ is done', ';', '']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	431 - args: command /* with comment complete */ is done
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	432 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	433 - statement: ['multiline', 'command /* with comment complete */ is done', ';']
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	434 - args: command /* with comment complete */ is done
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	435 - multilineCommand: multiline
5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	436 - terminator: ;
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	437 - terminator: ;
186 bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	438 >>> print c.parser.parseString('multiline command ends\n\n').dump()
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	439 ['multiline', 'command ends', '\n', '\n']
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	440 - args: command ends
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	441 - multilineCommand: multiline
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	442 - statement: ['multiline', 'command ends', '\n', '\n']
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	443 - args: command ends
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	444 - multilineCommand: multiline
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	445 - terminator: ['\n', '\n']
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	446 - terminator: ['\n', '\n']
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	447 '''
195 455ebe415d5e do not interpret => as having the redirector > catherine@dellzilla parents: 194 diff changeset	448 outputParser = (pyparsing.Literal('>>') \| (pyparsing.WordStart() + '>') \| pyparsing.Regex('[^=]>'))('output')
455ebe415d5e do not interpret => as having the redirector > catherine@dellzilla parents: 194 diff changeset	449
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	450 terminatorParser = pyparsing.Or([(hasattr(t, 'parseString') and t) or pyparsing.Literal(t) for t in self.terminators])('terminator')
152 693d11072e8e hmm, complications with gt within statements catherine@Elli.myhome.westell.com parents: 151 diff changeset	451 stringEnd = pyparsing.stringEnd ^ '\nEOF'
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	452 self.multilineCommand = pyparsing.Or([pyparsing.Keyword(c, caseless=self.case_insensitive) for c in self.multilineCommands])('multilineCommand')
186 bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	453 oneLineCommand = (~self.multilineCommand + pyparsing.Word(self.legalChars))('command')
160 59b7847ec3ca little fixes catherine@dellzilla parents: 159 diff changeset	454 pipe = pyparsing.Keyword('\|', identChars='\|')
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	455 self.commentGrammars.ignore(pyparsing.quotedString).setParseAction(lambda x: '')
68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	456 self.commentInProgress.ignore(pyparsing.quotedString).ignore(pyparsing.cStyleComment)
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	457 afterElements = \
160 59b7847ec3ca little fixes catherine@dellzilla parents: 159 diff changeset	458 pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \
155 8ba5127167f5 file output working again catherine@dellzilla parents: 154 diff changeset	459 pyparsing.Optional(outputParser + pyparsing.SkipTo(stringEnd).setParseAction(lambda x: x[0].strip())('outputTo'))
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	460 if self.case_insensitive:
184 d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	461 self.multilineCommand.setParseAction(lambda x: x[0].lower())
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	462 oneLineCommand.setParseAction(lambda x: x[0].lower())
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	463 if self.blankLinesAllowed:
184 d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	464 self.blankLineTerminationParser = pyparsing.NoMatch
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	465 else:
186 bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	466 self.blankLineTerminator = (pyparsing.lineEnd + pyparsing.lineEnd)('terminator')
184 d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	467 self.blankLineTerminator.setResultsName('terminator')
d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	468 self.blankLineTerminationParser = ((self.multilineCommand ^ oneLineCommand) + pyparsing.SkipTo(self.blankLineTerminator).setParseAction(lambda x: x[0].strip())('args') + self.blankLineTerminator)('statement')
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	469 self.multilineParser = (((self.multilineCommand ^ oneLineCommand) + SkipToLast(terminatorParser).setParseAction(lambda x: x[0].strip())('args') + terminatorParser)('statement') +
184 d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	470 pyparsing.SkipTo(outputParser ^ pipe ^ stringEnd).setParseAction(lambda x: x[0].strip())('suffix') + afterElements)
d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	471 self.singleLineParser = ((oneLineCommand + pyparsing.SkipTo(terminatorParser ^ stringEnd ^ pipe ^ outputParser).setParseAction(lambda x:x[0].strip())('args'))('statement') +
d1a87c14675b putting parsing variables under self catherine@Elli.myhome.westell.com parents: 183 diff changeset	472 pyparsing.Optional(terminatorParser) + afterElements)
186 bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	473 #self.multilineParser = self.multilineParser.setResultsName('multilineParser')
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	474 #self.singleLineParser = self.singleLineParser.setResultsName('singleLineParser')
bee79220382c unit tests passing catherine@Elli.myhome.westell.com parents: 185 diff changeset	475 #self.blankLineTerminationParser = self.blankLineTerminationParser.setResultsName('blankLineTerminatorParser')
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	476 self.parser = (
173 10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	477 stringEnd \|
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	478 self.prefixParser + self.multilineParser \|
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	479 self.prefixParser + self.singleLineParser \|
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	480 self.prefixParser + self.blankLineTerminationParser \|
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	481 self.prefixParser + self.multilineCommand + pyparsing.SkipTo(stringEnd)
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	482 )
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	483 self.parser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
169 429c8e984df4 all working, except \n\n terminators catherine@dellzilla parents: 168 diff changeset	484
154 606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	485 inputMark = pyparsing.Literal('<')
606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	486 inputMark.setParseAction(lambda x: '')
204 5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	487 fileName = pyparsing.Word(self.legalChars + '/\\')
5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	488 inputFrom = fileName('inputFrom')
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	489 inputFrom.setParseAction(replace_with_file_contents)
204 5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	490 # a not-entirely-satisfactory way of distinguishing < as in "import from" from <
5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	491 # as in "lesser than"
5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	492 self.inputParser = inputMark + pyparsing.Optional(inputFrom) + pyparsing.Optional('>') + \
5d22be6d2f88 v1.6.0 catherine@dellzilla parents: 203 diff changeset	493 pyparsing.Optional(fileName) + (pyparsing.stringEnd \| '\|')
203 68a609fc516b limit < infile slurp to cases where infile found catherine@dellzilla parents: 202 diff changeset	494 self.inputParser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
153 5c5c458a6b70 parsing going well catherine@dellzilla parents: 152 diff changeset	495
165 3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	496 def parsed(self, raw, **kwargs):
162 c50615cf814f merged with changes from work catherine@Elli.myhome.westell.com parents: 161 diff changeset	497 if isinstance(raw, ParsedString):
165 3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	498 p = raw
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	499 else:
171 0b93f1a4076c lstripping commands catherine@dellzilla parents: 170 diff changeset	500 s = self.inputParser.transformString(raw.lstrip())
165 3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	501 for (shortcut, expansion) in self.shortcuts.items():
201 6cdf53ce84f5 unknown catherine@Elli.myhome.westell.com parents: 200 diff changeset	502 if s.lower().startswith(shortcut):
165 3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	503 s = s.replace(shortcut, expansion + ' ', 1)
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	504 break
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	505 result = self.parser.parseString(s)
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	506 result['command'] = result.multilineCommand or result.command
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	507 result['raw'] = raw
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	508 result['clean'] = self.commentGrammars.transformString(result.args)
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	509 result['expanded'] = s
166 a3414ac38677 so close - now problem with terminator in string catherine@dellzilla parents: 165 diff changeset	510 p = ParsedString(result.clean)
165 3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	511 p.parsed = result
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	512 p.parser = self.parsed
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	513 for (key, val) in kwargs.items():
3dc882a00e53 terminators + suffixes now preserved catherine@dellzilla parents: 164 diff changeset	514 p.parsed[key] = val
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	515 return p
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	516
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	517 def postparsing_precmd(self, statement):
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	518 stop = 0
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	519 return stop, statement
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	520 def postparsing_postcmd(self, stop):
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	521 return stop
166 a3414ac38677 so close - now problem with terminator in string catherine@dellzilla parents: 165 diff changeset	522 def onecmd(self, line):
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	523 """Interpret the argument as though it had been typed in response
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	524 to the prompt.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	525
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	526 This may be overridden, but should not normally need to be;
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	527 see the precmd() and postcmd() methods for useful execution hooks.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	528 The return value is a flag indicating whether interpretation of
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	529 commands by the interpreter should stop.
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	530
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	531 This (`cmd2`) version of `onecmd` already override's `cmd`'s `onecmd`.
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	532
3 4520a1a073ff require terminator for redirection catherine@cordelia parents: 2 diff changeset	533 """
83 2176ce847939 merged copy to both clipboards in catherine@Elli.myhome.westell.com parents: 82 diff changeset	534 if not line:
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	535 return self.emptyline()
135 7c0a89fccf2b broken; midway through comments catherine@Elli.myhome.westell.com parents: 134 diff changeset	536 if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line):
179 321e0cc35661 oh no... must accept prompt changes catherine@Elli.myhome.westell.com parents: 177 diff changeset	537 return 0 # command was empty except for comments
154 606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	538 try:
606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	539 statement = self.parsed(line)
170 310ebf4baa7a \n endings still squirrely; watch blank spaces in saved files catherine@dellzilla parents: 169 diff changeset	540 while statement.parsed.multilineCommand and (statement.parsed.terminator == ''):
192 c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	541 statement = '%s\n%s' % (statement.parsed.raw,
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	542 self.pseudo_raw_input(self.continuation_prompt))
192 c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	543 statement = self.parsed(statement)
154 606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	544 except Exception, e:
606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	545 print e
606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	546 return 0
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	547
216 dcc5f871a5b6 more postparse hook work catherine@dellzilla parents: 215 diff changeset	548 try:
dcc5f871a5b6 more postparse hook work catherine@dellzilla parents: 215 diff changeset	549 (stop, statement) = self.postparsing_precmd(statement)
dcc5f871a5b6 more postparse hook work catherine@dellzilla parents: 215 diff changeset	550 except Exception, e:
dcc5f871a5b6 more postparse hook work catherine@dellzilla parents: 215 diff changeset	551 print str(e)
dcc5f871a5b6 more postparse hook work catherine@dellzilla parents: 215 diff changeset	552 return 0
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	553 if stop:
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	554 return self.postparsing_postcmd(stop)
175 72de7d8566e2 tests finally passing catherine@dellzilla parents: 174 diff changeset	555
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	556 if not statement.parsed.command:
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	557 return self.postparsing_postcmd(stop=0)
e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	558
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	559 statekeeper = None
154 606ad25c7f7e new experiment with ignore? catherine@dellzilla parents: 153 diff changeset	560
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	561 if statement.parsed.pipeTo:
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	562 redirect = subprocess.Popen(statement.parsed.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
51 26e33f64f68e trying new unified pipe and redirect catherine@localhost parents: 50 diff changeset	563 statekeeper = Statekeeper(self, ('stdout',))
47 927bc07467de fixed misfind of editor catherine@cordelia parents: 46 diff changeset	564 self.stdout = redirect.stdin
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	565 elif statement.parsed.output:
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	566 statekeeper = Statekeeper(self, ('stdout',))
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	567 if statement.parsed.outputTo:
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	568 mode = 'w'
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	569 if statement.parsed.output == '>>':
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	570 mode = 'a'
f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	571 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	572 self.stdout = open(os.path.expanduser(statement.parsed.outputTo), mode)
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	573 except OSError, e:
f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	574 print e
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	575 return self.postparsing_postcmd(stop=0)
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	576 else:
51 26e33f64f68e trying new unified pipe and redirect catherine@localhost parents: 50 diff changeset	577 statekeeper = Statekeeper(self, ('stdout',))
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	578 self.stdout = tempfile.TemporaryFile()
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	579 if statement.parsed.output == '>>':
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	580 self.stdout.write(getPasteBuffer())
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	581 try:
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	582 # "heart" of the command, replace's cmd's onecmd()
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	583 self.lastcmd = statement.parsed.expanded
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	584 try:
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	585 func = getattr(self, 'do_' + statement.parsed.command)
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	586 except AttributeError:
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	587 return self.postparsing_postcmd(self.default(statement))
192 c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	588 timestart = datetime.datetime.now()
c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	589 stop = func(statement)
c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	590 if self.timing:
c0d4c7ba14a9 added settable timings param catherine@Elli.myhome.westell.com parents: 191 diff changeset	591 print 'Elapsed: %s' % str(datetime.datetime.now() - timestart)
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	592 except Exception, e:
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	593 print e
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	594 try:
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	595 if statement.parsed.command not in self.excludeFromHistory:
10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	596 self.history.append(statement.parsed.raw)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	597 finally:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	598 if statekeeper:
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	599 if statement.parsed.output and not statement.parsed.outputTo:
27 a76798cde34c hooray, pasting working in windows catherine@cordelia parents: 26 diff changeset	600 self.stdout.seek(0)
134 c28ae4f75c15 incorporated changes from branch at work catherine@Elli.myhome.westell.com parents: 133 diff changeset	601 try:
c28ae4f75c15 incorporated changes from branch at work catherine@Elli.myhome.westell.com parents: 133 diff changeset	602 writeToPasteBuffer(self.stdout.read())
c28ae4f75c15 incorporated changes from branch at work catherine@Elli.myhome.westell.com parents: 133 diff changeset	603 except Exception, e:
c28ae4f75c15 incorporated changes from branch at work catherine@Elli.myhome.westell.com parents: 133 diff changeset	604 print str(e)
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	605 elif statement.parsed.pipeTo:
52 49de899a05a8 new unified pipe and redirect works on wc catherine@localhost parents: 51 diff changeset	606 for result in redirect.communicate():
49de899a05a8 new unified pipe and redirect works on wc catherine@localhost parents: 51 diff changeset	607 statekeeper.stdout.write(result or '')
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	608 self.stdout.close()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	609 statekeeper.restore()
52 49de899a05a8 new unified pipe and redirect works on wc catherine@localhost parents: 51 diff changeset	610
215 e9091d9a3a60 now hooks for pre and post but after parse catherine@Elli.myhome.westell.com parents: 214 diff changeset	611 return self.postparsing_postcmd(stop)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	612
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	613 def pseudo_raw_input(self, prompt):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	614 """copied from cmd's cmdloop; like raw_input, but accounts for changed stdin, stdout"""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	615
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	616 if self.use_rawinput:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	617 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	618 line = raw_input(prompt)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	619 except EOFError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	620 line = 'EOF'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	621 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	622 self.stdout.write(prompt)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	623 self.stdout.flush()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	624 line = self.stdin.readline()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	625 if not len(line):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	626 line = 'EOF'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	627 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	628 if line[-1] == '\n': # this was always true in Cmd
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	629 line = line[:-1]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	630 return line
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	631
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	632 def cmdloop(self, intro=None):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	633 """Repeatedly issue a prompt, accept input, parse an initial prefix
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	634 off the received input, and dispatch to action methods, passing them
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	635 the remainder of the line as argument.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	636 """
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	637
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	638 # An almost perfect copy from Cmd; however, the pseudo_raw_input portion
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	639 # has been split out so that it can be called separately
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	640
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	641 self.preloop()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	642 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	643 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	644 import readline
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	645 self.old_completer = readline.get_completer()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	646 readline.set_completer(self.complete)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	647 readline.parse_and_bind(self.completekey+": complete")
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	648 except ImportError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	649 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	650 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	651 if intro is not None:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	652 self.intro = intro
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	653 if self.intro:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	654 self.stdout.write(str(self.intro)+"\n")
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	655 stop = None
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	656 while not stop:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	657 if self.cmdqueue:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	658 line = self.cmdqueue.pop(0)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	659 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	660 line = self.pseudo_raw_input(self.prompt)
103 e4daf715fc31 echo on catherine@dellzilla parents: 100 diff changeset	661 if (self.echo) and (isinstance(self.stdin, file)):
e4daf715fc31 echo on catherine@dellzilla parents: 100 diff changeset	662 self.stdout.write(line + '\n')
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	663 line = self.precmd(line)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	664 stop = self.onecmd(line)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	665 stop = self.postcmd(stop, line)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	666 self.postloop()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	667 finally:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	668 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	669 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	670 import readline
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	671 readline.set_completer(self.old_completer)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	672 except ImportError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	673 pass
43 e03a8c03ac37 command-line args working catherine@cordelia parents: 42 diff changeset	674 return stop
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	675
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	676 def do_EOF(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	677 return True
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	678 do_eof = do_EOF
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	679
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	680 def showParam(self, param):
206 00eaec841567 do not let SET errors pass silently catherine@dellzilla parents: 204 diff changeset	681 any_shown = False
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	682 param = param.strip().lower()
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	683 for p in self.settable:
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	684 if p.startswith(param):
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	685 val = getattr(self, p)
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	686 self.stdout.write('%s: %s\n' % (p, str(getattr(self, p))))
206 00eaec841567 do not let SET errors pass silently catherine@dellzilla parents: 204 diff changeset	687 any_shown = True
00eaec841567 do not let SET errors pass silently catherine@dellzilla parents: 204 diff changeset	688 if not any_shown:
00eaec841567 do not let SET errors pass silently catherine@dellzilla parents: 204 diff changeset	689 print "Parameter '%s' not supported (type 'show' for list of parameters)." % param
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	690
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	691 def do_quit(self, arg):
43 e03a8c03ac37 command-line args working catherine@cordelia parents: 42 diff changeset	692 return self._STOP_AND_EXIT
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	693 do_exit = do_quit
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	694 do_q = do_quit
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	695
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	696 def do_show(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	697 'Shows value of a parameter'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	698 if arg.strip():
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	699 self.showParam(arg)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	700 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	701 for param in self.settable:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	702 self.showParam(param)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	703
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	704 def do_set(self, arg):
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	705 '''Sets a cmd2 parameter. Accepts abbreviated parameter names so long as there is no ambiguity.
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	706 Call without arguments for a list of settable parameters with their values.'''
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	707 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	708 paramName, val = arg.split(None, 1)
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	709 paramName = paramName.strip().lower()
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	710 hits = [paramName in p for p in self.settable]
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	711 if hits.count(True) == 1:
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	712 paramName = self.settable[hits.index(True)]
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	713 currentVal = getattr(self, paramName)
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	714 if (val[0] == val[-1]) and val[0] in ("'", '"'):
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	715 val = val[1:-1]
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	716 else:
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	717 val = cast(currentVal, val)
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	718 setattr(self, paramName, val)
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	719 self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
212 9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	720 if currentVal != val:
9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	721 try:
9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	722 onchange_hook = getattr(self, '_onchange_%s' % paramName)
9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	723 onchange_hook(old=currentVal, new=val)
9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	724 except AttributeError:
9c4c4d012a92 parameter onchange hook catherine@Elli.myhome.westell.com parents: 211 diff changeset	725 pass
199 12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	726 else:
12c2d23caf19 added unit check for doublepipe catherine@dellzilla parents: 197 diff changeset	727 self.do_show(paramName)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	728 except (ValueError, AttributeError, NotSettableError), e:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	729 self.do_show(arg)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	730
182 1c21db096f49 switched literal newline to lineEnd catherine@Elli.myhome.westell.com parents: 181 diff changeset	731 def do_pause(self, arg):
1c21db096f49 switched literal newline to lineEnd catherine@Elli.myhome.westell.com parents: 181 diff changeset	732 'Displays the specified text then waits for the user to press RETURN.'
1c21db096f49 switched literal newline to lineEnd catherine@Elli.myhome.westell.com parents: 181 diff changeset	733 raw_input(arg + '\n')
1c21db096f49 switched literal newline to lineEnd catherine@Elli.myhome.westell.com parents: 181 diff changeset	734
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	735 def do_shell(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	736 'execute a command as if at the OS prompt.'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	737 os.system(arg)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	738
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	739 def do_history(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	740 """history [arg]: lists past commands issued
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	741
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	742 no arg -> list all
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	743 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	744 arg is string -> string search
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	745 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	746 """
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	747 if arg:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	748 history = self.history.get(arg)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	749 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	750 history = self.history
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	751 for hi in history:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	752 self.stdout.write(hi.pr())
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	753 def last_matching(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	754 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	755 if arg:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	756 return self.history.get(arg)[-1]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	757 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	758 return self.history[-1]
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	759 except IndexError:
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	760 return None
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	761 def do_list(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	762 """list [arg]: lists last command issued
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	763
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	764 no arg -> list absolute last
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	765 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	766 - arg, arg - (integer) -> list up to or after #arg
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	767 arg is string -> list last command matching string search
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	768 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	769 """
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	770 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	771 self.stdout.write(self.last_matching(arg).pr())
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	772 except:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	773 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	774 do_hi = do_history
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	775 do_l = do_list
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	776 do_li = do_list
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	777
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	778 def do_ed(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	779 """ed: edit most recent command in text editor
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	780 ed [N]: edit numbered command from history
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	781 ed [filename]: edit specified file name
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	782
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	783 commands are run after editor is closed.
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	784 "set edit (program-name)" or set EDITOR environment variable
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	785 to control which editing program is used."""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	786 if not self.editor:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	787 print "please use 'set editor' to specify your text editing program of choice."
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	788 return
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	789 filename = self.default_file_name
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	790 if arg:
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	791 try:
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	792 buffer = self.last_matching(int(arg))
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	793 except ValueError:
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	794 filename = arg
133 31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	795 buffer = ''
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	796 else:
31674148b13c just beginning to make comments work catherine@Elli.myhome.westell.com parents: 126 diff changeset	797 buffer = self.history[-1]
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	798
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	799 if buffer:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	800 f = open(os.path.expanduser(filename), 'w')
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	801 f.write(buffer or '')
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	802 f.close()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	803
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	804 os.system('%s %s' % (self.editor, filename))
48 34fb41095451 avoiding do_load overload catherine.devlin@gmail.com parents: 47 diff changeset	805 self.do__load(filename)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	806 do_edit = do_ed
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	807
91 88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	808 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") +
157 10e917acf787 wow, parsing is broken catherine@dellzilla parents: 156 diff changeset	809 pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") +
91 88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	810 pyparsing.stringEnd)
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	811 def do_save(self, arg):
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	812 """`save [N] [filename.ext]`
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	813 Saves command from history to file.
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	814 N => Number of command (from history), or `*`;
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	815 most recent command if omitted"""
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	816
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	817 try:
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	818 args = self.saveparser.parseString(arg)
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	819 except pyparsing.ParseException:
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	820 print self.do_save.__doc__
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	821 return
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	822 fname = args.fname or self.default_file_name
91 88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	823 if args.idx == '*':
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	824 saveme = '\n\n'.join(self.history[:])
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	825 elif args.idx:
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	826 saveme = self.history[int(args.idx)-1]
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	827 else:
88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	828 saveme = self.history[-1]
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	829 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	830 f = open(os.path.expanduser(fname), 'w')
91 88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	831 f.write(saveme)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	832 f.close()
91 88f2aa240af1 added to save catherine@Elli.myhome.westell.com parents: 90 diff changeset	833 print 'Saved to %s' % (fname)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	834 except Exception, e:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	835 print 'Error saving %s: %s' % (fname, str(e))
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	836
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	837 def do_load(self, fname=None):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	838 """Runs command(s) from a file."""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	839 if fname is None:
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	840 fname = self.default_file_name
200 05c0e28306d3 expanding ~ in file names catherine@Elli.myhome.westell.com parents: 199 diff changeset	841 fname = os.path.expanduser(fname)
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	842 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuation_prompt'))
41 1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	843 if isinstance(fname, file):
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	844 self.stdin = fname
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	845 else:
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	846 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	847 self.stdin = open(os.path.expanduser(fname), 'r')
41 1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	848 except IOError, e:
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	849 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	850 self.stdin = open('%s.%s' % (os.path.expanduser(fname), self.defaultExtension), 'r')
41 1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	851 except IOError:
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	852 print 'Problem opening file %s: \n%s' % (fname, e)
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	853 keepstate.restore()
1275d59c08a7 do_load accepts file object catherine@cordelia parents: 39 diff changeset	854 return
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	855 self.use_rawinput = False
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	856 self.prompt = self.continuation_prompt = ''
42 b3200c6e5763 inserting exception for quit... catherine@cordelia parents: 41 diff changeset	857 stop = self.cmdloop()
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	858 self.stdin.close()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	859 keepstate.restore()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	860 self.lastcmd = ''
48 34fb41095451 avoiding do_load overload catherine.devlin@gmail.com parents: 47 diff changeset	861 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT
34fb41095451 avoiding do_load overload catherine.devlin@gmail.com parents: 47 diff changeset	862 do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython
43 e03a8c03ac37 command-line args working catherine@cordelia parents: 42 diff changeset	863
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	864 def do_run(self, arg):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	865 """run [arg]: re-runs an earlier command
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	866
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	867 no arg -> run most recent command
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	868 arg is integer -> run one history item, by index
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	869 arg is string -> run most recent command by string search
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	870 arg is /enclosed in forward-slashes/ -> run most recent by regex
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	871 """
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	872 'run [N]: runs the SQL that was run N commands ago'
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	873 runme = self.last_matching(arg)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	874 print runme
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	875 if runme:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	876 runme = self.precmd(runme)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	877 stop = self.onecmd(runme)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	878 stop = self.postcmd(stop, runme)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	879 do_r = do_run
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	880
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	881 def fileimport(self, statement, source):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	882 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	883 f = open(os.path.expanduser(source))
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	884 except IOError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	885 self.stdout.write("Couldn't read from file %s\n" % source)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	886 return ''
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	887 data = f.read()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	888 f.close()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	889 return data
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	890
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	891 class HistoryItem(str):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	892 def __init__(self, instr):
121 fe432d010ecc going to attempt 2.4 and 2.6 compatibility catherine@dellzilla parents: 119 diff changeset	893 str.__init__(self)
0 febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	894 self.lowercase = self.lower()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	895 self.idx = None
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	896 def pr(self):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	897 return '-------------------------[%d]\n%s\n' % (self.idx, str(self))
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	898
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	899 class History(list):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	900 rangeFrom = re.compile(r'^([\d])+\s*\-$')
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	901 def append(self, new):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	902 new = HistoryItem(new)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	903 list.append(self, new)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	904 new.idx = len(self)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	905 def extend(self, new):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	906 for n in new:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	907 self.append(n)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	908 def get(self, getme):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	909 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	910 getme = int(getme)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	911 if getme < 0:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	912 return self[:(-1 * getme)]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	913 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	914 return [self[getme-1]]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	915 except IndexError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	916 return []
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	917 except (ValueError, TypeError):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	918 getme = getme.strip()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	919 mtch = self.rangeFrom.search(getme)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	920 if mtch:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	921 return self[(int(mtch.group(1))-1):]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	922 if getme.startswith(r'/') and getme.endswith(r'/'):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	923 finder = re.compile(getme[1:-1], re.DOTALL \| re.MULTILINE \| re.IGNORECASE)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	924 def isin(hi):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	925 return finder.search(hi)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	926 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	927 def isin(hi):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	928 return (getme.lower() in hi.lowercase)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	929 return [itm for itm in self if isin(itm)]
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	930
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	931 class NotSettableError(Exception):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	932 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	933
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	934 def cast(current, new):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	935 """Tries to force a new value into the same type as the current."""
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	936 typ = type(current)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	937 if typ == bool:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	938 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	939 return bool(int(new))
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	940 except ValueError, TypeError:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	941 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	942 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	943 new = new.lower()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	944 except:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	945 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	946 if (new=='on') or (new[0] in ('y','t')):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	947 return True
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	948 if (new=='off') or (new[0] in ('n','f')):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	949 return False
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	950 else:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	951 try:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	952 return typ(new)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	953 except:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	954 pass
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	955 print "Problem setting parameter (now %s) to %s; incorrect type?" % (current, new)
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	956 return current
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	957
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	958 class Statekeeper(object):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	959 def __init__(self, obj, attribs):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	960 self.obj = obj
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	961 self.attribs = attribs
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	962 self.save()
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	963 def save(self):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	964 for attrib in self.attribs:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	965 setattr(self, attrib, getattr(self.obj, attrib))
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	966 def restore(self):
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	967 for attrib in self.attribs:
febfdc79550b moved repository to Assembla catherine@DellZilla.myhome.westell.com parents: diff changeset	968 setattr(self.obj, attrib, getattr(self, attrib))
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	969
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	970 class Borg(object):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	971 '''All instances of any Borg subclass will share state.
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	972 from Python Cookbook, 2nd Ed., recipe 6.16'''
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	973 _shared_state = {}
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	974 def __new__(cls, a, *k):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	975 obj = object.__new__(cls, a, *k)
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	976 obj.__dict__ = cls._shared_state
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	977 return obj
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	978
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	979 class OutputTrap(Borg):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	980 '''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing.
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	981 Call `tearDown()` to return to normal output.'''
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	982 def __init__(self):
105 130340609e19 testing beginning to work? catherine@dellzilla parents: 104 diff changeset	983 self.old_stdout = sys.stdout
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	984 self.trap = tempfile.TemporaryFile()
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	985 sys.stdout = self.trap
105 130340609e19 testing beginning to work? catherine@dellzilla parents: 104 diff changeset	986 def read(self):
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	987 self.trap.seek(0)
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	988 result = self.trap.read()
105 130340609e19 testing beginning to work? catherine@dellzilla parents: 104 diff changeset	989 self.trap.truncate(0)
130340609e19 testing beginning to work? catherine@dellzilla parents: 104 diff changeset	990 return result.strip('\x00')
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	991 def tearDown(self):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	992 sys.stdout = self.old_stdout
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	993
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	994 class Cmd2TestCase(unittest.TestCase):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	995 '''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class
109 78c4db4c2045 all done but the proper packaging catherine@dellzilla parents: 108 diff changeset	996 that will execute the commands in transcriptFileName and expect the results shown.
78c4db4c2045 all done but the proper packaging catherine@dellzilla parents: 108 diff changeset	997 See example.py'''
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	998 CmdApp = None
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	999 transcriptFileName = ''
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1000 def setUp(self):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1001 if self.CmdApp:
105 130340609e19 testing beginning to work? catherine@dellzilla parents: 104 diff changeset	1002 self.outputTrap = OutputTrap()
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1003 self.cmdapp = self.CmdApp()
173 10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	1004 try:
202 da8c265934ee liberal use of os.path.expanduser catherine@dellzilla parents: 201 diff changeset	1005 tfile = open(os.path.expanduser(self.transcriptFileName))
180 951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1006 self.transcript = iter(tfile.readlines())
173 10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	1007 tfile.close()
10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	1008 except IOError:
10a45c030364 simplifying testcase catherine@dellzilla parents: 172 diff changeset	1009 self.transcript = []
181 24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1010 def assertEqualEnough(self, got, expected, message):
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1011 got = got.strip().splitlines()
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1012 expected = expected.strip().splitlines()
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1013 self.assertEqual(len(got), len(expected), message)
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1014 for (linegot, lineexpected) in zip(got, expected):
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1015 matchme = re.escape(lineexpected.strip()).replace('\\', '.'). \
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1016 replace('\\ ', ' ')
24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1017 self.assert_(re.match(matchme, linegot.strip()), message)
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1018 def testall(self):
180 951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1019 if self.CmdApp:
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1020 lineNum = 0
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1021 try:
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1022 line = self.transcript.next()
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1023 while True:
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1024 while not line.startswith(self.cmdapp.prompt):
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1025 line = self.transcript.next()
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1026 command = [line[len(self.cmdapp.prompt):]]
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1027 line = self.transcript.next()
207 a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	1028 while line.startswith(self.cmdapp.continuation_prompt):
a3bec7704e65 tweaking catherine@dellzilla parents: 206 diff changeset	1029 command.append(line[len(self.cmdapp.continuation_prompt):])
180 951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1030 line = self.transcript.next()
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1031 command = ''.join(command)
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1032 self.cmdapp.onecmd(command)
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1033 result = self.outputTrap.read()
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1034 if line.startswith(self.cmdapp.prompt):
181 24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1035 self.assertEqualEnough(result.strip(), '',
180 951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1036 '\nFile %s, line %d\nCommand was:\n%s\nExpected: (nothing) \nGot:\n%s\n' %
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1037 (self.transcriptFileName, lineNum, command, result))
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1038 continue
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1039 expected = []
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1040 while not line.startswith(self.cmdapp.prompt):
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1041 expected.append(line)
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1042 line = self.transcript.next()
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1043 expected = ''.join(expected)
181 24eff658997b accepts wildcards in tests, maybe? catherine@Elli.myhome.westell.com parents: 180 diff changeset	1044 self.assertEqualEnough(expected.strip(), result.strip(),
180 951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1045 '\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' %
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1046 (self.transcriptFileName, lineNum, command, expected, result))
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1047 # this needs to account for a line-by-line strip()ping
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1048 except StopIteration:
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1049 pass
951c124b0404 test almost fixed catherine@Elli.myhome.westell.com parents: 179 diff changeset	1050 # catch the final output?
104 bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1051 def tearDown(self):
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1052 if self.CmdApp:
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1053 self.outputTrap.tearDown()
bd91925d813c having a hard time capturing stdout catherine@dellzilla parents: 103 diff changeset	1054
79 f583663c610f switch to pyparsing worked catherine@Elli.myhome.westell.com parents: 56 diff changeset	1055 if __name__ == '__main__':
158 87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	1056 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE)
87d3f3203b96 accept blanks catherine@Elli.myhome.westell.com parents: 157 diff changeset	1057 #c = Cmd()

Mercurial > python-cmd2

annotate cmd2.py @ 216:dcc5f871a5b6