Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
579d3664
Commit
579d3664
authored
Jul 02, 1998
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Normalize the markup.
parent
3f6034dc
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
42 additions
and
38 deletions
+42
-38
Doc/lib/libcmd.tex
Doc/lib/libcmd.tex
+42
-38
No files found.
Doc/lib/libcmd.tex
View file @
579d3664
...
...
@@ -3,17 +3,17 @@
\stmodindex
{
cmd
}
\label
{
module-cmd
}
The
\c
ode
{
Cmd
}
class provides a simple framework for writing
The
\c
lass
{
Cmd
}
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.
\begin{classdesc}
{
Cmd
}{}
A
\class
{
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 function
s.
interpreter framework. There is no good reason to instantiate
\class
{
Cmd
}
itself; rather, it's useful as a superclass of an
interpreter class you define yourself in order to inherit
\class
{
Cmd
}
's methods and encapsulate action method
s.
\end{classdesc}
\subsection
{
Cmd Objects
}
...
...
@@ -21,7 +21,7 @@ action functions.
A
\class
{
Cmd
}
instance has the following methods:
\begin{methoddesc}
{
cmdloop
}{
intro
}
\begin{methoddesc}
{
cmdloop
}{
\optional
{
intro
}
}
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.
...
...
@@ -30,26 +30,26 @@ The optional argument is a banner or intro string to be issued before the
first prompt (this overrides the
\member
{
intro
}
class member).
If the
\module
{
readline
}
module is loaded, input will automatically
inherit
Emacs-like history-list editing (e.g. Ctrl-P scrolls back to
the last command, Ctrl-N forward to the next one, Ctrl-F moves the
cursor to the right non-destructively, Ctrl-B moves the cursor to the
left non-destructively, etc.).
inherit
\program
{
bash
}
-like history-list editing (e.g.
\kbd
{
Ctrl-P
}
scrolls back to the last command,
\kbd
{
Ctrl-N
}
forward to the next
one,
\kbd
{
Ctrl-F
}
moves the cursor to the right non-destructively,
\kbd
{
Ctrl-B
}
moves the cursor to the
left non-destructively, etc.).
An end-of-file on input is passed back as the string
"EOF"
.
An end-of-file on input is passed back as the string
\code
{
'EOF'
}
.
An interpreter instance will recognize a command name
\
code
{
foo
}
if
and only if it has a method
named
\method
{
do
_
foo
}
. As a special case,
a line containing only the character
`?' is dispatched to the method
\method
{
do
_
help
}
. As another special case, a line containing only th
e
c
haracter `!' is dispatched to the method
\method
{
do
_
shell
}
(if such a method
is defined).
An interpreter instance will recognize a command name
\
samp
{
foo
}
if
and only if it has a method
\method
{
do
_
foo()
}
. As a special case,
a line containing only the character
\character
{
?
}
is dispatched to
the method
\method
{
do
_
help()
}
. As another special case, a lin
e
c
ontaining only the character
\character
{
!
}
is dispatched to the
method
\method
{
do
_
shell
}
(if such a method
is defined).
All subclasses of
\class
{
Cmd
}
inherit a predefined
\method
{
do
_
help
}
.
This method, called with an argument
\code
{
bar
}
, invokes the
corresponding method
\method
{
help
_
bar
}
. With no argument,
\method
{
do
_
help
}
lists all available help topics (that is, all
commands with corresponding
\
code
{
help
_}
methods), and also lists any
undocumented commands.
corresponding method
\method
{
help
_
bar
()
}
. With no argument,
\method
{
do
_
help
()
}
lists all available help topics (that is, all
commands with corresponding
\
method
{
help
_
*()
}
methods), and also lists
any
undocumented commands.
\end{methoddesc}
\begin{methoddesc}
{
onecmd
}{
str
}
...
...
@@ -69,25 +69,27 @@ recognized. If this method is not overridden, it prints an
error message and returns.
\end{methoddesc}
\begin{methoddesc}
{
precmd
}
Hook method executed just before the input prompt is issued. This method is
a stub in
\class
{
Cmd
}
; it exists to be overridden by subclasses.
\begin{methoddesc}
{
precmd
}{}
Hook method executed just before the input prompt is issued. This
method is a stub in
\class
{
Cmd
}
; it exists to be overridden by
subclasses.
\end{methoddesc}
\begin{methoddesc}
{
postcmd
}
\begin{methoddesc}
{
postcmd
}
{}
Hook method executed just after a command dispatch is finished. This
method is a stub in
\class
{
Cmd
}
; it exists to be overridden by
subclasses.
\end{methoddesc}
\begin{methoddesc}
{
preloop
}
Hook method executed once when
\method
{
cmdloop()
}
is called. This method is
a stub in
\class
{
Cmd
}
; it exists to be overridden by subclasses.
\begin{methoddesc}
{
preloop
}{}
Hook method executed once when
\method
{
cmdloop()
}
is called. This
method is a stub in
\class
{
Cmd
}
; it exists to be overridden by
subclasses.
\end{methoddesc}
\begin{methoddesc}
{
postloop
}
Hook method executed once when
\method
{
cmdloop()
}
is about to return.
This
method is a stub in
\class
{
Cmd
}
; it exists to be overridden by
\begin{methoddesc}
{
postloop
}
{}
Hook method executed once when
\method
{
cmdloop()
}
is about to return.
This
method is a stub in
\class
{
Cmd
}
; it exists to be overridden by
subclasses.
\end{methoddesc}
...
...
@@ -111,24 +113,26 @@ the \method{cmdloop()} method an argument.
\end{memberdesc}
\begin{memberdesc}
{
doc
_
header
}
The header to issue if the help output has a section for documented commands.
The header to issue if the help output has a section for documented
commands.
\end{memberdesc}
\begin{memberdesc}
{
misc
_
header
}
The header to issue if the help output has a section for miscellaneous
help topics (that is, there are
\
code
{
help
_}
methods withoud corresponding
\code
{
do
_}
function
s).
The header to issue if the help output has a section for miscellaneous
help topics (that is, there are
\
method
{
help
_
*()
}
methods without
corresponding
\method
{
do
_
*()
}
method
s).
\end{memberdesc}
\begin{memberdesc}
{
undoc
_
header
}
The header to issue if the help output has a section for undocumented
commands (that is, there are
\
code
{
do
_}
methods withoud corresponding
\code
{
help
_}
function
s).
commands (that is, there are
\
method
{
do
_
*()
}
methods without
corresponding
\method
{
help
_
*()
}
method
s).
\end{memberdesc}
\begin{memberdesc}
{
ruler
}
The character used to draw separator lines under the help-message
headers. If empty, no ruler line is drawn. It defaults to "=".
headers. If empty, no ruler line is drawn. It defaults to
\character
{
=
}
.
\end{memberdesc}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment