Mercurial > python-cmd2

annotate cmd2.py @ 158:87d3f3203b96

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