python-cmd2: cmd2.py comparison

comparison cmd2.py @ 290:cd12e4e0fa17

show -l working

author	catherine@bothari
date	Fri, 06 Nov 2009 21:41:55 -0500
parents	327ace491fa9
children	dfdbd93a2fae

comparison

equal deleted inserted replaced

-:327ace491fa9
+:cd12e4e0fa17
 self.showtraceback()
 else:
 if softspace(sys.stdout, 0):
 print
+def ljust(x, width, fillchar=' '):
+'analogous to str.ljust, but works for lists'
+if hasattr(x, 'ljust'):
+return x.ljust(width, fillchar)
+else:
+if len(x) < width:
+x = (x + [fillchar] * width)[:width]
+return x
 class Cmd(cmd.Cmd):
 echo = False
 case_insensitive = True     # Commands recognized regardless of case
 continuation_prompt = '> '
 timing = False              # Prints elapsed time for each command
 current_script_dir = None
 reserved_words = []
 feedback_to_output = False          # Do include nonessentials in >, | output
 quiet = False                       # Do not suppress nonessential output
 debug = False
-settable = ['prompt', 'continuation_prompt', 'debug', 'default_file_name', 'editor',
+settable = '''
-'case_insensitive', 'feedback_to_output', 'quiet', 'echo', 'timing',
+prompt
-'abbrev']
+continuation_prompt
-settable.sort()
+debug
+default_file_name     for `save`, `load`, etc.
+editor
+case_insensitive      upper- and lower-case both OK
+feedback_to_output    include nonessentials in `|`, `>` results
+quiet
+echo                  Echo command issued into output
+timing                Report execution times
+abbrev                Accept abbreviated commands
+'''.splitlines()
 def poutput(self, msg):
 if msg:
 self.stdout.write(msg)
 if msg[-1] != '\n':
 self.history = History()
 self._init_parser()
 self.pystate = {}
 self.shortcuts = sorted(self.shortcuts.items(), reverse=True)
 self.keywords = self.reserved_words + [fname[3:] for fname in dir(self)
 if fname.startswith('do_')]
+self.settable = (l.strip() for l in self.settable if l.strip())
+self.settable = dict(ljust(l.split(None,1), 2, '') for l in self.settable)
 def do_shortcuts(self, args):
 """Lists single-key shortcuts available."""
 result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in sorted(self.shortcuts))
 self.stdout.write("Single-key shortcuts for other commands:\n%s\n" % (result))
 return stop
 def do_EOF(self, arg):
 return True
 do_eof = do_EOF
-def show_param(self, param):
-any_shown = False
-param = param.strip().lower()
-for p in self.settable:
-if p.startswith(param):
-self.stdout.write('%s: %s\n' % (p, str(getattr(self, p))))
-any_shown = True
-if not any_shown:
-self.perror("Parameter '%s' not supported (type 'show' for list of parameters)." % param)
 def do_quit(self, arg):
 return self._STOP_AND_EXIT
 do_exit = do_quit
 do_q = do_quit
-def do_show(self, arg):
+@options([make_option('-l', '--long', action="store_true",
+help="describe function of parameter")])
+def do_show(self, arg, opts):
 '''Shows value of a parameter.'''
-if arg.strip():
+param = arg.strip().lower()
-self.show_param(arg)
+result = {}
-else:
+maxlen = 0
-for param in self.settable:
+for p in self.settable:
-self.show_param(param)
+if (not param) or p.startswith(param):
+result[p] = '%s: %s' % (p, str(getattr(self, p)))
+maxlen = max(maxlen, len(result[p]))
+if result:
+for p in sorted(result):
+if opts.long:
+self.poutput('%s # %s' % (result[p].ljust(maxlen), self.settable[p]))
+else:
+self.poutput(result[p])
+else:
+self.perror("Parameter '%s' not supported (type 'show' for list of parameters)." % param)
 def do_set(self, arg):
-'''Sets a cmd2 parameter.  Accepts abbreviated parameter names so long as there is no ambiguity.
+'''
-Call without arguments for a list of settable parameters with their values.'''
+Sets a cmd2 parameter.  Accepts abbreviated parameter names so long
+as there is no ambiguity.  Call without arguments for a list of
+settable parameters with their values.'''
 try:
 paramName, val = arg.split(None, 1)
 paramName = paramName.strip().lower()
-hits = [paramName in p for p in self.settable]
+if paramName not in self.settable:
-if hits.count(True) == 1:
+hits = [p for p in self.settable if p.startswith(p)]
-paramName = self.settable[hits.index(True)]
+if len(hits) == 1:
-currentVal = getattr(self, paramName)
+paramName = hits[0]
-if (val[0] == val[-1]) and val[0] in ("'", '"'):
+else:
-val = val[1:-1]
+return self.do_show(paramName)
-else:
+currentVal = getattr(self, paramName)
-val = cast(currentVal, val)
+if (val[0] == val[-1]) and val[0] in ("'", '"'):
-setattr(self, paramName, val)
+val = val[1:-1]
-self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
+else:
-if currentVal != val:
+val = cast(currentVal, val)
-try:
+setattr(self, paramName, val)
-onchange_hook = getattr(self, '_onchange_%s' % paramName)
+self.stdout.write('%s - was: %s\nnow: %s\n' % (paramName, currentVal, val))
-onchange_hook(old=currentVal, new=val)
+if currentVal != val:
-except AttributeError:
+try:
-pass
+onchange_hook = getattr(self, '_onchange_%s' % paramName)
-else:
+onchange_hook(old=currentVal, new=val)
-self.do_show(paramName)
+except AttributeError:
+pass
 except (ValueError, AttributeError, NotSettableError), e:
 self.do_show(arg)
 def do_pause(self, arg):
 'Displays the specified text then waits for the user to press RETURN.'
 if self.CmdApp:
 self.outputTrap.tearDown()
 if __name__ == '__main__':
 doctest.testmod(optionflags = doctest.NORMALIZE_WHITESPACE)
 '''
 To make your application transcript-testable, add text like this to your .py file
 (replacing CmdLineApp with your own application class's name).  Then, a cut-and-pasted
 version of a successful session with your application, saved as a text file, can serve

Mercurial > python-cmd2

comparison cmd2.py @ 290:cd12e4e0fa17