python-cmd2: cmd2.py annotate

annotate cmd2.py @ 193:e96877b59371

tweaked docs

author	catherine@Elli.myhome.westell.com
date	Tue, 17 Feb 2009 22:45:10 -0500
parents	c0d4c7ba14a9
children	5bf878c5c0e8

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

Mercurial > python-cmd2

annotate cmd2.py @ 193:e96877b59371