Trees | Index | Help |
|
---|
Module cmd :: Class Cmd |
|
Pdb
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.Method Summary | |
---|---|
Instantiate a line-oriented interpreter framework. | |
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. | |
Display a list of strings as a compact set of columns. | |
Return the next possible completion for 'text'. | |
complete_help(self,
*args)
| |
Method called to complete an input line when no command-specific complete_*() method is available. | |
completenames(self,
text,
*ignored)
| |
Called on an input line when the command prefix is not recognized. | |
do_help(self,
arg)
| |
Called when an empty line is entered in response to the prompt. | |
get_names(self)
| |
Interpret the argument as though it had been typed in response to the prompt. | |
Parse the line into a command name and a string containing the arguments. | |
Hook method executed just after a command dispatch is finished. | |
Hook method executed once when the cmdloop() method is about to return. | |
Hook method executed just before the command line is interpreted, but after the input prompt is generated and issued. | |
Hook method executed once when the cmdloop() method is called. | |
print_topics(self,
header,
cmds,
cmdlen,
maxcol)
|
Class Variable Summary | |
---|---|
str |
doc_header = 'Documented commands (type help <topic>):'
|
str |
doc_leader = ''
|
str |
identchars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOP...
|
NoneType |
intro = None |
str |
lastcmd = ''
|
str |
misc_header = 'Miscellaneous help topics:'
|
str |
nohelp = '*** No help on %s'
|
str |
prompt = '(Cmd) '
|
str |
ruler = '='
|
str |
undoc_header = 'Undocumented commands:'
|
int |
use_rawinput = 1 |
Method Details |
---|
__init__(self,
completekey='tab',
stdin=None,
stdout=None)
|
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. |
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). |
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. |
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. |
default(self, line)Called on an input line when the command prefix is not recognized. If this method is not overridden, it prints an error message and returns. |
emptyline(self)Called when an empty line is entered in response to the prompt. If this method is not overridden, it repeats the last nonempty command entered. |
onecmd(self, line)Interpret the argument as though it had been typed in response to the prompt. 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. |
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. |
postcmd(self, stop, line)Hook method executed just after a command dispatch is finished. |
postloop(self)Hook method executed once when the cmdloop() method is about to return. |
precmd(self, line)Hook method executed just before the command line is interpreted, but after the input prompt is generated and issued. |
preloop(self)Hook method executed once when the cmdloop() method is called. |
Class Variable Details |
---|
doc_header
|
doc_leader
|
identchars
|
intro
|
lastcmd
|
misc_header
|
nohelp
|
prompt
|
ruler
|
undoc_header
|
use_rawinput
|
Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Jun 24 12:01:22 2005 | http://epydoc.sf.net |