Mercurial > python-cmd2

annotate cmd2/cmd2.py @ 110:234fb764becd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
moved README
author catherine@dellzilla
date Fri, 24 Oct 2008 16:55:49 -0400
parents 78c4db4c2045
children e3b8eaadea56
rev   line source
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
1 """Variant on standard library's cmd with extra features.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
2
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
3 To use, simply import cmd2.Cmd instead of cmd.Cmd; use precisely as though you
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
4 were using the standard library's cmd, while enjoying the extra features.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
5
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
6 Searchable command history (commands: "hi", "li", "run")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
7 Load commands from file, save to file, edit commands in file
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
8 Multi-line commands
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
9 Case-insensitive commands
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
10 Special-character shortcut commands (beyond cmd's "@" and "!")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
11 Settable environment parameters
13
c6e8b645c0ab tweaking docs
catherine@localhost
parents: 12
diff changeset
12 Parsing commands with `optparse` options (flags)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
13 Redirection to file with >, >>; input from file with <
13
c6e8b645c0ab tweaking docs
catherine@localhost
parents: 12
diff changeset
14
84
416ea36af789 fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents: 83
diff changeset
15 Note that redirection with > and | will only work if `self.stdout.write()`
416ea36af789 fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents: 83
diff changeset
16 is used in place of `print`. The standard library's `cmd` module is
416ea36af789 fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents: 83
diff changeset
17 written to use `self.stdout.write()`,
416ea36af789 fixed bug in setting parameters
catherine@Elli.myhome.westell.com
parents: 83
diff changeset
18
14
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
19 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
20
14
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
21 CHANGES:
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
22 As of 0.3.0, options should be specified as `optparse` options. See README.txt.
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
23 flagReader.py options are still supported for backward compatibility
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
24 """
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
25 import cmd, re, os, sys, optparse, subprocess, tempfile, pyparsing, doctest, unittest
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
26 from optparse import make_option
109
78c4db4c2045 all done but the proper packaging
catherine@dellzilla
parents: 108
diff changeset
27 __version__ = '0.4'
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
28
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
29 class OptionParser(optparse.OptionParser):
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
30 def exit(self, status=0, msg=None):
38
6d715d7a04fd proper exit after -h, -v
catherine@localhost
parents: 37
diff changeset
31 self.values._exit = True
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
32 if msg:
15
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
33 print msg
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
34
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
35 def error(self, msg):
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
36 """error(msg : string)
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
37
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
38 Print a usage message incorporating 'msg' to stderr and exit.
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
39 If you override this in a subclass, it should not return -- it
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
40 should either exit or raise an exception.
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
41 """
15
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
42 raise
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
43
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
44 def options(option_list):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
45 def option_setup(func):
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
46 optionParser = OptionParser()
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
47 for opt in option_list:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
48 optionParser.add_option(opt)
12
catherine@localhost
parents: 11
diff changeset
49 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
50 def newFunc(instance, arg):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
51 try:
20
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
52 opts, arg = optionParser.parse_args(arg.split())
37
a974e2f44cbe made redirectors work with app-specific StatementEndPattern
catherine@localhost
parents: 36
diff changeset
53 arg = ' '.join(arg)
20
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
54 except (optparse.OptionValueError, optparse.BadOptionError,
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
55 optparse.OptionError, optparse.AmbiguousOptionError,
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
56 optparse.OptionConflictError), e:
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
57 print e
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
58 optionParser.print_help()
38
6d715d7a04fd proper exit after -h, -v
catherine@localhost
parents: 37
diff changeset
59 return
6d715d7a04fd proper exit after -h, -v
catherine@localhost
parents: 37
diff changeset
60 if hasattr(opts, '_exit'):
6d715d7a04fd proper exit after -h, -v
catherine@localhost
parents: 37
diff changeset
61 return None
37
a974e2f44cbe made redirectors work with app-specific StatementEndPattern
catherine@localhost
parents: 36
diff changeset
62 result = func(instance, arg, opts)
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
63 return result
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
64 newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
65 return newFunc
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
66 return option_setup
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
67
27
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
68 class PasteBufferError(EnvironmentError):
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
69 if sys.platform[:3] == 'win':
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
70 errmsg = """Redirecting to or from paste buffer requires pywin32
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
71 to be installed on operating system.
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
72 Download from http://sourceforge.net/projects/pywin32/"""
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
73 else:
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
74 errmsg = """Redirecting to or from paste buffer requires xclip
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
75 to be installed on operating system.
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
76 On Debian/Ubuntu, 'sudo apt-get install xclip' will install it."""
28
28b3fb301d3d almost working, but problem with check_call
catherine@cordelia
parents: 27
diff changeset
77 def __init__(self):
27
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
78 Exception.__init__(self, self.errmsg)
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
79
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
80 '''check here if functions exist; otherwise, stub out'''
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
81 pastebufferr = """Redirecting to or from paste buffer requires %s
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
82 to be installed on operating system.
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
83 %s"""
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
84 if subprocess.mswindows:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
85 try:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
86 import win32clipboard
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
87 def getPasteBuffer():
28
28b3fb301d3d almost working, but problem with check_call
catherine@cordelia
parents: 27
diff changeset
88 win32clipboard.OpenClipboard(0)
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
89 try:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
90 result = win32clipboard.GetClipboardData()
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
91 except TypeError:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
92 result = '' #non-text
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
93 win32clipboard.CloseClipboard()
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
94 return result
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
95 def writeToPasteBuffer(txt):
28
28b3fb301d3d almost working, but problem with check_call
catherine@cordelia
parents: 27
diff changeset
96 win32clipboard.OpenClipboard(0)
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
97 win32clipboard.EmptyClipboard()
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
98 win32clipboard.SetClipboardText(txt)
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
99 win32clipboard.CloseClipboard()
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
100 except ImportError:
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
101 def getPasteBuffer(*args):
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
102 raise OSError, pastebufferr % ('pywin32', 'Download from http://sourceforge.net/projects/pywin32/')
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
103 setPasteBuffer = getPasteBuffer
27
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
104 else:
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
105 can_clip = False
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
106 try:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
107 subprocess.check_call('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
108 can_clip = True
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
109 except AttributeError: # check_call not defined, Python < 2.5
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
110 teststring = 'Testing for presence of xclip.'
31
dd64c0e3dbe0 fixed err in python 2.4 xclip detection
catherine@localhost
parents: 29
diff changeset
111 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
112 xclipproc.stdin.write(teststring)
31
dd64c0e3dbe0 fixed err in python 2.4 xclip detection
catherine@localhost
parents: 29
diff changeset
113 xclipproc.stdin.close()
dd64c0e3dbe0 fixed err in python 2.4 xclip detection
catherine@localhost
parents: 29
diff changeset
114 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
115 if xclipproc.stdout.read() == teststring:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
116 can_clip = True
56
f844b6c78192 fixing (hopefully) broken pipe error for headless systems
catherine.devlin@gmail.com
parents: 54
diff changeset
117 except (subprocess.CalledProcessError, OSError, IOError):
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
118 pass
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
119 if can_clip:
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
120 def getPasteBuffer():
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
121 xclipproc = subprocess.Popen('xclip -o -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
122 return xclipproc.stdout.read()
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
123 def writeToPasteBuffer(txt):
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
124 xclipproc = subprocess.Popen('xclip -sel clip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
125 xclipproc.stdin.write(txt)
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
126 xclipproc.stdin.close()
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
127 # but we want it in both the "primary" and "mouse" clipboards
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
128 xclipproc = subprocess.Popen('xclip', shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
129 xclipproc.stdin.write(txt)
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
130 xclipproc.stdin.close()
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
131 else:
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
132 def getPasteBuffer(*args):
29
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
133 raise OSError, pastebufferr % ('xclip', 'On Debian/Ubuntu, install with "sudo apt-get install xclip"')
c4bd5f1a6968 paste buffer working on linux and windows
catherine@cordelia
parents: 28
diff changeset
134 setPasteBuffer = getPasteBuffer
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
135 writeToPasteBuffer = getPasteBuffer
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
136
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
137 pyparsing.ParserElement.setDefaultWhitespaceChars(' \t')
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
138 def parseSearchResults(pattern, s):
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
139 generator = pattern.scanString(s)
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
140 try:
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
141 result, start, stop = generator.next()
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
142 result['before'], result['after'] = s[:start], s[stop:]
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
143 result['upToIncluding'] = s[:stop]
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
144 except StopIteration:
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
145 result = pyparsing.ParseResults('')
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
146 result['before'] = s
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
147 return result
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
148
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
149 class Cmd(cmd.Cmd):
103
e4daf715fc31 echo on
catherine@dellzilla
parents: 100
diff changeset
150 echo = False
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
151 caseInsensitive = True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
152 multilineCommands = []
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
153 continuationPrompt = '> '
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
154 shortcuts = {'?': 'help', '!': 'shell', '@': 'load'}
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
155 excludeFromHistory = '''run r list l history hi ed edit li eof'''.split()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
156 noSpecialParse = 'set ed edit exit'.split()
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
157 defaultExtension = 'txt'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
158 defaultFileName = 'command.txt'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
159 editor = os.environ.get('EDITOR')
42
b3200c6e5763 inserting exception for quit...
catherine@cordelia
parents: 41
diff changeset
160 _STOP_AND_EXIT = 2
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
161 if not editor:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
162 if sys.platform[:3] == 'win':
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
163 editor = 'notepad'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
164 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
165 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
47
927bc07467de fixed misfind of editor
catherine@cordelia
parents: 46
diff changeset
166 if not os.system('which %s' % (editor)):
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
167 break
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
168
103
e4daf715fc31 echo on
catherine@dellzilla
parents: 100
diff changeset
169 settable = ['prompt', 'continuationPrompt', 'defaultFileName', 'editor', 'caseInsensitive', 'echo']
23
37bff80ef816 refactoring, no failure mode yet
catherine@localhost
parents: 22
diff changeset
170 _TO_PASTE_BUFFER = 1
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
171 def do_cmdenvironment(self, args):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
172 self.stdout.write("""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
173 Commands are %(casesensitive)scase-sensitive.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
174 Commands may be terminated with: %(terminators)s
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
175 Settable parameters: %(settable)s
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
176 """ %
2
1ea887b51cad python 2.4 compatibility
catherine@DellZilla.myhome.westell.com
parents: 0
diff changeset
177 { 'casesensitive': ('not ' and self.caseInsensitive) or '',
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
178 'terminators': self.terminatorPattern,
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
179 'settable': ' '.join(self.settable)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
180 })
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
181
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
182 def do_help(self, arg):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
183 cmd.Cmd.do_help(self, arg)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
184 try:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
185 fn = getattr(self, 'do_' + arg)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
186 if fn and fn.optionParser:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
187 fn.optionParser.print_help(file=self.stdout)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
188 except AttributeError:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
189 pass
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
190
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
191 def __init__(self, *args, **kwargs):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
192 cmd.Cmd.__init__(self, *args, **kwargs)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
193 self.history = History()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
194
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
195 def do_shortcuts(self, args):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
196 """Lists single-key shortcuts available."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
197 result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in self.shortcuts.items())
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
198 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
199
94
414a78c16ce9 fixed paren bug in terminatorPattern resultsName
catherine@dellzilla
parents: 91
diff changeset
200 terminatorPattern = ((pyparsing.Literal(';') ^ pyparsing.Literal('\n\n'))
414a78c16ce9 fixed paren bug in terminatorPattern resultsName
catherine@dellzilla
parents: 91
diff changeset
201 ^ (pyparsing.Literal('\nEOF') + pyparsing.lineEnd))('terminator')
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
202 argSeparatorPattern = pyparsing.Word(pyparsing.printables)('command') \
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
203 + pyparsing.SkipTo(pyparsing.StringEnd())('args')
88
bd0adc37f3cc added characters to legitimate filename contents
catherine.devlin@gmail.com
parents: 84
diff changeset
204 filenamePattern = pyparsing.Word(pyparsing.alphanums + '#$-_~{},.!:\\/')
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
205 integerPattern = pyparsing.Word(pyparsing.nums).setParseAction( lambda s,l,t: [ int(t[0]) ] )
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
206 pipePattern = pyparsing.Literal('|')('pipe') + pyparsing.restOfLine('pipeTo')
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
207 redirectOutPattern = (pyparsing.Literal('>>') ^ '>')('output') \
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
208 + pyparsing.Optional(filenamePattern)('outputTo')
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
209 redirectInPattern = pyparsing.Literal('<')('input') \
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
210 + pyparsing.Optional(filenamePattern)('inputFrom')
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
211 punctuationPattern = pipePattern ^ redirectInPattern ^ redirectOutPattern
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
212 for p in (terminatorPattern, pipePattern, redirectInPattern, redirectOutPattern, punctuationPattern):
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
213 p.ignore(pyparsing.sglQuotedString)
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
214 p.ignore(pyparsing.dblQuotedString)
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
215
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
216 def parsed(self, s):
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
217 '''
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
218 >>> c = Cmd()
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
219 >>> r = c.parsed('quotes "are > ignored" < inp.txt')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
220 >>> r.statement, r.input, r.inputFrom, r.output, r.outputFrom
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
221 ('quotes "are > ignored" ', '<', 'inp.txt', '', '')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
222 >>> r = c.parsed('very complex; < from.txt >> to.txt etc.')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
223 >>> r.statement, r.terminator, r.input, r.inputFrom, r.output, r.outputTo
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
224 ('very complex;', ';', '<', 'from.txt', '>>', 'to.txt')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
225 >>> c.parsed('nothing to parse').statement
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
226 'nothing to parse'
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
227 >>> r = c.parsed('ignore > within a terminated statement; > out.txt')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
228 >>> r.statement, r.terminator, r.input, r.inputFrom, r.output, r.outputTo
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
229 ('ignore > within a terminated statement;', ';', '', '', '>', 'out.txt')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
230 >>> r = c.parsed('send it to | sort | wc')
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
231 >>> r.statement, r.pipe, r.pipeTo
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
232 ('send it to ', '|', ' sort | wc')
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
233 >>> r = c.parsed('got from < thisfile.txt plus blah blah')
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
234 >>> r.statement, r.input, r.inputFrom
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
235 ('got from ', '<', 'thisfile.txt')
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
236 '''
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
237 if isinstance(s, pyparsing.ParseResults):
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
238 return s
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
239 result = (pyparsing.SkipTo(pyparsing.StringEnd()))('fullStatement').parseString(s)
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
240 command = s.split()[0]
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
241 if self.caseInsensitive:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
242 command = command.lower()
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
243 '''if command in self.noSpecialParse:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
244 result['statement'] = result['upToIncluding'] = result['unterminated'] = result.fullStatement
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
245 result['command'] = command
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
246 result['args'] = ' '.join(result.fullStatement.split()[1:])
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
247 return result'''
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
248 if s[0] in self.shortcuts:
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
249 s = self.shortcuts[s[0]] + ' ' + s[1:]
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
250 result['statement'] = s
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
251 result['parseable'] = s
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
252 result += parseSearchResults(self.terminatorPattern, s)
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
253 if result.terminator:
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
254 result['statement'] = result.upToIncluding
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
255 result['unterminated'] = result.before
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
256 result['parseable'] = result.after
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
257 else:
82
bbf0afc6868b new parseResults working
catherine@Elli.myhome.westell.com
parents: 81
diff changeset
258 result += parseSearchResults(self.punctuationPattern, s)
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
259 result['statement'] = result['unterminated'] = result.before
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
260 result += parseSearchResults(self.pipePattern, result.parseable)
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
261 result += parseSearchResults(self.redirectInPattern, result.parseable)
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
262 result += parseSearchResults(self.redirectOutPattern, result.parseable)
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
263 result += parseSearchResults(self.argSeparatorPattern, result.statement)
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
264 if self.caseInsensitive:
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
265 result['command'] = result.command.lower()
81
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
266 result['statement'] = '%s %s' % (result.command, result.args)
a3b0ef23146f trying to parseResults
catherine@Elli.myhome.westell.com
parents: 80
diff changeset
267 return result
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
268
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
269 def extractCommand(self, statement):
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
270 try:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
271 (command, args) = statement.split(None,1)
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
272 except ValueError:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
273 (command, args) = statement, ''
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
274 if self.caseInsensitive:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
275 command = command.lower()
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
276 return command, args
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
277
44
b66372883bb4 marked to v 0.3.3
catherine@cordelia
parents: 43
diff changeset
278 def onecmd(self, line, assumeComplete=False):
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
279 """Interpret the argument as though it had been typed in response
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
280 to the prompt.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
281
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
282 This may be overridden, but should not normally need to be;
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
283 see the precmd() and postcmd() methods for useful execution hooks.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
284 The return value is a flag indicating whether interpretation of
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
285 commands by the interpreter should stop.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
286
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
287 """
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
288 line = line.strip()
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
289 if not line:
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
290 return
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
291 statement = self.parsed(line)
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
292 while (statement.command in self.multilineCommands) and not \
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
293 (statement.terminator or assumeComplete):
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
294 statement = self.parsed('%s\n%s' % (statement.fullStatement,
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
295 self.pseudo_raw_input(self.continuationPrompt)))
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
296
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
297 statekeeper = None
25
6948d1f9e4b4 missing xclip half-working
catherine@localhost
parents: 24
diff changeset
298 stop = 0
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
299 if statement.input:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
300 if statement.inputFrom:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
301 try:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
302 newinput = open(statement.inputFrom, 'r').read()
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
303 except OSError, e:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
304 print e
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
305 return 0
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
306 else:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
307 newinput = getPasteBuffer()
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
308 start, end = self.redirectInPattern.scanString(statement.fullStatement).next()[1:]
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
309 return self.onecmd('%s%s%s' % (statement.fullStatement[:start],
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
310 newinput, statement.fullStatement[end:]))
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
311 if statement.pipe and statement.pipeTo:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
312 redirect = subprocess.Popen(statement.pipeTo, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE)
51
26e33f64f68e trying new unified pipe and redirect
catherine@localhost
parents: 50
diff changeset
313 statekeeper = Statekeeper(self, ('stdout',))
47
927bc07467de fixed misfind of editor
catherine@cordelia
parents: 46
diff changeset
314 self.stdout = redirect.stdin
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
315 elif statement.output:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
316 statekeeper = Statekeeper(self, ('stdout',))
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
317 if statement.outputTo:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
318 mode = 'w'
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
319 if statement.output == '>>':
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
320 mode = 'a'
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
321 try:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
322 self.stdout = open(statement.outputTo, mode)
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
323 except OSError, e:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
324 print e
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
325 return 0
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
326 else:
51
26e33f64f68e trying new unified pipe and redirect
catherine@localhost
parents: 50
diff changeset
327 statekeeper = Statekeeper(self, ('stdout',))
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
328 self.stdout = tempfile.TemporaryFile()
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
329 if statement.output == '>>':
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
330 self.stdout.write(getPasteBuffer())
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
331 stop = cmd.Cmd.onecmd(self, statement.statement)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
332 try:
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
333 if statement.command not in self.excludeFromHistory:
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
334 self.history.append(statement.fullStatement)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
335 finally:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
336 if statekeeper:
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
337 if statement.output and not statement.outputTo:
27
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
338 self.stdout.seek(0)
a76798cde34c hooray, pasting working in windows
catherine@cordelia
parents: 26
diff changeset
339 writeToPasteBuffer(self.stdout.read())
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
340 elif statement.pipe:
52
49de899a05a8 new unified pipe and redirect works on wc
catherine@localhost
parents: 51
diff changeset
341 for result in redirect.communicate():
49de899a05a8 new unified pipe and redirect works on wc
catherine@localhost
parents: 51
diff changeset
342 statekeeper.stdout.write(result or '')
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
343 self.stdout.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
344 statekeeper.restore()
52
49de899a05a8 new unified pipe and redirect works on wc
catherine@localhost
parents: 51
diff changeset
345
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
346 return stop
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
347
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
348 def pseudo_raw_input(self, prompt):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
349 """copied from cmd's cmdloop; like raw_input, but accounts for changed stdin, stdout"""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
350
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
351 if self.use_rawinput:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
352 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
353 line = raw_input(prompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
354 except EOFError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
355 line = 'EOF'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
356 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
357 self.stdout.write(prompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
358 self.stdout.flush()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
359 line = self.stdin.readline()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
360 if not len(line):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
361 line = 'EOF'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
362 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
363 if line[-1] == '\n': # this was always true in Cmd
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
364 line = line[:-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
365 return line
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
366
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
367 def cmdloop(self, intro=None):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
368 """Repeatedly issue a prompt, accept input, parse an initial prefix
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
369 off the received input, and dispatch to action methods, passing them
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
370 the remainder of the line as argument.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
371 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
372
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
373 # An almost perfect copy from Cmd; however, the pseudo_raw_input portion
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
374 # has been split out so that it can be called separately
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
375
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
376 self.preloop()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
377 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
378 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
379 import readline
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
380 self.old_completer = readline.get_completer()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
381 readline.set_completer(self.complete)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
382 readline.parse_and_bind(self.completekey+": complete")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
383 except ImportError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
384 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
385 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
386 if intro is not None:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
387 self.intro = intro
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
388 if self.intro:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
389 self.stdout.write(str(self.intro)+"\n")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
390 stop = None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
391 while not stop:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
392 if self.cmdqueue:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
393 line = self.cmdqueue.pop(0)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
394 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
395 line = self.pseudo_raw_input(self.prompt)
103
e4daf715fc31 echo on
catherine@dellzilla
parents: 100
diff changeset
396 if (self.echo) and (isinstance(self.stdin, file)):
e4daf715fc31 echo on
catherine@dellzilla
parents: 100
diff changeset
397 self.stdout.write(line + '\n')
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
398 line = self.precmd(line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
399 stop = self.onecmd(line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
400 stop = self.postcmd(stop, line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
401 self.postloop()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
402 finally:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
403 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
404 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
405 import readline
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
406 readline.set_completer(self.old_completer)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
407 except ImportError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
408 pass
43
e03a8c03ac37 command-line args working
catherine@cordelia
parents: 42
diff changeset
409 return stop
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
410
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
411 def do_EOF(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
412 return True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
413 do_eof = do_EOF
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
414
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
415 def clean(self, s):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
416 """cleans up a string"""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
417 if self.caseInsensitive:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
418 return s.strip().lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
419 return s.strip()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
420
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
421 def showParam(self, param):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
422 param = self.clean(param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
423 if param in self.settable:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
424 val = getattr(self, param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
425 self.stdout.write('%s: %s\n' % (param, str(getattr(self, param))))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
426
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
427 def do_quit(self, arg):
43
e03a8c03ac37 command-line args working
catherine@cordelia
parents: 42
diff changeset
428 return self._STOP_AND_EXIT
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
429 do_exit = do_quit
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
430 do_q = do_quit
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
431
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
432 def do_show(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
433 'Shows value of a parameter'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
434 if arg.strip():
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
435 self.showParam(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
436 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
437 for param in self.settable:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
438 self.showParam(param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
439
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
440 def do_set(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
441 'Sets a parameter'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
442 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
443 paramName, val = arg.split(None, 1)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
444 paramName = self.clean(paramName)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
445 if paramName not in self.settable:
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
446 raise NotSettableError
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
447 currentVal = getattr(self, paramName)
106
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
448 if (val[0] == val[-1]) and val[0] in ("'", '"'):
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
449 val = val[1:-1]
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
450 else:
2d3232693807 prompt-setting quirks
catherine@dellzilla
parents: 105
diff changeset
451 val = cast(currentVal, self.parsed(val).unterminated)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
452 setattr(self, paramName, val)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
453 self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
454 except (ValueError, AttributeError, NotSettableError), e:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
455 self.do_show(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
456
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
457 def do_shell(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
458 'execute a command as if at the OS prompt.'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
459 os.system(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
460
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
461 def do_history(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
462 """history [arg]: lists past commands issued
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
463
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
464 no arg -> list all
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
465 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
466 arg is string -> string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
467 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
468 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
469 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
470 history = self.history.get(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
471 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
472 history = self.history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
473 for hi in history:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
474 self.stdout.write(hi.pr())
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
475 def last_matching(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
476 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
477 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
478 return self.history.get(arg)[-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
479 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
480 return self.history[-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
481 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
482 return None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
483 def do_list(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
484 """list [arg]: lists last command issued
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
485
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
486 no arg -> list absolute last
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
487 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
488 - arg, arg - (integer) -> list up to or after #arg
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
489 arg is string -> list last command matching string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
490 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
491 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
492 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
493 self.stdout.write(self.last_matching(arg).pr())
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
494 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
495 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
496 do_hi = do_history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
497 do_l = do_list
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
498 do_li = do_list
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
499
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
500 def do_ed(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
501 """ed: edit most recent command in text editor
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
502 ed [N]: edit numbered command from history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
503 ed [filename]: edit specified file name
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
504
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
505 commands are run after editor is closed.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
506 "set edit (program-name)" or set EDITOR environment variable
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
507 to control which editing program is used."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
508 if not self.editor:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
509 print "please use 'set editor' to specify your text editing program of choice."
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
510 return
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
511 filename = self.defaultFileName
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
512 buffer = ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
513 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
514 arg = int(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
515 buffer = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
516 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
517 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
518 filename = arg
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
519 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
520 buffer = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
521
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
522 if buffer:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
523 f = open(filename, 'w')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
524 f.write(buffer or '')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
525 f.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
526
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
527 os.system('%s %s' % (self.editor, filename))
48
34fb41095451 avoiding do_load overload
catherine.devlin@gmail.com
parents: 47
diff changeset
528 self.do__load(filename)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
529 do_edit = do_ed
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
530
91
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
531 saveparser = (pyparsing.Optional(pyparsing.Word(pyparsing.nums)^'*')("idx") +
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
532 pyparsing.Optional(pyparsing.Word(pyparsing.printables))("fname") +
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
533 pyparsing.stringEnd)
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
534 def do_save(self, arg):
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
535 """`save [N] [filename.ext]`
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
536 Saves command from history to file.
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
537 N => Number of command (from history), or `*`;
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
538 most recent command if omitted"""
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
539
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
540 try:
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
541 args = self.saveparser.parseString(arg)
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
542 except pyparsing.ParseException:
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
543 print self.do_save.__doc__
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
544 return
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
545 fname = args.fname or self.defaultFileName
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
546 if args.idx == '*':
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
547 saveme = '\n\n'.join(self.history[:])
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
548 elif args.idx:
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
549 saveme = self.history[int(args.idx)-1]
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
550 else:
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
551 saveme = self.history[-1]
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
552 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
553 f = open(fname, 'w')
91
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
554 f.write(saveme)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
555 f.close()
91
88f2aa240af1 added to save
catherine@Elli.myhome.westell.com
parents: 90
diff changeset
556 print 'Saved to %s' % (fname)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
557 except Exception, e:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
558 print 'Error saving %s: %s' % (fname, str(e))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
559
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
560 def do_load(self, fname=None):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
561 """Runs command(s) from a file."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
562 if fname is None:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
563 fname = self.defaultFileName
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
564 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuationPrompt'))
41
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
565 if isinstance(fname, file):
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
566 self.stdin = fname
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
567 else:
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
568 try:
41
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
569 self.stdin = open(fname, 'r')
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
570 except IOError, e:
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
571 try:
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
572 self.stdin = open('%s.%s' % (fname, self.defaultExtension), 'r')
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
573 except IOError:
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
574 print 'Problem opening file %s: \n%s' % (fname, e)
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
575 keepstate.restore()
1275d59c08a7 do_load accepts file object
catherine@cordelia
parents: 39
diff changeset
576 return
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
577 self.use_rawinput = False
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
578 self.prompt = self.continuationPrompt = ''
42
b3200c6e5763 inserting exception for quit...
catherine@cordelia
parents: 41
diff changeset
579 stop = self.cmdloop()
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
580 self.stdin.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
581 keepstate.restore()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
582 self.lastcmd = ''
48
34fb41095451 avoiding do_load overload
catherine.devlin@gmail.com
parents: 47
diff changeset
583 return (stop == self._STOP_AND_EXIT) and self._STOP_AND_EXIT
34fb41095451 avoiding do_load overload
catherine.devlin@gmail.com
parents: 47
diff changeset
584 do__load = do_load # avoid an unfortunate legacy use of do_load from sqlpython
43
e03a8c03ac37 command-line args working
catherine@cordelia
parents: 42
diff changeset
585
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
586 def do_run(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
587 """run [arg]: re-runs an earlier command
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
588
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
589 no arg -> run most recent command
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
590 arg is integer -> run one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
591 arg is string -> run most recent command by string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
592 arg is /enclosed in forward-slashes/ -> run most recent by regex
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
593 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
594 'run [N]: runs the SQL that was run N commands ago'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
595 runme = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
596 print runme
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
597 if runme:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
598 runme = self.precmd(runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
599 stop = self.onecmd(runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
600 stop = self.postcmd(stop, runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
601 do_r = do_run
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
602
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
603 def fileimport(self, statement, source):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
604 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
605 f = open(source)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
606 except IOError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
607 self.stdout.write("Couldn't read from file %s\n" % source)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
608 return ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
609 data = f.read()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
610 f.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
611 return data
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
612
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
613 class HistoryItem(str):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
614 def __init__(self, instr):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
615 str.__init__(self, instr)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
616 self.lowercase = self.lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
617 self.idx = None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
618 def pr(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
619 return '-------------------------[%d]\n%s\n' % (self.idx, str(self))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
620
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
621 class History(list):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
622 rangeFrom = re.compile(r'^([\d])+\s*\-$')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
623 def append(self, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
624 new = HistoryItem(new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
625 list.append(self, new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
626 new.idx = len(self)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
627 def extend(self, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
628 for n in new:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
629 self.append(n)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
630 def get(self, getme):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
631 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
632 getme = int(getme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
633 if getme < 0:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
634 return self[:(-1 * getme)]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
635 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
636 return [self[getme-1]]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
637 except IndexError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
638 return []
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
639 except (ValueError, TypeError):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
640 getme = getme.strip()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
641 mtch = self.rangeFrom.search(getme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
642 if mtch:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
643 return self[(int(mtch.group(1))-1):]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
644 if getme.startswith(r'/') and getme.endswith(r'/'):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
645 finder = re.compile(getme[1:-1], re.DOTALL | re.MULTILINE | re.IGNORECASE)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
646 def isin(hi):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
647 return finder.search(hi)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
648 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
649 def isin(hi):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
650 return (getme.lower() in hi.lowercase)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
651 return [itm for itm in self if isin(itm)]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
652
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
653 class NotSettableError(Exception):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
654 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
655
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
656 def cast(current, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
657 """Tries to force a new value into the same type as the current."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
658 typ = type(current)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
659 if typ == bool:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
660 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
661 return bool(int(new))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
662 except ValueError, TypeError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
663 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
664 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
665 new = new.lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
666 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
667 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
668 if (new=='on') or (new[0] in ('y','t')):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
669 return True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
670 if (new=='off') or (new[0] in ('n','f')):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
671 return False
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
672 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
673 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
674 return typ(new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
675 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
676 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
677 print "Problem setting parameter (now %s) to %s; incorrect type?" % (current, new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
678 return current
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
679
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
680 class Statekeeper(object):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
681 def __init__(self, obj, attribs):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
682 self.obj = obj
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
683 self.attribs = attribs
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
684 self.save()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
685 def save(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
686 for attrib in self.attribs:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
687 setattr(self, attrib, getattr(self.obj, attrib))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
688 def restore(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
689 for attrib in self.attribs:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
690 setattr(self.obj, attrib, getattr(self, attrib))
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
691
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
692 class Borg(object):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
693 '''All instances of any Borg subclass will share state.
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
694 from Python Cookbook, 2nd Ed., recipe 6.16'''
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
695 _shared_state = {}
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
696 def __new__(cls, *a, **k):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
697 obj = object.__new__(cls, *a, **k)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
698 obj.__dict__ = cls._shared_state
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
699 return obj
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
700
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
701 class OutputTrap(Borg):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
702 '''Instantiate an OutputTrap to divert/capture ALL stdout output. For use in unit testing.
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
703 Call `tearDown()` to return to normal output.'''
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
704 def __init__(self):
105
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
705 self.old_stdout = sys.stdout
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
706 self.trap = tempfile.TemporaryFile()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
707 sys.stdout = self.trap
105
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
708 def read(self):
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
709 self.trap.seek(0)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
710 result = self.trap.read()
105
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
711 self.trap.truncate(0)
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
712 return result.strip('\x00')
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
713 def tearDown(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
714 sys.stdout = self.old_stdout
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
715
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
716 class TranscriptReader(object):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
717 def __init__(self, cmdapp, filename='test_cmd2.txt'):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
718 self.cmdapp = cmdapp
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
719 try:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
720 tfile = open(filename)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
721 self.transcript = tfile.read()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
722 tfile.close()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
723 except IOError:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
724 self.transcript = ''
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
725 self.bookmark = 0
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
726 def refreshCommandFinder(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
727 prompt = pyparsing.Suppress(pyparsing.lineStart + self.cmdapp.prompt)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
728 continuationPrompt = pyparsing.Suppress(pyparsing.lineStart + self.cmdapp.continuationPrompt)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
729 self.cmdtxtPattern = (prompt + pyparsing.restOfLine + pyparsing.ZeroOrMore(
108
f7b0152c57f9 cmd2 test working
catherine@dellzilla
parents: 107
diff changeset
730 pyparsing.lineEnd + continuationPrompt + pyparsing.restOfLine))("command")
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
731 def inputGenerator(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
732 while True:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
733 self.refreshCommandFinder()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
734 (thiscmd, startpos, endpos) = self.cmdtxtPattern.scanString(self.transcript[self.bookmark:], maxMatches=1).next()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
735 lineNum = self.transcript.count('\n', 0, self.bookmark+startpos) + 2
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
736 self.bookmark += endpos
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
737 yield (''.join(thiscmd.command), lineNum)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
738 def nextExpected(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
739 self.refreshCommandFinder()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
740 try:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
741 (thiscmd, startpos, endpos) = self.cmdtxtPattern.scanString(self.transcript[self.bookmark:], maxMatches=1).next()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
742 result = self.transcript[self.bookmark:self.bookmark+startpos]
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
743 self.bookmark += startpos
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
744 return result
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
745 except StopIteration:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
746 return self.transcript[self.bookmark:]
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
747
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
748 class Cmd2TestCase(unittest.TestCase):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
749 '''Subclass this, setting CmdApp and transcriptFileName, to make a unittest.TestCase class
109
78c4db4c2045 all done but the proper packaging
catherine@dellzilla
parents: 108
diff changeset
750 that will execute the commands in transcriptFileName and expect the results shown.
78c4db4c2045 all done but the proper packaging
catherine@dellzilla
parents: 108
diff changeset
751 See example.py'''
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
752 # problem: this (raw) case gets called by unittest.main - we don't want it to be. hmm
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
753 CmdApp = None
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
754 transcriptFileName = ''
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
755 def setUp(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
756 if self.CmdApp:
105
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
757 self.outputTrap = OutputTrap()
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
758 self.cmdapp = self.CmdApp()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
759 self.transcriptReader = TranscriptReader(self.cmdapp, self.transcriptFileName)
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
760 def testall(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
761 if self.CmdApp:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
762 for (cmdInput, lineNum) in self.transcriptReader.inputGenerator():
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
763 self.cmdapp.onecmd(cmdInput)
105
130340609e19 testing beginning to work?
catherine@dellzilla
parents: 104
diff changeset
764 result = self.outputTrap.read()
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
765 expected = self.transcriptReader.nextExpected()
107
3e2651cbe376 vigorous whitespace stripping from test results
catherine@dellzilla
parents: 106
diff changeset
766 self.assertEqual(self.stripByLine(result), self.stripByLine(expected),
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
767 '\nFile %s, line %d\nCommand was:\n%s\nExpected:\n%s\nGot:\n%s\n' %
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
768 (self.transcriptFileName, lineNum, cmdInput, expected, result))
107
3e2651cbe376 vigorous whitespace stripping from test results
catherine@dellzilla
parents: 106
diff changeset
769 def stripByLine(self, s):
3e2651cbe376 vigorous whitespace stripping from test results
catherine@dellzilla
parents: 106
diff changeset
770 lines = s.splitlines()
3e2651cbe376 vigorous whitespace stripping from test results
catherine@dellzilla
parents: 106
diff changeset
771 return '\n'.join(line.rstrip() for line in lines).strip()
104
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
772 def tearDown(self):
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
773 if self.CmdApp:
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
774 self.outputTrap.tearDown()
bd91925d813c having a hard time capturing stdout
catherine@dellzilla
parents: 103
diff changeset
775
79
f583663c610f switch to pyparsing worked
catherine@Elli.myhome.westell.com
parents: 56
diff changeset
776 if __name__ == '__main__':
83
2176ce847939 merged copy to both clipboards in
catherine@Elli.myhome.westell.com
parents: 82
diff changeset
777 doctest.testmod()