python-cmd2: cmd2.py annotate

annotate cmd2.py @ 3:4520a1a073ff

require terminator for redirection

author	catherine@cordelia
date	Tue, 13 May 2008 08:29:18 -0400
parents	1ea887b51cad
children	78033fd1078d

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

Mercurial > python-cmd2

annotate cmd2.py @ 3:4520a1a073ff