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.
|
__init__(self,
completekey=' tab ' ,
stdin=None,
stdout=None)
Instantiate a line-oriented interpreter framework. |
|
|
|
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. |
|
|
|
precmd(self,
line)
Hook method executed just before the command line is interpreted, but
after the input prompt is generated and issued. |
|
|
|
postcmd(self,
stop,
line)
Hook method executed just after a command dispatch is finished. |
|
|
|
preloop(self)
Hook method executed once when the cmdloop() method is called. |
|
|
|
postloop(self)
Hook method executed once when the cmdloop() method is about to
return. |
|
|
|
parseline(self,
line)
Parse the line into a command name and a string containing the
arguments. |
|
|
|
onecmd(self,
line)
Interpret the argument as though it had been typed in response to the
prompt. |
|
|
|
emptyline(self)
Called when an empty line is entered in response to the prompt. |
|
|
|
default(self,
line)
Called on an input line when the command prefix is not recognized. |
|
|
|
completedefault(self,
*ignored)
Method called to complete an input line when no command-specific
complete_*() method is available. |
|
|
|
completenames(self,
text,
*ignored) |
|
|
|
complete(self,
text,
state)
Return the next possible completion for 'text'. |
|
|
|
|
|
complete_help(self,
*args) |
|
|
|
|
|
print_topics(self,
header,
cmds,
cmdlen,
maxcol) |
|
|
|
columnize(self,
list,
displaywidth=80)
Display a list of strings as a compact set of columns. |
|
|