<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <link rel="STYLESHEET" href="lib.css" type='text/css' /> <link rel="SHORTCUT ICON" href="../icons/pyfav.gif" /> <link rel='start' href='../index.html' title='Python Documentation Index' /> <link rel="first" href="lib.html" title='Python Library Reference' /> <link rel='contents' href='contents.html' title="Contents" /> <link rel='index' href='genindex.html' title='Index' /> <link rel='last' href='about.html' title='About this document...' /> <link rel='help' href='about.html' title='About this document...' /> <LINK rel="next" href="module-shlex.html"> <LINK rel="prev" href="module-calendar.html"> <LINK rel="parent" href="misc.html"> <LINK rel="next" href="Cmd-objects.html"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta name='aesop' content='information' /> <META name="description" content="cmd -- Support for line-oriented command interpreters"> <META name="keywords" content="lib"> <META name="resource-type" content="document"> <META name="distribution" content="global"> <title>5.19 cmd -- Support for line-oriented command interpreters</title> </head> <body> <DIV CLASS="navigation"> <div id='top-navigation-panel'> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="5.18 calendar " href="module-calendar.html"><img src='../icons/previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="5. Miscellaneous Services" href="misc.html"><img src='../icons/up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="5.19.1 Cmd Objects" href="Cmd-objects.html"><img src='../icons/next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Python Library Reference</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" href="contents.html"><img src='../icons/contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' border='0' height='32' alt='Module Index' width='32' /></a></td> <td class='online-navigation'><a rel="index" title="Index" href="genindex.html"><img src='../icons/index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="module-calendar.html">5.18 calendar </A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="misc.html">5. Miscellaneous Services</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="Cmd-objects.html">5.19.1 Cmd Objects</A> </div> <hr /></div> </DIV> <!--End of Navigation Panel--> <H1><A NAME="SECTION0071900000000000000000"> 5.19 <tt class="module">cmd</tt> -- Support for line-oriented command interpreters</A> </H1> <P> <A NAME="module-cmd"><!--z--></A> <P> The <tt class="class">Cmd</tt> class provides 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. <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-1291' class="class">Cmd</tt></b>(</nobr></td> <td><big>[</big><var>completekey</var><big>]</big><var>,</var><big>[</big><var>stdin</var><big>]</big><var>,</var><big>[</big><var>stdout</var><big>]</big>)</td></tr></table></dt> <dd> A <tt class="class">Cmd</tt> instance or subclass instance is a line-oriented interpreter framework. There is no good reason to instantiate <tt class="class">Cmd</tt> itself; rather, it's useful as a superclass of an interpreter class you define yourself in order to inherit <tt class="class">Cmd</tt>'s methods and encapsulate action methods. <P> The optional argument <var>completekey</var> is the <tt class="module"><a href="module-readline.html">readline</a></tt> name of a completion key; it defaults to <kbd>Tab</kbd>. If <var>completekey</var> is not <code>None</code> and <tt class="module">readline</tt> is available, command completion is done automatically. <P> The optional arguments <var>stdin</var> and <var>stdout</var> specify the input and output file objects that the Cmd instance or subclass instance will use for input and output. If not specified, they will default to <var>sys.stdin</var> and <var>sys.stdout</var>. <P> <span class="versionnote">Changed in version 2.3: The <var>stdin</var> and <var>stdout</var> parameters were added..</span> </dl> <P> <p><br /></p><hr class='online-navigation' /> <div class='online-navigation'> <!--Table of Child-Links--> <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> <UL CLASS="ChildLinks"> <LI><A href="Cmd-objects.html">5.19.1 Cmd Objects</a> </ul> <!--End of Table of Child-Links--> </div> <DIV CLASS="navigation"> <div class='online-navigation'><hr /> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="5.18 calendar " rel="prev" title="5.18 calendar " href="module-calendar.html"><img src='../icons/previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="5. Miscellaneous Services" rel="parent" title="5. Miscellaneous Services" href="misc.html"><img src='../icons/up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="5.19.1 Cmd Objects" rel="next" title="5.19.1 Cmd Objects" href="Cmd-objects.html"><img src='../icons/next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Python Library Reference</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" rel="contents" title="Table of Contents" href="contents.html"><img src='../icons/contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' border='0' height='32' alt='Module Index' width='32' /></a></td> <td class='online-navigation'><a rel="index" title="Index" rel="index" title="Index" href="genindex.html"><img src='../icons/index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="module-calendar.html">5.18 calendar </A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="misc.html">5. Miscellaneous Services</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="Cmd-objects.html">5.19.1 Cmd Objects</A> </div> </div> <hr /> <span class="release-info">Release 2.3.4, documentation updated on May 20, 2004.</span> </DIV> <!--End of Navigation Panel--> <ADDRESS> See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. </ADDRESS> </BODY> </HTML>