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