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