annotate cmd2.py @ 346:49dd1ce6cfd6

quitting after invocation commands
author catherine@Drou
date Tue, 16 Feb 2010 15:47:17 -0500
parents 6fe1e75e3a67
children 432ccab7c6c8
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)
310
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
16 Bash-style ``select`` available
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
17
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
18 Note that redirection with > and | will only work if `self.stdout.write()`
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
19 is used in place of `print`. The standard library's `cmd` module is
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
20 written to use `self.stdout.write()`,
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
21
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
22 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
23
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
24 mercurial repository at http://www.assembla.com/wiki/show/python-cmd2
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
25 """
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
26 import cmd
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
27 import re
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
28 import os
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
29 import sys
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
30 import optparse
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
31 import subprocess
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
32 import tempfile
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
33 import doctest
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
34 import unittest
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
35 import datetime
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
36 import urllib
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
37 import glob
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
38 import traceback
312
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
39 import platform
323
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
40 import copy
339
6c397f0865c7 MyInteractiveInterpreter removed
catherine@Drou
parents: 336
diff changeset
41 from code import InteractiveConsole, InteractiveInterpreter
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
42 from optparse import make_option
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
43
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
44 if sys.version_info[0] > 2:
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
45 import pyparsing_py3 as pyparsing
343
787573d350c5 py3 conversion complete?
catherine@Drou
parents: 341
diff changeset
46 raw_input = input
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
47 else:
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
48 import pyparsing
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
49
312
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
50 __version__ = '0.6.0'
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
51
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
52 class OptionParser(optparse.OptionParser):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
53 def exit(self, status=0, msg=None):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
54 self.values._exit = True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
55 if msg:
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
56 print (msg)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
57
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
58 def print_help(self, *args, **kwargs):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
59 try:
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
60 print (self._func.__doc__)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
61 except AttributeError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
62 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
63 optparse.OptionParser.print_help(self, *args, **kwargs)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
64
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
65 def error(self, msg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
66 """error(msg : string)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
67
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
68 Print a usage message incorporating 'msg' to stderr and exit.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
69 If you override this in a subclass, it should not return -- it
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
70 should either exit or raise an exception.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
71 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
72 raise
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
73
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
74 def remaining_args(oldArgs, newArgList):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
75 '''
285
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
76 Preserves the spacing originally in the argument after
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
77 the removal of options.
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
78
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
79 >>> remaining_args('-f bar bar cow', ['bar', 'cow'])
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
80 'bar cow'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
81 '''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
82 pattern = '\s+'.join(re.escape(a) for a in newArgList) + '\s*$'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
83 matchObj = re.search(pattern, oldArgs)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
84 return oldArgs[matchObj.start():]
280
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
85
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
86 def _attr_get_(obj, attr):
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
87 '''Returns an attribute's value, or None (no error) if undefined.
286
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
88 Analagous to .get() for dictionaries. Useful when checking for
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
89 value of options that may not have been defined on a given
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
90 method.'''
280
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
91 try:
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
92 return getattr(obj, attr)
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
93 except AttributeError:
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
94 return None
283
bff1f19275e7 unknown
catherine@DellZilla
parents: 282
diff changeset
95
bff1f19275e7 unknown
catherine@DellZilla
parents: 282
diff changeset
96 optparse.Values.get = _attr_get_
bff1f19275e7 unknown
catherine@DellZilla
parents: 282
diff changeset
97
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
98 options_defined = [] # used to distinguish --options from SQL-style --comments
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
99
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
100 def options(option_list):
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
101 '''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
102 alters a cmd2 methodo populate its ``opts`` argument from its
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
103 raw text argument.
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
104
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
105 Example: transform
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
106 def do_something(self, arg):
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
107
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
108 into
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
109 @options([make_option('-q', '--quick', action="store_true",
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
110 help="Makes things fast")])
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
111 def do_something(self, arg, opts):
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
112 if opts.quick:
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
113 self.fast_button = True
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
114 '''
296
ae476b714190 tolerate single option in non-list form
catherine@bothari
parents: 295
diff changeset
115 if not isinstance(option_list, list):
298
a94e3b39d787 connect2 changes in progress
catherine@bothari
parents: 297
diff changeset
116 option_list = [option_list]
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
117 for opt in option_list:
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
118 options_defined.append(pyparsing.Literal(opt.get_opt_string()))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
119 def option_setup(func):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
120 optionParser = OptionParser()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
121 for opt in option_list:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
122 optionParser.add_option(opt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
123 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
124 optionParser._func = func
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
125 def new_func(instance, arg):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
126 try:
302
b4b22dd087dc refactored, unit tests pass
catherine@dellzilla
parents: 301
diff changeset
127 opts, newArgList = optionParser.parse_args(arg.split())
285
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
128 # Must find the remaining args in the original argument list, but
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
129 # mustn't include the command itself
302
b4b22dd087dc refactored, unit tests pass
catherine@dellzilla
parents: 301
diff changeset
130 #if hasattr(arg, 'parsed') and newArgList[0] == arg.parsed.command:
b4b22dd087dc refactored, unit tests pass
catherine@dellzilla
parents: 301
diff changeset
131 # newArgList = newArgList[1:]
b4b22dd087dc refactored, unit tests pass
catherine@dellzilla
parents: 301
diff changeset
132 newArgs = remaining_args(arg, newArgList)
301
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
133 if isinstance(arg, ParsedString):
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
134 arg = arg.with_args_replaced(newArgs)
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
135 else:
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
136 arg = newArgs
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
137 except (optparse.OptionValueError, optparse.BadOptionError,
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
138 optparse.OptionError, optparse.AmbiguousOptionError,
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
139 optparse.OptionConflictError), e:
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
140 print (e)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
141 optionParser.print_help()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
142 return
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
143 if hasattr(opts, '_exit'):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
144 return None
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
145 result = func(instance, arg, opts)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
146 return result
289
327ace491fa9 oops, had to fix a reference to newFunc
catherine@bothari
parents: 288
diff changeset
147 new_func.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
148 return new_func
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
149 return option_setup
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
150
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
151 class PasteBufferError(EnvironmentError):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
152 if sys.platform[:3] == 'win':
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
153 errmsg = """Redirecting to or from paste buffer requires pywin32
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
154 to be installed on operating system.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
155 Download from http://sourceforge.net/projects/pywin32/"""
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
156 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
157 errmsg = """Redirecting to or from paste buffer requires xclip
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
158 to be installed on operating system.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
159 On Debian/Ubuntu, 'sudo apt-get install xclip' will install it."""
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
160 def __init__(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
161 Exception.__init__(self, self.errmsg)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
162
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
163 pastebufferr = """Redirecting to or from paste buffer requires %s
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
164 to be installed on operating system.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
165 %s"""
286
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
166
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
167 if subprocess.mswindows:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
168 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
169 import win32clipboard
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
170 def get_paste_buffer():
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
171 win32clipboard.OpenClipboard(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
172 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
173 result = win32clipboard.GetClipboardData()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
174 except TypeError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
175 result = '' #non-text
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
176 win32clipboard.CloseClipboard()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
177 return result
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
178 def write_to_paste_buffer(txt):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
179 win32clipboard.OpenClipboard(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
180 win32clipboard.EmptyClipboard()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
181 win32clipboard.SetClipboardText(txt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
182 win32clipboard.CloseClipboard()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
183 except ImportError:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
184 def get_paste_buffer(*args):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
185 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
186 setPasteBuffer = get_paste_buffer
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
187 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
188 can_clip = False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
189 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
190 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
191 can_clip = True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
192 except AttributeError: # check_call not defined, Python < 2.5
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
193 teststring = 'Testing for presence of xclip.'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
194 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
195 xclipproc.stdin.write(teststring)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
196 xclipproc.stdin.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
197 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
198 if xclipproc.stdout.read() == teststring:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
199 can_clip = True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
200 except (subprocess.CalledProcessError, OSError, IOError):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
201 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
202 if can_clip:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
203 def get_paste_buffer():
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
204 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
205 return xclipproc.stdout.read()
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
206 def write_to_paste_buffer(txt):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
207 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
208 xclipproc.stdin.write(txt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
209 xclipproc.stdin.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
210 # but we want it in both the "primary" and "mouse" clipboards
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
211 xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
212 xclipproc.stdin.write(txt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
213 xclipproc.stdin.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
214 else:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
215 def get_paste_buffer(*args):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
216 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
217 setPasteBuffer = get_paste_buffer
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
218 writeToPasteBuffer = get_paste_buffer
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
219
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
220 pyparsing.ParserElement.setDefaultWhitespaceChars(' \t')
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 ParsedString(str):
300
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
223 def full_parsed_statement(self):
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
224 new = ParsedString('%s %s' % (self.parsed.command, self.parsed.args))
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
225 new.parsed = self.parsed
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
226 new.parser = self.parser
301
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
227 return new
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
228 def with_args_replaced(self, newargs):
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
229 new = ParsedString(newargs)
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
230 new.parsed = self.parsed
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
231 new.parser = self.parser
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
232 new.parsed['args'] = newargs
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
233 new.parsed.statement['args'] = newargs
30af90fd46c5 refactor mostly done?
catherine@dellzilla
parents: 300
diff changeset
234 return new
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
235
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
236 class SkipToLast(pyparsing.SkipTo):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
237 def parseImpl( self, instring, loc, doActions=True ):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
238 resultStore = []
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
239 startLoc = loc
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
240 instrlen = len(instring)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
241 expr = self.expr
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
242 failParse = False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
243 while loc <= instrlen:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
244 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
245 if self.failOn:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
246 failParse = True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
247 self.failOn.tryParse(instring, loc)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
248 failParse = False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
249 loc = expr._skipIgnorables( instring, loc )
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
250 expr._parse( instring, loc, doActions=False, callPreParse=False )
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
251 skipText = instring[startLoc:loc]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
252 if self.includeMatch:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
253 loc,mat = expr._parse(instring,loc,doActions,callPreParse=False)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
254 if mat:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
255 skipRes = ParseResults( skipText )
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
256 skipRes += mat
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
257 resultStore.append((loc, [ skipRes ]))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
258 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
259 resultStore,append((loc, [ skipText ]))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
260 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
261 resultStore.append((loc, [ skipText ]))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
262 loc += 1
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
263 except (pyparsing.ParseException,IndexError):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
264 if failParse:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
265 raise
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
266 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
267 loc += 1
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
268 if resultStore:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
269 return resultStore[-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
270 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
271 exc = self.myException
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
272 exc.loc = loc
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
273 exc.pstr = instring
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
274 raise exc
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
275
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
276 class StubbornDict(dict):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
277 '''Dictionary that tolerates many input formats.
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
278 Create it with stubbornDict(arg) factory function.
319
c58cd7e48db7 begin to switch settable to TextLineList
catherine@dellzilla
parents: 317
diff changeset
279
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
280 >>> d = StubbornDict(large='gross', small='klein')
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
281 >>> sorted(d.items())
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
282 [('large', 'gross'), ('small', 'klein')]
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
283 >>> d.append(['plain', ' plaid'])
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
284 >>> sorted(d.items())
333
45e70737791f unit tests fixed
cat@eee
parents: 332
diff changeset
285 [('large', 'gross'), ('plaid', ''), ('plain', ''), ('small', 'klein')]
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
286 >>> d += ' girl Frauelein, Maedchen\\n\\n shoe schuh'
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
287 >>> sorted(d.items())
333
45e70737791f unit tests fixed
cat@eee
parents: 332
diff changeset
288 [('girl', 'Frauelein, Maedchen'), ('large', 'gross'), ('plaid', ''), ('plain', ''), ('shoe', 'schuh'), ('small', 'klein')]
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
289 '''
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
290 def update(self, arg):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
291 dict.update(self, StubbornDict.to_dict(arg))
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
292 append = update
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
293 def __iadd__(self, arg):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
294 self.update(arg)
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
295 return self
323
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
296 def __add__(self, arg):
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
297 selfcopy = copy.copy(self)
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
298 selfcopy.update(stubbornDict(arg))
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
299 return selfcopy
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
300 def __radd__(self, arg):
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
301 selfcopy = copy.copy(self)
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
302 selfcopy.update(stubbornDict(arg))
fc1e5a141920 tweak to settable
catherine@dellzilla
parents: 322
diff changeset
303 return selfcopy
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
304
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
305 @classmethod
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
306 def to_dict(cls, arg):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
307 'Generates dictionary from string or list of strings'
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
308 if hasattr(arg, 'splitlines'):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
309 arg = arg.splitlines()
340
43569db3ebdb detect lists with __reversed__ not __getslice__
catherine@Drou
parents: 339
diff changeset
310 if hasattr(arg, '__reversed__'):
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
311 result = {}
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
312 for a in arg:
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
313 a = a.strip()
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
314 if a:
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
315 key_val = a.split(None, 1)
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
316 key = key_val[0]
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
317 if len(key_val) > 1:
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
318 val = key_val[1]
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
319 else:
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
320 val = ''
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
321 result[key] = val
319
c58cd7e48db7 begin to switch settable to TextLineList
catherine@dellzilla
parents: 317
diff changeset
322 else:
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
323 result = arg
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
324 return result
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
325
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
326 def stubbornDict(*arg, **kwarg):
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
327 '''
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
328 >>> sorted(stubbornDict('cow a bovine\\nhorse an equine').items())
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
329 [('cow', 'a bovine'), ('horse', 'an equine')]
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
330 >>> sorted(stubbornDict(['badger', 'porcupine a poky creature']).items())
333
45e70737791f unit tests fixed
cat@eee
parents: 332
diff changeset
331 [('badger', ''), ('porcupine', 'a poky creature')]
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
332 >>> sorted(stubbornDict(turtle='has shell', frog='jumpy').items())
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
333 [('frog', 'jumpy'), ('turtle', 'has shell')]
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
334 '''
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
335 result = {}
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
336 for a in arg:
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
337 result.update(StubbornDict.to_dict(a))
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
338 result.update(kwarg)
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
339 return StubbornDict(result)
319
c58cd7e48db7 begin to switch settable to TextLineList
catherine@dellzilla
parents: 317
diff changeset
340
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
341 def replace_with_file_contents(fname):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
342 if fname:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
343 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
344 result = open(os.path.expanduser(fname[0])).read()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
345 except IOError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
346 result = '< %s' % fname[0] # wasn't a file after all
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
347 else:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
348 result = get_paste_buffer()
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
349 return result
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
350
234
ff99b39259d5 maybe quit and exit work now?
catherine@dellzilla
parents: 233
diff changeset
351 class EmbeddedConsoleExit(Exception):
ff99b39259d5 maybe quit and exit work now?
catherine@dellzilla
parents: 233
diff changeset
352 pass
ff99b39259d5 maybe quit and exit work now?
catherine@dellzilla
parents: 233
diff changeset
353
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
354 def ljust(x, width, fillchar=' '):
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
355 'analogous to str.ljust, but works for lists'
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
356 if hasattr(x, 'ljust'):
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
357 return x.ljust(width, fillchar)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
358 else:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
359 if len(x) < width:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
360 x = (x + [fillchar] * width)[:width]
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
361 return x
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
362
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
363 class Cmd(cmd.Cmd):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
364 echo = False
286
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
365 case_insensitive = True # Commands recognized regardless of case
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
366 continuation_prompt = '> '
286
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
367 timing = False # Prints elapsed time for each command
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
368 # make sure your terminators are not in legalChars!
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
369 legalChars = '!#$%.:?@_' + pyparsing.alphanums + pyparsing.alphas8bit
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
370 shortcuts = {'?': 'help', '!': 'shell', '@': 'load', '@@': '_relative_load'}
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
371 excludeFromHistory = '''run r list l history hi ed edit li eof'''.split()
331
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
372 default_to_shell = False
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
373 noSpecialParse = 'set ed edit exit'.split()
286
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
374 defaultExtension = 'txt' # For ``save``, ``load``, etc.
3c4ba65cb303 sprucing up comments
catherine@bothari
parents: 285
diff changeset
375 default_file_name = 'command.txt' # For ``save``, ``load``, etc.
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
376 abbrev = True # Abbreviated commands recognized
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
377 current_script_dir = None
245
2cda5a817e5a send to ioug
catherine@Elli.myhome.westell.com
parents: 244
diff changeset
378 reserved_words = []
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
379 feedback_to_output = False # Do include nonessentials in >, | output
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
380 quiet = False # Do not suppress nonessential output
324
21584174d865 make SHOW TABLES work
catherine@dellzilla
parents: 323
diff changeset
381 debug = False
339
6c397f0865c7 MyInteractiveInterpreter removed
catherine@Drou
parents: 336
diff changeset
382 locals_in_py = True
320
b9f19255d4b7 transcript test stuck in infinite loop?
catherine@dellzilla
parents: 319
diff changeset
383 settable = stubbornDict('''
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
384 prompt
312
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
385 colors Colorized output (*nix only)
331
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
386 continuation_prompt On 2nd+ line of input
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
387 debug Show full error stack on error
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
388 default_file_name for ``save``, ``load``, etc.
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
389 editor Program used by ``edit``
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
390 case_insensitive upper- and lower-case both OK
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
391 feedback_to_output include nonessentials in `|`, `>` results
331
6306edc46a6e more docs
cat@eee
parents: 330
diff changeset
392 quiet Don't print nonessential feedback
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
393 echo Echo command issued into output
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
394 timing Report execution times
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
395 abbrev Accept abbreviated commands
319
c58cd7e48db7 begin to switch settable to TextLineList
catherine@dellzilla
parents: 317
diff changeset
396 ''')
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
397
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
398 def poutput(self, msg):
284
e02b85e6aee1 do not poutput empty messages
catherine@DellZilla
parents: 283
diff changeset
399 if msg:
e02b85e6aee1 do not poutput empty messages
catherine@DellZilla
parents: 283
diff changeset
400 self.stdout.write(msg)
e02b85e6aee1 do not poutput empty messages
catherine@DellZilla
parents: 283
diff changeset
401 if msg[-1] != '\n':
e02b85e6aee1 do not poutput empty messages
catherine@DellZilla
parents: 283
diff changeset
402 self.stdout.write('\n')
276
9bcfa4f81825 changes for error reporting complete
catherine@cordelia
parents: 275
diff changeset
403 def perror(self, errmsg, statement=None):
282
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
404 if self.debug:
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
405 traceback.print_exc()
341
9e593c480782 cleanup print to py3 syntax'
catherine@Drou
parents: 340
diff changeset
406 print (str(errmsg))
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
407 def pfeedback(self, msg):
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
408 """For printing nonessential feedback. Can be silenced with `quiet`.
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
409 Inclusion in redirected output is controlled by `feedback_to_output`."""
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
410 if not self.quiet:
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
411 if self.feedback_to_output:
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
412 self.poutput(msg)
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
413 else:
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
414 print (msg)
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
415 _STOP_AND_EXIT = 2 # distinguish end of script file from actual exit
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
416 editor = os.environ.get('EDITOR')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
417 if not editor:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
418 if sys.platform[:3] == 'win':
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
419 editor = 'notepad'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
420 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
421 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
422 if not os.system('which %s' % (editor)):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
423 break
312
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
424
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
425 colorcodes = {'bold':{True:'\x1b[1m',False:'\x1b[22m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
426 'cyan':{True:'\x1b[36m',False:'\x1b[39m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
427 'blue':{True:'\x1b[34m',False:'\x1b[39m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
428 'red':{True:'\x1b[31m',False:'\x1b[39m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
429 'magenta':{True:'\x1b[35m',False:'\x1b[39m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
430 'green':{True:'\x1b[32m',False:'\x1b[39m'},
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
431 'underline':{True:'\x1b[4m',False:'\x1b[24m'}}
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
432 colors = (platform.system() != 'Windows')
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
433 def colorize(self, val, color):
336
8aa71e8f1064 alternatives
catherine@Drou
parents: 335
diff changeset
434 '''Given a string (``val``), returns that string wrapped in UNIX-style
8aa71e8f1064 alternatives
catherine@Drou
parents: 335
diff changeset
435 special characters that turn on (and then off) text color and style.
8aa71e8f1064 alternatives
catherine@Drou
parents: 335
diff changeset
436 If the ``colors`` environment paramter is ``False``, or the application
8aa71e8f1064 alternatives
catherine@Drou
parents: 335
diff changeset
437 is running on Windows, will return ``val`` unchanged.
8aa71e8f1064 alternatives
catherine@Drou
parents: 335
diff changeset
438 Available colors/styles: red/blue/green/cyan/magenta, bold, underline'''
312
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
439 if self.colors and (self.stdout == self.initial_stdout):
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
440 return self.colorcodes[color][True] + val + self.colorcodes[color][False]
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
441 return val
466eaec2c076 colorize taken from sqlpython
catherine@Drou
parents: 311
diff changeset
442
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
443 def do_cmdenvironment(self, args):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
444 '''Summary report of interactive parameters.'''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
445 self.stdout.write("""
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
446 Commands are %(casesensitive)scase-sensitive.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
447 Commands may be terminated with: %(terminators)s
237
e91808980e59 fixed bug in abbreviated commands
catherine@dellzilla
parents: 236
diff changeset
448 Settable parameters: %(settable)s\n""" % \
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
449 { 'casesensitive': (self.case_insensitive and 'not ') or '',
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
450 'terminators': str(self.terminators),
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
451 'settable': ' '.join(self.settable)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
452 })
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
453
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
454 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
455 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
456 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
457 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
458 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
459 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
460 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
461 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
462 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
463 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
464 cmd.Cmd.do_help(self, arg)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
465
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
466 def __init__(self, *args, **kwargs):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
467 cmd.Cmd.__init__(self, *args, **kwargs)
271
Catherine Devlin <catherine.devlin@gmail.com>
parents: 270
diff changeset
468 self.initial_stdout = sys.stdout
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
469 self.history = History()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
470 self._init_parser()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
471 self.pystate = {}
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
472 self.shortcuts = sorted(self.shortcuts.items(), reverse=True)
247
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
473 self.keywords = self.reserved_words + [fname[3:] for fname in dir(self)
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
474 if fname.startswith('do_')]
317
de23e595bb5c experiments with line flattening
cat@eee
parents: 314
diff changeset
475 def linelist(arg):
de23e595bb5c experiments with line flattening
cat@eee
parents: 314
diff changeset
476 result = []
de23e595bb5c experiments with line flattening
cat@eee
parents: 314
diff changeset
477
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
478 self.doubleDashComment = pyparsing.NotAny(pyparsing.Or(options_defined)) + pyparsing.Literal('--') + pyparsing.restOfLine
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
479
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
480 def do_shortcuts(self, args):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
481 """Lists single-key shortcuts available."""
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
482 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
483 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
484
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
485 prefixParser = pyparsing.Empty()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
486 commentGrammars = pyparsing.Or([pyparsing.pythonStyleComment, pyparsing.cStyleComment])
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
487 commentGrammars.addParseAction(lambda x: '')
288
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
488 commentInProgress = pyparsing.Literal('/*') + pyparsing.SkipTo(
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
489 pyparsing.stringEnd ^ '*/')
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
490 terminators = [';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
491 blankLinesAllowed = False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
492 multilineCommands = []
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
493
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
494 def _init_parser(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
495 r'''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
496 >>> c = Cmd()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
497 >>> c.multilineCommands = ['multiline']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
498 >>> c.case_insensitive = True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
499 >>> c._init_parser()
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
500 >>> print (c.parser.parseString('').dump())
313
e9f9dc712651 must puzzle out parsing of quoted strings
catherine@Drou
parents: 312
diff changeset
501 []
e9f9dc712651 must puzzle out parsing of quoted strings
catherine@Drou
parents: 312
diff changeset
502 >>> print (c.parser.parseString('').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
503 []
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
504 >>> print (c.parser.parseString('/* empty command */').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
505 []
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
506 >>> print (c.parser.parseString('plainword').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
507 ['plainword', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
508 - command: plainword
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
509 - statement: ['plainword', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
510 - command: plainword
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
511 >>> print (c.parser.parseString('termbare;').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
512 ['termbare', '', ';', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
513 - command: termbare
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
514 - statement: ['termbare', '', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
515 - command: termbare
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
516 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
517 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
518 >>> print (c.parser.parseString('termbare; suffx').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
519 ['termbare', '', ';', 'suffx']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
520 - command: termbare
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
521 - statement: ['termbare', '', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
522 - command: termbare
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
523 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
524 - suffix: suffx
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
525 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
526 >>> print (c.parser.parseString('barecommand').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
527 ['barecommand', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
528 - command: barecommand
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
529 - statement: ['barecommand', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
530 - command: barecommand
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
531 >>> print (c.parser.parseString('COMmand with args').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
532 ['command', 'with args']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
533 - args: with args
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
534 - command: command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
535 - statement: ['command', 'with args']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
536 - args: with args
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
537 - command: command
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
538 >>> print (c.parser.parseString('command with args and terminator; and suffix').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
539 ['command', 'with args and terminator', ';', 'and suffix']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
540 - args: with args and terminator
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
541 - command: command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
542 - statement: ['command', 'with args and terminator', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
543 - args: with args and terminator
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
544 - command: command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
545 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
546 - suffix: and suffix
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
547 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
548 >>> print (c.parser.parseString('simple | piped').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
549 ['simple', '', '|', ' piped']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
550 - command: simple
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
551 - pipeTo: piped
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
552 - statement: ['simple', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
553 - command: simple
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
554 >>> print (c.parser.parseString('double-pipe || is not a pipe').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
555 ['double', '-pipe || is not a pipe']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
556 - args: -pipe || is not a pipe
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
557 - command: double
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
558 - statement: ['double', '-pipe || is not a pipe']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
559 - args: -pipe || is not a pipe
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
560 - command: double
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
561 >>> print (c.parser.parseString('command with args, terminator;sufx | piped').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
562 ['command', 'with args, terminator', ';', 'sufx', '|', ' piped']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
563 - args: with args, terminator
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
564 - command: command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
565 - pipeTo: piped
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
566 - statement: ['command', 'with args, terminator', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
567 - args: with args, terminator
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
568 - command: command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
569 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
570 - suffix: sufx
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
571 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
572 >>> print (c.parser.parseString('output into > afile.txt').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
573 ['output', 'into', '>', 'afile.txt']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
574 - args: into
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
575 - command: output
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
576 - output: >
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
577 - outputTo: afile.txt
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
578 - statement: ['output', 'into']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
579 - args: into
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
580 - command: output
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
581 >>> print (c.parser.parseString('output into;sufx | pipethrume plz > afile.txt').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
582 ['output', 'into', ';', 'sufx', '|', ' pipethrume plz', '>', 'afile.txt']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
583 - args: into
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
584 - command: output
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
585 - output: >
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
586 - outputTo: afile.txt
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
587 - pipeTo: pipethrume plz
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
588 - statement: ['output', 'into', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
589 - args: into
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
590 - command: output
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
591 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
592 - suffix: sufx
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
593 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
594 >>> print (c.parser.parseString('output to paste buffer >> ').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
595 ['output', 'to paste buffer', '>>', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
596 - args: to paste buffer
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
597 - command: output
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
598 - output: >>
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
599 - statement: ['output', 'to paste buffer']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
600 - args: to paste buffer
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
601 - command: output
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
602 >>> print (c.parser.parseString('ignore the /* commented | > */ stuff;').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
603 ['ignore', 'the /* commented | > */ stuff', ';', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
604 - args: the /* commented | > */ stuff
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
605 - command: ignore
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
606 - statement: ['ignore', 'the /* commented | > */ stuff', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
607 - args: the /* commented | > */ stuff
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
608 - command: ignore
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
609 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
610 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
611 >>> print (c.parser.parseString('has > inside;').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
612 ['has', '> inside', ';', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
613 - args: > inside
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
614 - command: has
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
615 - statement: ['has', '> inside', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
616 - args: > inside
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
617 - command: has
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
618 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
619 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
620 >>> print (c.parser.parseString('multiline has > inside an unfinished command').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
621 ['multiline', ' has > inside an unfinished command']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
622 - multilineCommand: multiline
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
623 >>> print (c.parser.parseString('multiline has > inside;').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
624 ['multiline', 'has > inside', ';', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
625 - args: has > inside
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
626 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
627 - statement: ['multiline', 'has > inside', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
628 - args: has > inside
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
629 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
630 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
631 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
632 >>> print (c.parser.parseString('multiline command /* with comment in progress;').dump())
272
d68d83f42254 fixed unit test
catherine@cordelia
parents: 270
diff changeset
633 ['multiline', ' command']
d68d83f42254 fixed unit test
catherine@cordelia
parents: 270
diff changeset
634 - multilineCommand: multiline
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
635 >>> print (c.parser.parseString('multiline command /* with comment complete */ is done;').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
636 ['multiline', 'command /* with comment complete */ is done', ';', '']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
637 - args: command /* with comment complete */ is done
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
638 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
639 - statement: ['multiline', 'command /* with comment complete */ is done', ';']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
640 - args: command /* with comment complete */ is done
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
641 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
642 - terminator: ;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
643 - terminator: ;
311
54e2dd53ba38 excluded --options from --comments with .NotAny
catherine@bothari
parents: 310
diff changeset
644 >>> print (c.parser.parseString('multiline command ends\n\n').dump())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
645 ['multiline', 'command ends', '\n', '\n']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
646 - args: command ends
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
647 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
648 - statement: ['multiline', 'command ends', '\n', '\n']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
649 - args: command ends
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
650 - multilineCommand: multiline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
651 - terminator: ['\n', '\n']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
652 - terminator: ['\n', '\n']
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
653 '''
288
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
654 tstr = 'multiline command /* with comment complete */ is done;'
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
655 outputParser = (pyparsing.Literal('>>') | (pyparsing.WordStart() + '>') | pyparsing.Regex('[^=]>'))('output')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
656
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
657 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
658 stringEnd = pyparsing.stringEnd ^ '\nEOF'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
659 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
660 oneLineCommand = (~self.multilineCommand + pyparsing.Word(self.legalChars))('command')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
661 pipe = pyparsing.Keyword('|', identChars='|')
285
58be960b8bf9 --flags with sqlpython
catherine@DellZilla
parents: 284
diff changeset
662 self.commentGrammars.ignore(pyparsing.quotedString).setParseAction(lambda x: '')
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
663 afterElements = \
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
664 pyparsing.Optional(pipe + pyparsing.SkipTo(outputParser ^ stringEnd)('pipeTo')) + \
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
665 pyparsing.Optional(outputParser + pyparsing.SkipTo(stringEnd).setParseAction(lambda x: x[0].strip())('outputTo'))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
666 if self.case_insensitive:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
667 self.multilineCommand.setParseAction(lambda x: x[0].lower())
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
668 oneLineCommand.setParseAction(lambda x: x[0].lower())
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
669 if self.blankLinesAllowed:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
670 self.blankLineTerminationParser = pyparsing.NoMatch
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
671 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
672 self.blankLineTerminator = (pyparsing.lineEnd + pyparsing.lineEnd)('terminator')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
673 self.blankLineTerminator.setResultsName('terminator')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
674 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
675 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
676 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
677 self.multilineParser.ignore(self.commentInProgress)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
678 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
679 pyparsing.Optional(terminatorParser) + afterElements)
288
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
680 #self.multilineParser = self.multilineParser.setResultsName('multilineParser')
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
681 #self.singleLineParser = self.singleLineParser.setResultsName('singleLineParser')
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
682 self.blankLineTerminationParser = self.blankLineTerminationParser.setResultsName('statement')
266
584f970ca66a permit bare prefix
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
683 self.parser = self.prefixParser + (
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
684 stringEnd |
266
584f970ca66a permit bare prefix
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
685 self.multilineParser |
584f970ca66a permit bare prefix
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
686 self.singleLineParser |
584f970ca66a permit bare prefix
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
687 self.blankLineTerminationParser |
584f970ca66a permit bare prefix
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
688 self.multilineCommand + pyparsing.SkipTo(stringEnd)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
689 )
249
55a12d77a4fa finally, ls working right
catherine@Elli.myhome.westell.com
parents: 248
diff changeset
690 self.parser.ignore(pyparsing.quotedString).ignore(self.commentGrammars)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
691
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
692 inputMark = pyparsing.Literal('<')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
693 inputMark.setParseAction(lambda x: '')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
694 fileName = pyparsing.Word(self.legalChars + '/\\')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
695 inputFrom = fileName('inputFrom')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
696 inputFrom.setParseAction(replace_with_file_contents)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
697 # a not-entirely-satisfactory way of distinguishing < as in "import from" from <
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
698 # as in "lesser than"
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
699 self.inputParser = inputMark + pyparsing.Optional(inputFrom) + pyparsing.Optional('>') + \
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
700 pyparsing.Optional(fileName) + (pyparsing.stringEnd | '|')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
701 self.inputParser.ignore(pyparsing.quotedString).ignore(self.commentGrammars).ignore(self.commentInProgress)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
702
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
703 def preparse(self, raw, **kwargs):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
704 return raw
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
705
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
706 def parsed(self, raw, **kwargs):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
707 if isinstance(raw, ParsedString):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
708 p = raw
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
709 else:
292
23cf05c6276c time to work on parsing refactor
catherine@bothari
parents: 291
diff changeset
710 # preparse is an overridable hook; default makes no changes
300
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
711 s = self.preparse(raw, **kwargs)
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
712 s = self.inputParser.transformString(s.lstrip())
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
713 s = self.commentGrammars.transformString(s)
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
714 for (shortcut, expansion) in self.shortcuts:
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
715 if s.lower().startswith(shortcut):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
716 s = s.replace(shortcut, expansion + ' ', 1)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
717 break
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
718 result = self.parser.parseString(s)
300
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
719 result['raw'] = raw
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
720 result['command'] = result.multilineCommand or result.command
300
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
721 p = ParsedString(result.args)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
722 p.parsed = result
295
f5593299fc2a debugged snarl in saving .parser
catherine@bothari
parents: 294
diff changeset
723 p.parser = self.parsed
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
724 for (key, val) in kwargs.items():
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
725 p.parsed[key] = val
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
726 return p
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
727
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
728 def postparsing_precmd(self, statement):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
729 stop = 0
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
730 return stop, statement
247
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
731
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
732 def postparsing_postcmd(self, stop):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
733 return stop
247
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
734 def func_named(self, arg):
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
735 result = None
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
736 target = 'do_' + arg
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
737 if target in dir(self):
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
738 result = target
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
739 else:
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
740 if self.abbrev: # accept shortened versions of commands
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
741 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
742 if len(funcs) == 1:
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
743 result = 'do_' + funcs[0]
3db4166a54ce abbrevs working with help
catherine@Elli.myhome.westell.com
parents: 246
diff changeset
744 return result
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
745 def onecmd_plus_hooks(self, line):
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
746 line = self.precmd(line)
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
747 stop = self.onecmd(line)
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
748 stop = self.postcmd(stop, line)
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
749 return stop
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
750 def onecmd(self, line):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
751 """Interpret the argument as though it had been typed in response
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
752 to the prompt.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
753
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
754 This may be overridden, but should not normally need to be;
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
755 see the precmd() and postcmd() methods for useful execution hooks.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
756 The return value is a flag indicating whether interpretation of
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
757 commands by the interpreter should stop.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
758
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
759 This (`cmd2`) version of `onecmd` already override's `cmd`'s `onecmd`.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
760
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
761 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
762 if not line:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
763 return self.emptyline()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
764 if not pyparsing.Or(self.commentGrammars).setParseAction(lambda x: '').transformString(line):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
765 return 0 # command was empty except for comments
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 statement = self.parsed(line)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
768 while statement.parsed.multilineCommand and (statement.parsed.terminator == ''):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
769 statement = '%s\n%s' % (statement.parsed.raw,
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
770 self.pseudo_raw_input(self.continuation_prompt))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
771 statement = self.parsed(statement)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
772 except Exception, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
773 self.perror(e)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
774 return 0
246
2e37155d2b95 history fix
catherine@Elli.myhome.westell.com
parents: 245
diff changeset
775 if statement.parsed.command not in self.excludeFromHistory:
2e37155d2b95 history fix
catherine@Elli.myhome.westell.com
parents: 245
diff changeset
776 self.history.append(statement.parsed.raw)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
777 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
778 (stop, statement) = self.postparsing_precmd(statement)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
779 except Exception, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
780 self.perror(e)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
781 return 0
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
782 if stop:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
783 return self.postparsing_postcmd(stop)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
784
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
785 if not statement.parsed.command:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
786 return self.postparsing_postcmd(stop=0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
787
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
788 statekeeper = None
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
789
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
790 if statement.parsed.pipeTo:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
791 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
792 statekeeper = Statekeeper(self, ('stdout',))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
793 self.stdout = redirect.stdin
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
794 elif statement.parsed.output:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
795 statekeeper = Statekeeper(self, ('stdout',))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
796 if statement.parsed.outputTo:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
797 mode = 'w'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
798 if statement.parsed.output == '>>':
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
799 mode = 'a'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
800 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
801 self.stdout = open(os.path.expanduser(statement.parsed.outputTo), mode)
282
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
802 except Exception, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
803 self.perror(e)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
804 return self.postparsing_postcmd(stop=0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
805 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
806 statekeeper = Statekeeper(self, ('stdout',))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
807 self.stdout = tempfile.TemporaryFile()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
808 if statement.parsed.output == '>>':
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
809 self.stdout.write(get_paste_buffer())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
810 try:
251
bc6dec08275f transcript tests work
catherine@Elli.myhome.westell.com
parents: 250
diff changeset
811 try:
292
23cf05c6276c time to work on parsing refactor
catherine@bothari
parents: 291
diff changeset
812 # "heart" of the command, replaces cmd's onecmd()
300
1e4773b325d1 assume newfunc does not have to accept unparsed arguments
catherine@dellzilla
parents: 299
diff changeset
813 self.lastcmd = statement.parsed.raw
275
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
814 funcname = self.func_named(statement.parsed.command)
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
815 if not funcname:
330
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
816 return self._default(statement)
275
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
817 try:
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
818 func = getattr(self, funcname)
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
819 except AttributeError:
330
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
820 return self._default(statement)
275
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
821 timestart = datetime.datetime.now()
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
822 stop = func(statement)
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
823 if self.timing:
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
824 self.pfeedback('Elapsed: %s' % str(datetime.datetime.now() - timestart))
f62e9fbb3f90 restoring python 2.4 compatibility
catherine@cordelia
parents: 274
diff changeset
825 except Exception, e:
276
9bcfa4f81825 changes for error reporting complete
catherine@cordelia
parents: 275
diff changeset
826 self.perror(e, statement)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
827 finally:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
828 if statekeeper:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
829 if statement.parsed.output and not statement.parsed.outputTo:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
830 self.stdout.seek(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
831 try:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
832 write_to_paste_buffer(self.stdout.read())
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
833 except Exception, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
834 self.perror(e)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
835 elif statement.parsed.pipeTo:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
836 for result in redirect.communicate():
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
837 statekeeper.stdout.write(result or '')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
838 self.stdout.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
839 statekeeper.restore()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
840
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
841 return self.postparsing_postcmd(stop)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
842
330
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
843 def _default(self, statement):
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
844 arg = statement.full_parsed_statement()
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
845 if self.default_to_shell:
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
846 result = os.system(arg)
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
847 if not result:
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
848 return self.postparsing_postcmd(None)
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
849 return self.postparsing_postcmd(self.default(arg))
3aca8af5971f default_to_shell
cat@eee
parents: 329
diff changeset
850
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
851 def pseudo_raw_input(self, prompt):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
852 """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
853
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
854 if self.use_rawinput:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
855 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
856 line = raw_input(prompt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
857 except EOFError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
858 line = 'EOF'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
859 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
860 self.stdout.write(prompt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
861 self.stdout.flush()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
862 line = self.stdin.readline()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
863 if not len(line):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
864 line = 'EOF'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
865 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
866 if line[-1] == '\n': # this was always true in Cmd
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
867 line = line[:-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
868 return line
282
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
869
334
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
870 def _cmdloop(self, intro=None):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
871 """Repeatedly issue a prompt, accept input, parse an initial prefix
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
872 off the received input, and dispatch to action methods, passing them
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
873 the remainder of the line as argument.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
874 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
875
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
876 # An almost perfect copy from Cmd; however, the pseudo_raw_input portion
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
877 # has been split out so that it can be called separately
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
878
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
879 self.preloop()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
880 if self.use_rawinput and self.completekey:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
881 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
882 import readline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
883 self.old_completer = readline.get_completer()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
884 readline.set_completer(self.complete)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
885 readline.parse_and_bind(self.completekey+": complete")
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
886 except ImportError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
887 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
888 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
889 if intro is not None:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
890 self.intro = intro
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
891 if self.intro:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
892 self.stdout.write(str(self.intro)+"\n")
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
893 stop = None
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
894 while not stop:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
895 if self.cmdqueue:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
896 line = self.cmdqueue.pop(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
897 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
898 line = self.pseudo_raw_input(self.prompt)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
899 if (self.echo) and (isinstance(self.stdin, file)):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
900 self.stdout.write(line + '\n')
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
901 stop = self.onecmd_plus_hooks(line)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
902 self.postloop()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
903 finally:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
904 if self.use_rawinput and self.completekey:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
905 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
906 import readline
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
907 readline.set_completer(self.old_completer)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
908 except ImportError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
909 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
910 return stop
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
911
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
912 def do_EOF(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
913 return True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
914 do_eof = do_EOF
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
915
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
916 def do_quit(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
917 return self._STOP_AND_EXIT
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
918 do_exit = do_quit
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
919 do_q = do_quit
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
920
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
921 def select(self, options, prompt='Your choice? '):
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
922 '''Presents a numbered menu to the user. Modelled after
310
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
923 the bash shell's SELECT. Returns the item chosen.
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
924
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
925 Argument ``options`` can be:
332
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
926
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
927 | a single string -> will be split into one-word options
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
928 | a list of strings -> will be offered as options
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
929 | a list of tuples -> interpreted as (value, text), so
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
930 that the return value can differ from
49bea7cab179 doc refreshing refresh.bash
cat@eee
parents: 331
diff changeset
931 the text advertised to the user '''
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
932 if isinstance(options, basestring):
310
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
933 options = zip(options.split(), options.split())
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
934 fulloptions = []
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
935 for opt in options:
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
936 if isinstance(opt, basestring):
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
937 fulloptions.append((opt, opt))
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
938 else:
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
939 try:
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
940 fulloptions.append((opt[0], opt[1]))
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
941 except IndexError:
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
942 fulloptions.append((opt[0], opt[0]))
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
943 for (idx, (value, text)) in enumerate(fulloptions):
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
944 self.poutput(' %2d. %s\n' % (idx+1, text))
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
945 while True:
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
946 response = raw_input(prompt)
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
947 try:
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
948 response = int(response)
310
9d91406ca3a7 select polished
catherine@dellzilla
parents: 309
diff changeset
949 result = fulloptions[response - 1][0]
309
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
950 break
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
951 except ValueError:
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
952 pass # loop and ask again
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
953 return result
1941e54cb776 added bash-style SELECT
catherine@dellzilla
parents: 308
diff changeset
954
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
955 @options([make_option('-l', '--long', action="store_true",
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
956 help="describe function of parameter")])
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
957 def do_show(self, arg, opts):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
958 '''Shows value of a parameter.'''
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
959 param = arg.strip().lower()
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
960 result = {}
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
961 maxlen = 0
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
962 for p in self.settable:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
963 if (not param) or p.startswith(param):
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
964 result[p] = '%s: %s' % (p, str(getattr(self, p)))
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
965 maxlen = max(maxlen, len(result[p]))
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
966 if result:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
967 for p in sorted(result):
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
968 if opts.long:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
969 self.poutput('%s # %s' % (result[p].ljust(maxlen), self.settable[p]))
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
970 else:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
971 self.poutput(result[p])
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
972 else:
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
973 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
974
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
975 def do_set(self, arg):
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
976 '''
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
977 Sets a cmd2 parameter. Accepts abbreviated parameter names so long
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
978 as there is no ambiguity. Call without arguments for a list of
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
979 settable parameters with their values.'''
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
980 try:
291
dfdbd93a2fae bugfixes to set
catherine@bothari
parents: 290
diff changeset
981 statement, paramName, val = arg.parsed.raw.split(None, 2)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
982 paramName = paramName.strip().lower()
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
983 if paramName not in self.settable:
291
dfdbd93a2fae bugfixes to set
catherine@bothari
parents: 290
diff changeset
984 hits = [p for p in self.settable if p.startswith(paramName)]
290
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
985 if len(hits) == 1:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
986 paramName = hits[0]
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
987 else:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
988 return self.do_show(paramName)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
989 currentVal = getattr(self, paramName)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
990 if (val[0] == val[-1]) and val[0] in ("'", '"'):
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
991 val = val[1:-1]
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
992 else:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
993 val = cast(currentVal, val)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
994 setattr(self, paramName, val)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
995 self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
996 if currentVal != val:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
997 try:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
998 onchange_hook = getattr(self, '_onchange_%s' % paramName)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
999 onchange_hook(old=currentVal, new=val)
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
1000 except AttributeError:
cd12e4e0fa17 show -l working
catherine@bothari
parents: 289
diff changeset
1001 pass
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1002 except (ValueError, AttributeError, NotSettableError), e:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1003 self.do_show(arg)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1004
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1005 def do_pause(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1006 'Displays the specified text then waits for the user to press RETURN.'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1007 raw_input(arg + '\n')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1008
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1009 def do_shell(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1010 'execute a command as if at the OS prompt.'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1011 os.system(arg)
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1012
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1013 def do_py(self, arg):
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1014 '''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1015 py <command>: Executes a Python command.
242
d36ffc16f575 adjust docstring for windows
catherine@dellzilla
parents: 241
diff changeset
1016 py: Enters interactive Python mode.
d36ffc16f575 adjust docstring for windows
catherine@dellzilla
parents: 241
diff changeset
1017 End with `Ctrl-D` (Unix) / `Ctrl-Z` (Windows), `quit()`, 'exit()`.
241
af17ead6449d shortened docstring to avoid word wrap
catherine@dellzilla
parents: 240
diff changeset
1018 Non-python commands can be issued with `cmd("your command")`.
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1019 '''
280
38198b11f48c adding .get() to opts
catherine@DellZilla
parents: 279
diff changeset
1020 self.pystate['self'] = self
274
540315f06a17 must use unparsed string for py
catherine@cordelia
parents: 273
diff changeset
1021 arg = arg.parsed.raw[2:].strip()
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1022 if arg.strip():
235
78ad20c2eed0 py working better now; still needs a iscomplete=True on onecmd
catherine@dellzilla
parents: 234
diff changeset
1023 interp = InteractiveInterpreter(locals=self.pystate)
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1024 interp.runcode(arg)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1025 else:
328
7b2bca3951a7 locals_in_py
cat@eee
parents: 327
diff changeset
1026 localvars = (self.locals_in_py and self.pystate) or {}
339
6c397f0865c7 MyInteractiveInterpreter removed
catherine@Drou
parents: 336
diff changeset
1027 interp = InteractiveConsole(locals=localvars)
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1028 def quit():
234
ff99b39259d5 maybe quit and exit work now?
catherine@dellzilla
parents: 233
diff changeset
1029 raise EmbeddedConsoleExit
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1030 def onecmd_plus_hooks(arg):
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1031 return self.onecmd_plus_hooks(arg + '\n')
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1032 self.pystate['quit'] = quit
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1033 self.pystate['exit'] = quit
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1034 self.pystate['cmd'] = onecmd_plus_hooks
234
ff99b39259d5 maybe quit and exit work now?
catherine@dellzilla
parents: 233
diff changeset
1035 try:
240
a31cf334bc16 tweaking documentation
catherine@dellzilla
parents: 237
diff changeset
1036 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
1037 keepstate = Statekeeper(sys, ('stdin','stdout'))
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1038 sys.stdout = self.stdout
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1039 sys.stdin = self.stdin
240
a31cf334bc16 tweaking documentation
catherine@dellzilla
parents: 237
diff changeset
1040 interp.interact(banner= "Python %s on %s\n%s\n(%s)\n%s" %
a31cf334bc16 tweaking documentation
catherine@dellzilla
parents: 237
diff changeset
1041 (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
1042 except EmbeddedConsoleExit:
245
2cda5a817e5a send to ioug
catherine@Elli.myhome.westell.com
parents: 244
diff changeset
1043 pass
2cda5a817e5a send to ioug
catherine@Elli.myhome.westell.com
parents: 244
diff changeset
1044 keepstate.restore()
233
d2cc9a090b7f now using code.InteractiveConsole
catherine@dellzilla
parents: 232
diff changeset
1045
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1046 def do_history(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1047 """history [arg]: lists past commands issued
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1048
314
0687bb650118 begin new docs
catherine@dellzilla
parents: 313
diff changeset
1049 | no arg: list all
0687bb650118 begin new docs
catherine@dellzilla
parents: 313
diff changeset
1050 | arg is integer: list one history item, by index
0687bb650118 begin new docs
catherine@dellzilla
parents: 313
diff changeset
1051 | arg is string: string search
0687bb650118 begin new docs
catherine@dellzilla
parents: 313
diff changeset
1052 | arg is /enclosed in forward-slashes/: regular expression search
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1053 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1054 if arg:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1055 history = self.history.get(arg)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1056 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1057 history = self.history
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1058 for hi in history:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1059 self.stdout.write(hi.pr())
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1060 def last_matching(self, arg):
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 if arg:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1063 return self.history.get(arg)[-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1064 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1065 return self.history[-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1066 except IndexError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1067 return None
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1068 def do_list(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1069 """list [arg]: lists last command issued
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1070
307
43273a4b517c throw error from .span'
catherine@bothari
parents: 306
diff changeset
1071 no arg -> list most recent command
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1072 arg is integer -> list one history item, by index
307
43273a4b517c throw error from .span'
catherine@bothari
parents: 306
diff changeset
1073 a..b, a:b, a:, ..b -> list spans from a (or start) to b (or end)
308
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1074 arg is string -> list all commands matching string search
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1075 arg is /enclosed in forward-slashes/ -> regular expression search
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1076 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1077 try:
308
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1078 history = self.history.span(arg or '-1')
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1079 except IndexError:
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1080 history = self.history.search(arg)
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1081 for hi in history:
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1082 self.poutput(hi.pr())
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1083
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1084 do_hi = do_history
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1085 do_l = do_list
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1086 do_li = do_list
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1087
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1088 def do_ed(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1089 """ed: edit most recent command in text editor
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1090 ed [N]: edit numbered command from history
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1091 ed [filename]: edit specified file name
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1092
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1093 commands are run after editor is closed.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1094 "set edit (program-name)" or set EDITOR environment variable
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1095 to control which editing program is used."""
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1096 if not self.editor:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1097 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
1098 return
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1099 filename = self.default_file_name
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1100 if arg:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1101 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1102 buffer = self.last_matching(int(arg))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1103 except ValueError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1104 filename = arg
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1105 buffer = ''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1106 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1107 buffer = self.history[-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1108
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1109 if buffer:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1110 f = open(os.path.expanduser(filename), 'w')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1111 f.write(buffer or '')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1112 f.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1113
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1114 os.system('%s %s' % (self.editor, filename))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1115 self.do__load(filename)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1116 do_edit = do_ed
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1117
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1118 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") +
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1119 pyparsing.Optional(pyparsing.Word(legalChars + '/\\'))("fname") +
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1120 pyparsing.stringEnd)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1121 def do_save(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1122 """`save [N] [filename.ext]`
329
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
1123
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1124 Saves command from history to file.
329
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
1125
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
1126 | N => Number of command (from history), or `*`;
c69ad8418d39 free function docs
cat@eee
parents: 328
diff changeset
1127 | most recent command if omitted"""
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1128
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1129 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1130 args = self.saveparser.parseString(arg)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1131 except pyparsing.ParseException:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1132 self.perror(self.do_save.__doc__)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1133 return
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1134 fname = args.fname or self.default_file_name
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1135 if args.idx == '*':
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1136 saveme = '\n\n'.join(self.history[:])
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1137 elif args.idx:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1138 saveme = self.history[int(args.idx)-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1139 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1140 saveme = self.history[-1]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1141 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1142 f = open(os.path.expanduser(fname), 'w')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1143 f.write(saveme)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1144 f.close()
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1145 self.pfeedback('Saved to %s' % (fname))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1146 except Exception, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1147 self.perror('Error saving %s: %s' % (fname, str(e)))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1148
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1149 def read_file_or_url(self, fname):
288
e743cf74c518 hooray, fixed bad comment parser - all unit tests pass
catherine@bothari
parents: 287
diff changeset
1150 # TODO: not working on localhost
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1151 if isinstance(fname, file):
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
1152 result = open(fname, 'r')
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1153 else:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1154 match = self.urlre.match(fname)
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1155 if match:
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
1156 result = urllib.urlopen(match.group(1))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1157 else:
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1158 fname = os.path.expanduser(fname)
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1159 try:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1160 result = open(os.path.expanduser(fname), 'r')
287
1cd23003e8d5 refactoring, but something went wrong with comments
catherine@bothari
parents: 286
diff changeset
1161 except IOError:
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1162 result = open('%s.%s' % (os.path.expanduser(fname),
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1163 self.defaultExtension), 'r')
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1164 return result
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1165
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1166 def do__relative_load(self, arg=None):
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1167 '''
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1168 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
1169 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
1170 already-running script's directory.'''
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1171 if arg:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1172 arg = arg.split(None, 1)
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1173 targetname, args = arg[0], (arg[1:] or [''])[0]
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1174 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
1175 self.do__load('%s %s' % (targetname, args))
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1176
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1177 urlre = re.compile('(https?://[-\\w\\./]+)')
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1178 def do_load(self, arg=None):
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1179 """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
1180 if arg is None:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1181 targetname = self.default_file_name
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1182 else:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1183 arg = arg.split(None, 1)
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1184 targetname, args = arg[0], (arg[1:] or [''])[0].strip()
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1185 try:
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1186 target = self.read_file_or_url(targetname)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1187 except IOError, e:
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1188 self.perror('Problem accessing script from %s: \n%s' % (targetname, e))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1189 return
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1190 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt',
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1191 'continuation_prompt','current_script_dir'))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1192 self.stdin = target
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1193 self.use_rawinput = False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1194 self.prompt = self.continuation_prompt = ''
244
e0c60ea7ad5d midway through py script change
catherine@Elli.myhome.westell.com
parents: 243
diff changeset
1195 self.current_script_dir = os.path.split(targetname)[0]
334
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1196 stop = self._cmdloop()
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1197 self.stdin.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1198 keepstate.restore()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1199 self.lastcmd = ''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1200 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1201 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
1202
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1203 def do_run(self, arg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1204 """run [arg]: re-runs an earlier command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1205
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1206 no arg -> run most recent command
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1207 arg is integer -> run one history item, by index
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1208 arg is string -> run most recent command by string search
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1209 arg is /enclosed in forward-slashes/ -> run most recent by regex
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1210 """
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1211 'run [N]: runs the SQL that was run N commands ago'
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1212 runme = self.last_matching(arg)
267
3333e61e7103 poutput, perror, pfeedback
Catherine Devlin <catherine.devlin@gmail.com>
parents: 265
diff changeset
1213 self.pfeedback(runme)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1214 if runme:
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1215 stop = self.onecmd_plus_hooks(runme)
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1216 do_r = do_run
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1217
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1218 def fileimport(self, statement, source):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1219 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1220 f = open(os.path.expanduser(source))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1221 except IOError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1222 self.stdout.write("Couldn't read from file %s\n" % source)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1223 return ''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1224 data = f.read()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1225 f.close()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1226 return data
334
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1227
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1228 def runTranscriptTests(self, callargs):
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1229 class TestMyAppCase(Cmd2TestCase):
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1230 CmdApp = self.__class__
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1231 self.__class__.testfiles = callargs
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1232 sys.argv = [sys.argv[0]] # the --test argument upsets unittest.main()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1233 testcase = TestMyAppCase()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1234 runner = unittest.TextTestRunner()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1235 result = runner.run(testcase)
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1236 result.printErrors()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1237
335
f69211e2c570 tweaks for sqlpython compatibility
catherine@Drou
parents: 334
diff changeset
1238 def run_commands_at_invocation(self, callargs):
f69211e2c570 tweaks for sqlpython compatibility
catherine@Drou
parents: 334
diff changeset
1239 for initial_command in callargs:
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1240 if self.onecmd_plus_hooks(initial_command + '\n'):
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1241 return self._STOP_AND_EXIT
335
f69211e2c570 tweaks for sqlpython compatibility
catherine@Drou
parents: 334
diff changeset
1242
334
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1243 def cmdloop(self):
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1244 parser = optparse.OptionParser()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1245 parser.add_option('-t', '--test', dest='test',
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1246 action="store_true",
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1247 help='Test against transcript(s) in FILE (wildcards OK)')
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1248 (callopts, callargs) = parser.parse_args()
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1249 if callopts.test:
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1250 self.runTranscriptTests(callargs)
99dd71cb477a run() folded into app.cmdloop()
cat@eee
parents: 333
diff changeset
1251 else:
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1252 if not self.run_commands_at_invocation(callargs):
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1253 self._cmdloop()
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1254
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1255 class HistoryItem(str):
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1256 listformat = '-------------------------[%d]\n%s\n'
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1257 def __init__(self, instr):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1258 str.__init__(self)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1259 self.lowercase = self.lower()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1260 self.idx = None
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1261 def pr(self):
307
43273a4b517c throw error from .span'
catherine@bothari
parents: 306
diff changeset
1262 return self.listformat % (self.idx, str(self))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1263
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1264 class History(list):
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1265 '''A list of HistoryItems that knows how to respond to user requests.
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1266 >>> h = History([HistoryItem('first'), HistoryItem('second'), HistoryItem('third'), HistoryItem('fourth')])
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1267 >>> h.span('-2..')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1268 ['third', 'fourth']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1269 >>> h.span('2..3')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1270 ['second', 'third']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1271 >>> h.span('3')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1272 ['third']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1273 >>> h.span(':')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1274 ['first', 'second', 'third', 'fourth']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1275 >>> h.span('2..')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1276 ['second', 'third', 'fourth']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1277 >>> h.span('-1')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1278 ['fourth']
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1279 >>> h.span('-2..-3')
306
1802f8c75265 new History.span()
catherine@dellzilla
parents: 305
diff changeset
1280 ['third', 'second']
308
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1281 >>> h.search('o')
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1282 ['second', 'fourth']
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1283 >>> h.search('/IR/')
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1284 ['first', 'third']
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1285 '''
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1286 def zero_based_index(self, onebased):
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1287 result = onebased
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1288 if result > 0:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1289 result -= 1
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1290 return result
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1291 def to_index(self, raw):
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1292 if raw:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1293 result = self.zero_based_index(int(raw))
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1294 else:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1295 result = None
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1296 return result
308
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1297 def search(self, target):
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1298 target = target.strip()
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1299 if target[0] == target[-1] == '/' and len(target) > 1:
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1300 target = target[1:-1]
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1301 else:
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1302 target = re.escape(target)
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1303 pattern = re.compile(target, re.IGNORECASE)
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1304 return [s for s in self if pattern.search(s)]
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1305 spanpattern = re.compile(r'^\s*(?P<start>\-?\d+)?\s*(?P<separator>:|(\.{2,}))?\s*(?P<end>\-?\d+)?\s*$')
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1306 def span(self, raw):
308
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1307 if raw.lower() in ('*', '-', 'all'):
4e9011c3f732 tightening up history.search
catherine@bothari
parents: 307
diff changeset
1308 raw = ':'
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1309 results = self.spanpattern.search(raw)
307
43273a4b517c throw error from .span'
catherine@bothari
parents: 306
diff changeset
1310 if not results:
43273a4b517c throw error from .span'
catherine@bothari
parents: 306
diff changeset
1311 raise IndexError
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1312 if not results.group('separator'):
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1313 return [self[self.to_index(results.group('start'))]]
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1314 start = self.to_index(results.group('start'))
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1315 end = self.to_index(results.group('end'))
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1316 reverse = False
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1317 if end is not None:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1318 if end < start:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1319 (start, end) = (end, start)
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1320 reverse = True
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1321 end += 1
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1322 result = self[start:end]
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1323 if reverse:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1324 result.reverse()
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1325 return result
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1326
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1327 rangePattern = re.compile(r'^\s*(?P<start>[\d]+)?\s*\-\s*(?P<end>[\d]+)?\s*$')
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1328 def append(self, new):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1329 new = HistoryItem(new)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1330 list.append(self, new)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1331 new.idx = len(self)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1332 def extend(self, new):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1333 for n in new:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1334 self.append(n)
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1335
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1336 def get(self, getme=None, fromEnd=False):
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1337 if not getme:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1338 return self
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1339 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1340 getme = int(getme)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1341 if getme < 0:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1342 return self[:(-1 * getme)]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1343 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1344 return [self[getme-1]]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1345 except IndexError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1346 return []
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1347 except ValueError:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1348 rangeResult = self.rangePattern.search(getme)
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1349 if rangeResult:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1350 start = rangeResult.group('start') or None
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1351 end = rangeResult.group('start') or None
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1352 if start:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1353 start = int(start) - 1
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1354 if end:
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1355 end = int(end)
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1356 return self[start:end]
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1357
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1358 getme = getme.strip()
305
f84e8be8a792 new History.span()
catherine@dellzilla
parents: 304
diff changeset
1359
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1360 if getme.startswith(r'/') and getme.endswith(r'/'):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1361 finder = re.compile(getme[1:-1], re.DOTALL | re.MULTILINE | re.IGNORECASE)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1362 def isin(hi):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1363 return finder.search(hi)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1364 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1365 def isin(hi):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1366 return (getme.lower() in hi.lowercase)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1367 return [itm for itm in self if isin(itm)]
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1368
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1369 class NotSettableError(Exception):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1370 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1371
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1372 def cast(current, new):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1373 """Tries to force a new value into the same type as the current."""
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1374 typ = type(current)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1375 if typ == bool:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1376 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1377 return bool(int(new))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1378 except ValueError, TypeError:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1379 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1380 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1381 new = new.lower()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1382 except:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1383 pass
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1384 if (new=='on') or (new[0] in ('y','t')):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1385 return True
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1386 if (new=='off') or (new[0] in ('n','f')):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1387 return False
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1388 else:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1389 try:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1390 return typ(new)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1391 except:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1392 pass
341
9e593c480782 cleanup print to py3 syntax'
catherine@Drou
parents: 340
diff changeset
1393 print ("Problem setting parameter (now %s) to %s; incorrect type?" % (current, new))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1394 return current
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1395
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1396 class Statekeeper(object):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1397 def __init__(self, obj, attribs):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1398 self.obj = obj
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1399 self.attribs = attribs
282
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
1400 if self.obj:
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
1401 self.save()
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1402 def save(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1403 for attrib in self.attribs:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1404 setattr(self, attrib, getattr(self.obj, attrib))
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1405 def restore(self):
282
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
1406 if self.obj:
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
1407 for attrib in self.attribs:
7c6eb0fc75ef added debug stack trace printing
catherine@DellZilla
parents: 280
diff changeset
1408 setattr(self.obj, attrib, getattr(self, attrib))
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1409
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1410 class Borg(object):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1411 '''All instances of any Borg subclass will share state.
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1412 from Python Cookbook, 2nd Ed., recipe 6.16'''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1413 _shared_state = {}
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1414 def __new__(cls, *a, **k):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1415 obj = object.__new__(cls, *a, **k)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1416 obj.__dict__ = cls._shared_state
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1417 return obj
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1418
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1419 class OutputTrap(Borg):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1420 '''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
1421 Call `tearDown()` to return to normal output.'''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1422 def __init__(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1423 self.old_stdout = sys.stdout
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1424 self.trap = tempfile.TemporaryFile()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1425 sys.stdout = self.trap
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1426 def read(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1427 self.trap.seek(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1428 result = self.trap.read()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1429 self.trap.truncate(0)
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1430 return result.strip('\x00')
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1431 def tearDown(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1432 sys.stdout = self.old_stdout
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1433
261
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1434
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1435 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
1436 '''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
1437 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
1438 See example.py'''
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1439 CmdApp = None
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1440 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
1441 self.transcripts = {}
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1442 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
1443 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
1444 tfile = open(fname)
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1445 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
1446 tfile.close()
260
2b69c4d72cd8 unfinished experiments with testing for regular expressions
Catherine Devlin <catherine.devlin@gmail.com>
parents: 259
diff changeset
1447 if not len(self.transcripts):
2b69c4d72cd8 unfinished experiments with testing for regular expressions
Catherine Devlin <catherine.devlin@gmail.com>
parents: 259
diff changeset
1448 raise StandardError, "No test files found - nothing to test."
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1449 def setUp(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1450 if self.CmdApp:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1451 self.outputTrap = OutputTrap()
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1452 self.cmdapp = self.CmdApp()
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1453 self.fetchTranscripts()
326
237a89d5a4a9 run() working
catherine@dellzilla
parents: 325
diff changeset
1454 def runTest(self): # was testall
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1455 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
1456 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
1457 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
1458 self._test_transcript(fname, transcript)
261
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1459 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
1460 regexPattern.ignore(pyparsing.cStyleComment)
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1461 notRegexPattern = pyparsing.Word(pyparsing.printables)
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1462 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
1463 expectationParser = regexPattern | notRegexPattern
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1464 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
1465 def _test_transcript(self, fname, transcript):
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1466 lineNum = 0
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1467 try:
304
8c96f829ba1b tweaking transcript test newlines (complete)
catherine@dellzilla
parents: 303
diff changeset
1468 line = transcript.next()
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1469 while True:
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1470 while not line.startswith(self.cmdapp.prompt):
304
8c96f829ba1b tweaking transcript test newlines (complete)
catherine@dellzilla
parents: 303
diff changeset
1471 line = transcript.next()
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1472 command = [line[len(self.cmdapp.prompt):]]
304
8c96f829ba1b tweaking transcript test newlines (complete)
catherine@dellzilla
parents: 303
diff changeset
1473 line = transcript.next()
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1474 while line.startswith(self.cmdapp.continuation_prompt):
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1475 command.append(line[len(self.cmdapp.continuation_prompt):])
304
8c96f829ba1b tweaking transcript test newlines (complete)
catherine@dellzilla
parents: 303
diff changeset
1476 line = transcript.next()
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 343
diff changeset
1477 command = ''.join(command)
346
49dd1ce6cfd6 quitting after invocation commands
catherine@Drou
parents: 345
diff changeset
1478 stop = self.cmdapp.onecmd_plus_hooks(command)
345
6fe1e75e3a67 transcript test wasn't running pre and post cmd hooks
catherine@Drou
parents: 343
diff changeset
1479 #TODO: should act on ``stop``
322
7cd74e42b7f9 transcript test running again
catherine@dellzilla
parents: 320
diff changeset
1480 result = self.outputTrap.read()
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1481 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
1482 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
1483 (fname, lineNum, command, result)
e81378f82c7c transcript tests with regex now work smoothly
Catherine Devlin <catherine.devlin@gmail.com>
parents: 261
diff changeset
1484 self.assert_(not(result.strip()), message)
253
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1485 continue
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1486 expected = []
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1487 while not line.startswith(self.cmdapp.prompt):
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1488 expected.append(line)
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1489 line = transcript.next()
322
7cd74e42b7f9 transcript test running again
catherine@dellzilla
parents: 320
diff changeset
1490 expected = ''.join(expected)
260
2b69c4d72cd8 unfinished experiments with testing for regular expressions
Catherine Devlin <catherine.devlin@gmail.com>
parents: 259
diff changeset
1491 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
1492 (fname, lineNum, command, expected, result)
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1493 expected = self.expectationParser.transformString(expected)
57070e181cf7 line end-stripping working in transcript testing
Catherine Devlin <catherine.devlin@gmail.com>
parents: 260
diff changeset
1494 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
1495 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
1496 except StopIteration:
24289178b367 midway through allowing multiple testing files
Catherine Devlin <catherine.devlin@gmail.com>
parents: 251
diff changeset
1497 pass
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1498 def tearDown(self):
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1499 if self.CmdApp:
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1500 self.outputTrap.tearDown()
325
4172feeddf76 want to incorporate run() for tests - not yet working
catherine@dellzilla
parents: 324
diff changeset
1501
230
fea183146819 merged abbrev changes
catherine@dellzilla
parents: 226 229
diff changeset
1502 if __name__ == '__main__':
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1503 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE)
325
4172feeddf76 want to incorporate run() for tests - not yet working
catherine@dellzilla
parents: 324
diff changeset
1504
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1505 '''
327
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1506 To make your application transcript-testable, replace
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1507
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1508 ::
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1509
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1510 app = MyApp()
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1511 app.cmdloop()
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1512
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1513 with
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1514
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1515 ::
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1516
327
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1517 app = MyApp()
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1518 cmd2.run(app)
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1519
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1520 Then run a session of your application and paste the entire screen contents
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1521 into a file, ``transcript.test``, and invoke the test like::
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1522
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1523 python myapp.py --test transcript.test
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1524
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1525 Wildcards can be used to test against multiple transcript files.
327
e9eea93c777c initial args working
catherine@dellzilla
parents: 326
diff changeset
1526 '''
259
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1527
5147fa4166b0 multiple transcript tests working - sinister BASH trick defeated
Catherine Devlin <catherine.devlin@gmail.com>
parents: 258
diff changeset
1528