"""A generic class to build line-oriented command interpreters.
Interpreters constructed with this class obey the following conventions:
1. End of file on input is processed as the command 'EOF'.
2. A command is parsed out of each line by collecting the prefix composed
of characters in the identchars member.
3. A command `foo' is dispatched to a method 'do_foo()'; the do_ method
is passed a single argument consisting of the remainder of the line.
4. Typing an empty line repeats the last command. (Actually, it calls the
method `emptyline', which may be overridden in a subclass.)
5. There is a predefined `help' method. Given an argument `topic', it
calls the command `help_topic'. With no arguments, it lists all topics
with defined help_ functions, broken into up to three topics; documented
commands, miscellaneous help topics, and undocumented commands.
6. The command '?' is a synonym for `help'. The command '!' is a synonym
for `shell', if a do_shell method exists.
7. If completion is enabled, completing commands will be done automatically,
and completing of commands args is done by calling complete_foo() with
arguments text, line, begidx, endidx. text is string we are matching
against, all returned matches must begin with it. line is the current
input line (lstripped), begidx and endidx are the beginning and end
indexes of the text being matched, which could be used to provide
different completion depending upon which position the argument is in.
The `default' method may be overridden to intercept commands for which there
The `completedefault' method may be overridden to intercept completions for
commands that have no complete_ method.
The data member `self.ruler' sets the character used to draw separator lines
in the help messages. If empty, no ruler line is drawn. It defaults to "=".
If the value of `self.intro' is nonempty when the cmdloop method is called,
it is printed out on interpreter startup. This value may be overridden
via an optional argument to the cmdloop() method.
The data members `self.doc_header', `self.misc_header', and
`self.undoc_header' set the headers used for the help function's
listings of documented functions, miscellaneous topics, and undocumented
These interpreters use raw_input; thus, if the readline module is loaded,
they automatically support Emacs-like command history and editing features.
IDENTCHARS = string.ascii_letters + string.digits + '_'
"""A simple framework for writing line-oriented command interpreters.
These are often useful for test harnesses, administrative tools, and
prototypes that will later be wrapped in a more sophisticated interface.
A Cmd instance or subclass instance is a line-oriented interpreter
framework. There is no good reason to instantiate Cmd itself; rather,
it's useful as a superclass of an interpreter class you define yourself
in order to inherit Cmd's methods and encapsulate action methods.
doc_header = "Documented commands (type help <topic>):"
misc_header = "Miscellaneous help topics:"
undoc_header = "Undocumented commands:"
nohelp = "*** No help on %s"
def __init__(self, completekey='tab', stdin=None, stdout=None):
"""Instantiate a line-oriented interpreter framework.
The optional argument 'completekey' is the readline name of a
completion key; it defaults to the Tab key. If completekey is
not None and the readline module is available, command completion
is done automatically. The optional arguments stdin and stdout
specify alternate input and output file objects; if not specified,
sys.stdin and sys.stdout are used.
self.completekey = completekey
def cmdloop(self, intro=None):
"""Repeatedly issue a prompt, accept input, parse an initial prefix
off the received input, and dispatch to action methods, passing them
the remainder of the line as argument.
if self.use_rawinput and self.completekey:
self.old_completer = readline.get_completer()
readline.set_completer(self.complete)
readline.parse_and_bind(self.completekey+": complete")
self.stdout.write(str(self.intro)+"\n")
line = self.cmdqueue.pop(0)
line = raw_input(self.prompt)
self.stdout.write(self.prompt)
line = self.stdin.readline()
line = line.rstrip('\r\n')
stop = self.postcmd(stop, line)
if self.use_rawinput and self.completekey:
readline.set_completer(self.old_completer)
"""Hook method executed just before the command line is
interpreted, but after the input prompt is generated and issued.
def postcmd(self, stop, line):
"""Hook method executed just after a command dispatch is finished."""
"""Hook method executed once when the cmdloop() method is called."""
"""Hook method executed once when the cmdloop() method is about to
def parseline(self, line):
"""Parse the line into a command name and a string containing
the arguments. Returns a tuple containing (command, args, line).
'command' and 'args' may be None if the line couldn't be parsed.
line = 'help ' + line[1:]
if hasattr(self, 'do_shell'):
line = 'shell ' + line[1:]
while i < n and line[i] in self.identchars: i = i+1
cmd, arg = line[:i], line[i:].strip()
"""Interpret the argument as though it had been typed in response
This may be overridden, but should not normally need to be;
see the precmd() and postcmd() methods for useful execution hooks.
The return value is a flag indicating whether interpretation of
commands by the interpreter should stop.
cmd, arg, line = self.parseline(line)
return self.default(line)
return self.default(line)
func = getattr(self, 'do_' + cmd)
return self.default(line)
"""Called when an empty line is entered in response to the prompt.
If this method is not overridden, it repeats the last nonempty
return self.onecmd(self.lastcmd)
"""Called on an input line when the command prefix is not recognized.
If this method is not overridden, it prints an error message and
self.stdout.write('*** Unknown syntax: %s\n'%line)
def completedefault(self, *ignored):
"""Method called to complete an input line when no command-specific
complete_*() method is available.
By default, it returns an empty list.
def completenames(self, text, *ignored):
return [a[3:] for a in self.get_names() if a.startswith(dotext)]
def complete(self, text, state):
"""Return the next possible completion for 'text'.
If a command has not been entered, then complete against command list.
Otherwise try to call complete_<command> to get list of completions.
origline = readline.get_line_buffer()
stripped = len(origline) - len(line)
begidx = readline.get_begidx() - stripped
endidx = readline.get_endidx() - stripped
cmd, args, foo = self.parseline(line)
compfunc = self.completedefault
compfunc = getattr(self, 'complete_' + cmd)
compfunc = self.completedefault
compfunc = self.completenames
self.completion_matches = compfunc(text, line, begidx, endidx)
return self.completion_matches[state]
# This method used to pull in base class attributes
# at a time dir() didn't do it yet.
return dir(self.__class__)
def complete_help(self, *args):
commands = set(self.completenames(*args))
topics = set(a[5:] for a in self.get_names()
if a.startswith('help_' + args[0]))
return list(commands | topics)
'List available commands with "help" or detailed help with "help cmd".'
func = getattr(self, 'help_' + arg)
doc=getattr(self, 'do_' + arg).__doc__
self.stdout.write("%s\n"%str(doc))
self.stdout.write("%s\n"%str(self.nohelp % (arg,)))
# There can be duplicates if routines overridden
elif getattr(self, name).__doc__:
self.stdout.write("%s\n"%str(self.doc_leader))
self.print_topics(self.doc_header, cmds_doc, 15,80)
self.print_topics(self.misc_header, help.keys(),15,80)
self.print_topics(self.undoc_header, cmds_undoc, 15,80)
def print_topics(self, header, cmds, cmdlen, maxcol):
self.stdout.write("%s\n"%str(header))
self.stdout.write("%s\n"%str(self.ruler * len(header)))
self.columnize(cmds, maxcol-1)
def columnize(self, list, displaywidth=80):
"""Display a list of strings as a compact set of columns.
Each column is only as wide as necessary.
Columns are separated by two spaces (one was not legible enough).
self.stdout.write("<empty>\n")
nonstrings = [i for i in range(len(list))
if not isinstance(list[i], str)]
raise TypeError, ("list[i] not a string for i in %s" %
", ".join(map(str, nonstrings)))
self.stdout.write('%s\n'%str(list[0]))
# Try every row count from 1 upwards
for nrows in range(1, len(list)):
ncols = (size+nrows-1) // nrows
colwidth = max(colwidth, len(x))
colwidths.append(colwidth)
if totwidth > displaywidth:
if totwidth <= displaywidth:
while texts and not texts[-1]:
for col in range(len(texts)):
texts[col] = texts[col].ljust(colwidths[col])
self.stdout.write("%s\n"%str(" ".join(texts)))
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
