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
43211ecd
Commit
43211ecd
authored
Jul 29, 2001
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Make some adjustments to the markup, and fix up some style-guide issues.
parent
db642c66
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
17 deletions
+17
-17
Doc/lib/libcmd.tex
Doc/lib/libcmd.tex
+17
-17
No files found.
Doc/lib/libcmd.tex
View file @
43211ecd
...
...
@@ -19,9 +19,9 @@ interpreter class you define yourself in order to inherit
\class
{
Cmd
}
's methods and encapsulate action methods.
The optional argument is the
\refmodule
{
readline
}
name of a completion
key; it defaults to
\
code
{
``tab''
}
. If
\var
{
completekey
}
is not
\code
{
None
}
and
\module
{
readline
}
is available, command completion is
done
automatically.
key; it defaults to
\
kbd
{
Tab
}
. If
\var
{
completekey
}
is not
\code
{
None
}
and
\module
{
readline
}
is available, command completion is done
automatically.
\end{classdesc}
...
...
@@ -51,20 +51,20 @@ and only if it has a method \method{do_foo()}. As a special case,
a line beginning with the character
\character
{
?
}
is dispatched to
the method
\method
{
do
_
help()
}
. As another special case, a line
beginning with the character
\character
{
!
}
is dispatched to the
method
\method
{
do
_
shell
}
(if such a method is defined).
method
\method
{
do
_
shell
()
}
(if such a method is defined).
If completion is enabled, completing commands will be done
automatically, and completing of commands args is done by calling
\method
{
complete
_
foo()
}
with arguments
\
samp
{
text
}
,
\samp
{
line
}
,
\
samp
{
begidx
}
,
\samp
{
endidx
}
.
\samp
{
text
}
is string we are matching
a
gainst, all returned matches must begin with it.
\samp
{
line
}
is the
current input line (lstripped),
\samp
{
begidx
}
and
\samp
{
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.
All subclasses of
\class
{
Cmd
}
inherit a predefined
\method
{
do
_
help
}
.
This method, called with an argument
\code
{
bar
}
, invokes the
\method
{
complete
_
foo()
}
with arguments
\
var
{
text
}
,
\var
{
line
}
,
\
var
{
begidx
}
, and
\var
{
endidx
}
.
\var
{
text
}
is the string prefix we
a
re attempting to match: all returned matches must begin with it.
\var
{
line
}
is the current input line with leading whitespace removed,
\var
{
begidx
}
and
\var
{
endidx
}
are the beginning and ending indexes
of the prefix text, which could be used to provide different
completion depending upon which position
the argument is in.
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
\method
{
help
_
*()
}
methods), and also lists
...
...
@@ -90,7 +90,7 @@ error message and returns.
\begin{methoddesc}
{
completedefault
}{
text, line, begidx, endidx
}
Method called to complete an input line when no command-specific
\
code
{
complete
_}
method is available.
By default, it returns an
\
method
{
complete
_
*()
}
method is available.
By default, it returns an
empty list.
\end{methoddesc}
...
...
@@ -164,8 +164,8 @@ headers. If empty, no ruler line is drawn. It defaults to
\begin{memberdesc}
{
use
_
rawinput
}
A flag, defaulting to true. If true,
\method
{
cmdloop()
}
uses
\function
{
raw
_
input()
}
to display a prompt and read the next command;
if false,
\
function
{
sys.stdout.write()
}
and
\
function
{
sys.stdin.readline()
}
are used. (This means that by
if false,
\
method
{
sys.stdout.write()
}
and
\
method
{
sys.stdin.readline()
}
are used. (This means that by
importing
\module
{
readline
}
, on systems that support it, the
interpreter will automatically support Emacs-like line editing
and command-history keystrokes.)
...
...
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