annotate cmd2.py @ 20:c8efa4369189

fixes to option parsing
author catherine@cordelia
date Thu, 15 May 2008 17:38:15 -0400
parents 0eb8d4e18472
children 82dde2f60e46 e72eb9137a87
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
14
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
15 - Catherine Devlin, Jan 03 2008 - catherinedevlin.blogspot.com
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
16
14
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
17 CHANGES:
a242603905d9 ready to release 0.3.0
catherine@localhost
parents: 13
diff changeset
18 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
19 flagReader.py options are still supported for backward compatibility
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
20 """
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
21 import cmd, re, os, sys, optparse
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
22 from optparse import make_option
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
23
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
24 class OptionParser(optparse.OptionParser):
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
25 def exit(self, status=0, msg=None):
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
26 if msg:
15
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
27 print msg
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
28
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
29 def error(self, msg):
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
30 """error(msg : string)
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
31
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
32 Print a usage message incorporating 'msg' to stderr and exit.
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
33 If you override this in a subclass, it should not return -- it
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
34 should either exit or raise an exception.
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
35 """
15
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
36 #print msg
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
37 #print self.format_help()
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
38 raise
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
39
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
40 def options(option_list):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
41 def option_setup(func):
11
34107b79c840 working the refactor still
catherine@localhost
parents: 10
diff changeset
42 optionParser = OptionParser()
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
43 for opt in option_list:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
44 optionParser.add_option(opt)
12
catherine@localhost
parents: 11
diff changeset
45 optionParser.set_usage("%s [options] arg" % func.__name__.strip('do_'))
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
46 def newFunc(instance, arg):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
47 try:
20
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
48 opts, arg = optionParser.parse_args(arg.split())
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
49 arg = ' '.join(arg)
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
50 except (optparse.OptionValueError, optparse.BadOptionError,
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
51 optparse.OptionError, optparse.AmbiguousOptionError,
c8efa4369189 fixes to option parsing
catherine@cordelia
parents: 15
diff changeset
52 optparse.OptionConflictError), e:
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
53 print e
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
54 optionParser.print_help()
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
55 return
15
0eb8d4e18472 fixed error handling
catherine@localhost
parents: 14
diff changeset
56 result = func(instance, arg, opts)
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
57 return result
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
58 newFunc.__doc__ = '%s\n%s' % (func.__doc__, optionParser.format_help())
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
59 return newFunc
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
60 return option_setup
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
61
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
62 class Cmd(cmd.Cmd):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
63 caseInsensitive = True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
64 multilineCommands = []
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
65 continuationPrompt = '> '
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
66 shortcuts = {'?': 'help', '!': 'shell', '@': 'load'}
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
67 excludeFromHistory = '''run r list l history hi ed li eof'''.split()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
68 defaultExtension = 'txt'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
69 defaultFileName = 'command.txt'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
70 editor = os.environ.get('EDITOR')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
71 if not editor:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
72 if sys.platform[:3] == 'win':
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
73 editor = 'notepad'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
74 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
75 for editor in ['gedit', 'kate', 'vim', 'emacs', 'nano', 'pico']:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
76 if not os.system('which %s' % (editor)):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
77 break
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
78
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
79 settable = ['prompt', 'continuationPrompt', 'defaultFileName', 'editor', 'caseInsensitive']
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
80 terminators = ';\n'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
81 def do_cmdenvironment(self, args):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
82 self.stdout.write("""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
83 Commands are %(casesensitive)scase-sensitive.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
84 Commands may be terminated with: %(terminators)s
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
85 Settable parameters: %(settable)s
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
86 """ %
2
1ea887b51cad python 2.4 compatibility
catherine@DellZilla.myhome.westell.com
parents: 0
diff changeset
87 { 'casesensitive': ('not ' and self.caseInsensitive) or '',
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
88 'terminators': ' '.join(self.terminators),
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
89 'settable': ' '.join(self.settable)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
90 })
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
91
10
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
92 def do_help(self, arg):
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
93 cmd.Cmd.do_help(self, arg)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
94 try:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
95 fn = getattr(self, 'do_' + arg)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
96 if fn and fn.optionParser:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
97 fn.optionParser.print_help(file=self.stdout)
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
98 except AttributeError:
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
99 pass
47af95ad83c7 working the refactor still
catherine@localhost
parents: 4
diff changeset
100
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
101 def __init__(self, *args, **kwargs):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
102 cmd.Cmd.__init__(self, *args, **kwargs)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
103 self.history = History()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
104
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
105 def do_shortcuts(self, args):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
106 """Lists single-key shortcuts available."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
107 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
108 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
109
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
110 legalFileName = re.compile(r'''^[^"'\s]+$''')
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
111 def parseRedirector(self, statement, symbol, mustBeTerminated=False):
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
112 parts = statement.split(symbol)
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
113 if (len(parts) < 2):
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
114 return statement, None
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
115 if mustBeTerminated and (parts[-2].strip()[-1] not in self.terminators):
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
116 return statement, None
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
117 (newStatement, redirect) = (symbol.join(parts[:-1]), parts[-1].strip())
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
118 if not self.legalFileName.search(redirect):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
119 return statement, None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
120 return newStatement, redirect
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
121
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
122 def extractCommand(self, statement):
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
123 try:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
124 (command, args) = statement.split(None,1)
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
125 except ValueError:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
126 (command, args) = statement, ''
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
127 if self.caseInsensitive:
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
128 command = command.lower()
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
129 return command, args
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
130
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
131 def parseRedirectors(self, statement):
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
132 mustBeTerminated = self.extractCommand(statement)[0] in self.multilineCommands
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
133 newStatement, redirect = self.parseRedirector(statement, '>>', mustBeTerminated)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
134 if redirect:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
135 return newStatement, redirect, 'a'
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
136 newStatement, redirect = self.parseRedirector(statement, '>', mustBeTerminated)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
137 if redirect:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
138 return newStatement, redirect, 'w'
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
139 newStatement, redirect = self.parseRedirector(statement, '<', mustBeTerminated)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
140 if redirect:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
141 return newStatement, redirect, 'r'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
142 return statement, '', ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
143
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
144 def onecmd(self, line):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
145 """Interpret the argument as though it had been typed in response
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
146 to the prompt.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
147
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
148 This may be overridden, but should not normally need to be;
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
149 see the precmd() and postcmd() methods for useful execution hooks.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
150 The return value is a flag indicating whether interpretation of
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
151 commands by the interpreter should stop.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
152
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
153 """
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
154 command, args = self.extractCommand(line)
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
155 statement = ' '.join([command, args])
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
156 if command in self.multilineCommands:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
157 statement = self.finishStatement(statement)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
158 statekeeper = None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
159 statement, redirect, mode = self.parseRedirectors(statement)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
160 if redirect:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
161 if mode in ('w','a'):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
162 statekeeper = Statekeeper(self, ('stdout',))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
163 self.stdout = open(redirect, mode)
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 statement = '%s %s' % (statement, self.fileimport(statement=statement, source=redirect))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
166 stop = cmd.Cmd.onecmd(self, statement)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
167 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
168 if command not in self.excludeFromHistory:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
169 self.history.append(statement)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
170 finally:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
171 if statekeeper:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
172 self.stdout.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
173 statekeeper.restore()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
174 return stop
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
175
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
176 statementEndPattern = re.compile(r'[%s]\s*$' % terminators)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
177 def statementHasEnded(self, lines):
3
4520a1a073ff require terminator for redirection
catherine@cordelia
parents: 2
diff changeset
178 #import pdb; pdb.set_trace()
0
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
179 return bool(self.statementEndPattern.search(lines)) \
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
180 or lines[-3:] == 'EOF' \
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
181 or self.parseRedirectors(lines)[1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
182
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
183 def finishStatement(self, firstline):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
184 statement = firstline
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
185 while not self.statementHasEnded(statement):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
186 inp = self.pseudo_raw_input(self.continuationPrompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
187 statement = '%s\n%s' % (statement, inp)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
188 return statement
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
189 # assembling a list of lines and joining them at the end would be faster,
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
190 # but statementHasEnded needs a string arg; anyway, we're getting
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
191 # user input and users are slow.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
192
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
193 def pseudo_raw_input(self, prompt):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
194 """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
195
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
196 if self.use_rawinput:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
197 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
198 line = raw_input(prompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
199 except EOFError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
200 line = 'EOF'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
201 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
202 self.stdout.write(prompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
203 self.stdout.flush()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
204 line = self.stdin.readline()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
205 if not len(line):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
206 line = 'EOF'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
207 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
208 if line[-1] == '\n': # this was always true in Cmd
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
209 line = line[:-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
210 return line
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
211
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
212 def cmdloop(self, intro=None):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
213 """Repeatedly issue a prompt, accept input, parse an initial prefix
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
214 off the received input, and dispatch to action methods, passing them
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
215 the remainder of the line as argument.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
216 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
217
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
218 # 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
219 # has been split out so that it can be called separately
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
220
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
221 self.preloop()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
222 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
223 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
224 import readline
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
225 self.old_completer = readline.get_completer()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
226 readline.set_completer(self.complete)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
227 readline.parse_and_bind(self.completekey+": complete")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
228 except ImportError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
229 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
230 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
231 if intro is not None:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
232 self.intro = intro
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
233 if self.intro:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
234 self.stdout.write(str(self.intro)+"\n")
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
235 stop = None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
236 while not stop:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
237 if self.cmdqueue:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
238 line = self.cmdqueue.pop(0)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
239 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
240 line = self.pseudo_raw_input(self.prompt)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
241 line = self.precmd(line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
242 stop = self.onecmd(line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
243 stop = self.postcmd(stop, line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
244 self.postloop()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
245 finally:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
246 if self.use_rawinput and self.completekey:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
247 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
248 import readline
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
249 readline.set_completer(self.old_completer)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
250 except ImportError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
251 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
252
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
253 def do_EOF(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
254 return True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
255 do_eof = do_EOF
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
256
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
257 def clean(self, s):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
258 """cleans up a string"""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
259 if self.caseInsensitive:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
260 return s.strip().lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
261 return s.strip()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
262
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
263 def parseline(self, line):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
264 """Parse the line into a command name and a string containing
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
265 the arguments. Returns a tuple containing (command, args, line).
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
266 'command' and 'args' may be None if the line couldn't be parsed.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
267 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
268 line = line.strip()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
269 if not line:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
270 return None, None, line
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
271 shortcut = self.shortcuts.get(line[0])
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
272 if shortcut and hasattr(self, 'do_%s' % shortcut):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
273 line = '%s %s' % (shortcut, line[1:])
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
274 i, n = 0, len(line)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
275 while i < n and line[i] in self.identchars: i = i+1
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
276 cmd, arg = line[:i], line[i:].strip().strip(self.terminators)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
277 return cmd, arg, line
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
278
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
279 def showParam(self, param):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
280 param = self.clean(param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
281 if param in self.settable:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
282 val = getattr(self, param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
283 self.stdout.write('%s: %s\n' % (param, str(getattr(self, param))))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
284
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
285 def do_quit(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
286 return 1
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
287 do_exit = do_quit
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
288 do_q = do_quit
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
289
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
290 def do_show(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
291 'Shows value of a parameter'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
292 if arg.strip():
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
293 self.showParam(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
294 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
295 for param in self.settable:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
296 self.showParam(param)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
297
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
298 def do_set(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
299 'Sets a parameter'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
300 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
301 paramName, val = arg.split(None, 1)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
302 paramName = self.clean(paramName)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
303 if paramName not in self.settable:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
304 raise NotSettableError
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
305 currentVal = getattr(self, paramName)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
306 val = cast(currentVal, val.strip(self.terminators))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
307 setattr(self, paramName, val)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
308 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
309 except (ValueError, AttributeError, NotSettableError), e:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
310 self.do_show(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
311
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
312 def do_shell(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
313 'execute a command as if at the OS prompt.'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
314 os.system(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
315
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
316 def do_history(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
317 """history [arg]: lists past commands issued
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
318
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
319 no arg -> list all
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
320 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
321 arg is string -> string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
322 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
323 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
324 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
325 history = self.history.get(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
326 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
327 history = self.history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
328 for hi in history:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
329 self.stdout.write(hi.pr())
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
330 def last_matching(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
331 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
332 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
333 return self.history.get(arg)[-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
334 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
335 return self.history[-1]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
336 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
337 return None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
338 def do_list(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
339 """list [arg]: lists last command issued
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
340
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
341 no arg -> list absolute last
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
342 arg is integer -> list one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
343 - arg, arg - (integer) -> list up to or after #arg
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
344 arg is string -> list last command matching string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
345 arg is /enclosed in forward-slashes/ -> regular expression search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
346 """
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
347 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
348 self.stdout.write(self.last_matching(arg).pr())
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
349 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
350 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
351 do_hi = do_history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
352 do_l = do_list
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
353 do_li = do_list
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
354
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
355 def do_ed(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
356 """ed: edit most recent command in text editor
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
357 ed [N]: edit numbered command from history
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
358 ed [filename]: edit specified file name
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
359
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
360 commands are run after editor is closed.
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
361 "set edit (program-name)" or set EDITOR environment variable
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
362 to control which editing program is used."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
363 if not self.editor:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
364 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
365 return
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
366 filename = self.defaultFileName
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
367 buffer = ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
368 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
369 arg = int(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
370 buffer = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
371 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
372 if arg:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
373 filename = arg
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
374 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
375 buffer = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
376
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
377 if buffer:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
378 f = open(filename, 'w')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
379 f.write(buffer or '')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
380 f.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
381
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
382 os.system('%s %s' % (self.editor, filename))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
383 self.do_load(filename)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
384 do_edit = do_ed
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
385
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
386 def do_save(self, fname=None):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
387 """Saves most recent command to a file."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
388
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
389 if fname is None:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
390 fname = self.defaultFileName
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
391 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
392 f = open(fname, 'w')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
393 f.write(self.history[-1])
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
394 f.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
395 except Exception, e:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
396 print 'Error saving %s: %s' % (fname, str(e))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
397
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
398 def do_load(self, fname=None):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
399 """Runs command(s) from a file."""
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
400 if fname is None:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
401 fname = self.defaultFileName
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
402 keepstate = Statekeeper(self, ('stdin','use_rawinput','prompt','continuationPrompt'))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
403 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
404 self.stdin = open(fname, 'r')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
405 except IOError, e:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
406 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
407 self.stdin = open('%s.%s' % (fname, self.defaultExtension), 'r')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
408 except IOError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
409 print 'Problem opening file %s: \n%s' % (fname, e)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
410 keepstate.restore()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
411 return
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
412 self.use_rawinput = False
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
413 self.prompt = self.continuationPrompt = ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
414 self.cmdloop()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
415 self.stdin.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
416 keepstate.restore()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
417 self.lastcmd = ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
418
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
419 def do_run(self, arg):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
420 """run [arg]: re-runs an earlier command
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
421
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
422 no arg -> run most recent command
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
423 arg is integer -> run one history item, by index
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
424 arg is string -> run most recent command by string search
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
425 arg is /enclosed in forward-slashes/ -> run most recent by regex
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 'run [N]: runs the SQL that was run N commands ago'
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
428 runme = self.last_matching(arg)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
429 print runme
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
430 if runme:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
431 runme = self.precmd(runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
432 stop = self.onecmd(runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
433 stop = self.postcmd(stop, runme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
434 do_r = do_run
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
435
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
436 def fileimport(self, statement, source):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
437 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
438 f = open(source)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
439 except IOError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
440 self.stdout.write("Couldn't read from file %s\n" % source)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
441 return ''
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
442 data = f.read()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
443 f.close()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
444 return data
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
445
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
446 class HistoryItem(str):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
447 def __init__(self, instr):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
448 str.__init__(self, instr)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
449 self.lowercase = self.lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
450 self.idx = None
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
451 def pr(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
452 return '-------------------------[%d]\n%s\n' % (self.idx, str(self))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
453
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
454 class History(list):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
455 rangeFrom = re.compile(r'^([\d])+\s*\-$')
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
456 def append(self, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
457 new = HistoryItem(new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
458 list.append(self, new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
459 new.idx = len(self)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
460 def extend(self, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
461 for n in new:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
462 self.append(n)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
463 def get(self, getme):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
464 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
465 getme = int(getme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
466 if getme < 0:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
467 return self[:(-1 * getme)]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
468 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
469 return [self[getme-1]]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
470 except IndexError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
471 return []
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
472 except (ValueError, TypeError):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
473 getme = getme.strip()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
474 mtch = self.rangeFrom.search(getme)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
475 if mtch:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
476 return self[(int(mtch.group(1))-1):]
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
477 if getme.startswith(r'/') and getme.endswith(r'/'):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
478 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
479 def isin(hi):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
480 return finder.search(hi)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
481 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
482 def isin(hi):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
483 return (getme.lower() in hi.lowercase)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
484 return [itm for itm in self if isin(itm)]
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 class NotSettableError(Exception):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
487 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
488
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
489 def cast(current, new):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
490 """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
491 typ = type(current)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
492 if typ == bool:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
493 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
494 return bool(int(new))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
495 except ValueError, TypeError:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
496 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
497 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
498 new = new.lower()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
499 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
500 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
501 if (new=='on') or (new[0] in ('y','t')):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
502 return True
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
503 if (new=='off') or (new[0] in ('n','f')):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
504 return False
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
505 else:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
506 try:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
507 return typ(new)
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
508 except:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
509 pass
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
510 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
511 return current
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
512
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
513 class Statekeeper(object):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
514 def __init__(self, obj, attribs):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
515 self.obj = obj
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
516 self.attribs = attribs
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
517 self.save()
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
518 def save(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
519 for attrib in self.attribs:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
520 setattr(self, attrib, getattr(self.obj, attrib))
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
521 def restore(self):
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
522 for attrib in self.attribs:
febfdc79550b moved repository to Assembla
catherine@DellZilla.myhome.westell.com
parents:
diff changeset
523 setattr(self.obj, attrib, getattr(self, attrib))