annotate cmd2.py @ 287:1cd23003e8d5

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