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
c4f79e4b
Commit
c4f79e4b
authored
Mar 10, 1998
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Logical markup.
Use {funcdesc} and {excdesc} to describe the module, not just running text.
parent
c9988ad6
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
72 additions
and
78 deletions
+72
-78
Doc/lib/libgetopt.tex
Doc/lib/libgetopt.tex
+36
-39
Doc/libgetopt.tex
Doc/libgetopt.tex
+36
-39
No files found.
Doc/lib/libgetopt.tex
View file @
c4f79e4b
\section
{
Standard Module
\sectcode
{
getopt
}}
\label
{
module-getopt
}
\stmodindex
{
getopt
}
This module helps scripts to parse the command line arguments in
\code
{
sys.argv
}
.
It supports the same conventions as the
\UNIX
{}
\code
{
getopt()
}
It supports the same conventions as the
\UNIX
{}
\cfunction
{
getopt()
}
function (including the special meanings of arguments of the form
`
\code
{
-
}
' and `
\code
{
-
}
\code
{
-
}
').
% That's to fool latex2html into leaving the two hyphens alone!
Long options similar to those supported by
GNU software may be used as well via an optional third argument.
It defines the function
\code
{
getopt.getopt(args, options [, long
_
options])
}
and the exception
\code
{
getopt.error
}
.
This module provides a single function and an exception:
\begin{funcdesc}
{
getopt
}{
args, options
\optional
{
, long
_
options
}}
Parses command line options and parameter list.
\var
{
args
}
is the
argument list to be parsed, without the leading reference to the
running program. Typically, this means
\samp
{
sys.argv[1:]
}
.
\var
{
options
}
is the string of option letters that the script wants to
recognize, with options that require an argument followed by a colon
(i.e., the same format that
\UNIX
{}
\cfunction
{
getopt()
}
uses). If
specified,
\var
{
long
_
options
}
is a list of strings with the names of
the long options which should be supported. The leading
\code
{
'-
}
\code
{
-'
}
characters should not be included in the option
name. Options which require an argument should be followed by an
equal sign (
\code
{
'='
}
).
The first argument to
\code
{
getopt()
}
is the argument list passed to the script with its first element
chopped off (i.e.,
\code
{
sys.argv[1:]
}
).
The second argument is the string of option letters that the
script wants to recognize, with options that require an argument
followed by a colon (i.e., the same format that
\UNIX
{}
\code
{
getopt()
}
uses).
The third option, if specified, is a list of strings with the names of
the long options which should be supported. The leading
\code
{
'-
}
\code
{
-'
}
characters should not be included in the option name. Options which
require an argument should be followed by an equal sign (
\code
{
'='
}
).
The return value consists of two elements: the first is a list of
option-and-value pairs; the second is the list of program arguments
left after the option list was stripped (this is a trailing slice of the
first argument).
Each option-and-value pair returned has the option as its first element,
prefixed with a hyphen (e.g.,
\code
{
'-x'
}
),
and the option argument as its second element, or an empty string if the
option has no argument.
\code
{
(
\var
{
option
}
,
\var
{
value
}
)
}
pairs; the second is the list of
program arguments left after the option list was stripped (this is a
trailing slice of the first argument).
Each option-and-value pair returned has the option as its first
element, prefixed with a hyphen (e.g.,
\code
{
'-x'
}
), and the option
argument as its second element, or an empty string if the option has
no argument.
The options occur in the list in the same order in which they were
found, thus allowing multiple occurrences. Long and short options may
be mixed.
\end{funcdesc}
\begin{excdesc}
{
error
}
This is raised when an unrecognized option is found in the argument
list or when an option requiring an argument is given none.
The argument to the exception is a string indicating the cause of the
error. For long options, an argument given to an option which does
not require one will also cause this exception to be raised.
\end{excdesc}
An example using only
\UNIX
{}
style options:
...
...
@@ -57,7 +61,7 @@ An example using only \UNIX{} style options:
['a1', 'a2']
>>>
\end{verbatim}
%
Using long option names is equally easy:
\begin{verbatim}
...
...
@@ -68,16 +72,9 @@ Using long option names is equally easy:
>>> optlist, args = getopt.getopt(args, 'x', [
... 'condition=', 'output-file=', 'testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')]
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x',
'')]
>>> args
['a1', 'a2']
>>>
\end{verbatim}
%
The exception
\code
{
getopt.error
}
is raised when an unrecognized option is found in the argument list or
when an option requiring an argument is given none.
The argument to the exception is a string indicating the cause of the
error. For long options, an argument given to an option which does
not require one will also cause this exception to be raised.
Doc/libgetopt.tex
View file @
c4f79e4b
\section
{
Standard Module
\sectcode
{
getopt
}}
\label
{
module-getopt
}
\stmodindex
{
getopt
}
This module helps scripts to parse the command line arguments in
\code
{
sys.argv
}
.
It supports the same conventions as the
\UNIX
{}
\code
{
getopt()
}
It supports the same conventions as the
\UNIX
{}
\cfunction
{
getopt()
}
function (including the special meanings of arguments of the form
`
\code
{
-
}
' and `
\code
{
-
}
\code
{
-
}
').
% That's to fool latex2html into leaving the two hyphens alone!
Long options similar to those supported by
GNU software may be used as well via an optional third argument.
It defines the function
\code
{
getopt.getopt(args, options [, long
_
options])
}
and the exception
\code
{
getopt.error
}
.
This module provides a single function and an exception:
\begin{funcdesc}
{
getopt
}{
args, options
\optional
{
, long
_
options
}}
Parses command line options and parameter list.
\var
{
args
}
is the
argument list to be parsed, without the leading reference to the
running program. Typically, this means
\samp
{
sys.argv[1:]
}
.
\var
{
options
}
is the string of option letters that the script wants to
recognize, with options that require an argument followed by a colon
(i.e., the same format that
\UNIX
{}
\cfunction
{
getopt()
}
uses). If
specified,
\var
{
long
_
options
}
is a list of strings with the names of
the long options which should be supported. The leading
\code
{
'-
}
\code
{
-'
}
characters should not be included in the option
name. Options which require an argument should be followed by an
equal sign (
\code
{
'='
}
).
The first argument to
\code
{
getopt()
}
is the argument list passed to the script with its first element
chopped off (i.e.,
\code
{
sys.argv[1:]
}
).
The second argument is the string of option letters that the
script wants to recognize, with options that require an argument
followed by a colon (i.e., the same format that
\UNIX
{}
\code
{
getopt()
}
uses).
The third option, if specified, is a list of strings with the names of
the long options which should be supported. The leading
\code
{
'-
}
\code
{
-'
}
characters should not be included in the option name. Options which
require an argument should be followed by an equal sign (
\code
{
'='
}
).
The return value consists of two elements: the first is a list of
option-and-value pairs; the second is the list of program arguments
left after the option list was stripped (this is a trailing slice of the
first argument).
Each option-and-value pair returned has the option as its first element,
prefixed with a hyphen (e.g.,
\code
{
'-x'
}
),
and the option argument as its second element, or an empty string if the
option has no argument.
\code
{
(
\var
{
option
}
,
\var
{
value
}
)
}
pairs; the second is the list of
program arguments left after the option list was stripped (this is a
trailing slice of the first argument).
Each option-and-value pair returned has the option as its first
element, prefixed with a hyphen (e.g.,
\code
{
'-x'
}
), and the option
argument as its second element, or an empty string if the option has
no argument.
The options occur in the list in the same order in which they were
found, thus allowing multiple occurrences. Long and short options may
be mixed.
\end{funcdesc}
\begin{excdesc}
{
error
}
This is raised when an unrecognized option is found in the argument
list or when an option requiring an argument is given none.
The argument to the exception is a string indicating the cause of the
error. For long options, an argument given to an option which does
not require one will also cause this exception to be raised.
\end{excdesc}
An example using only
\UNIX
{}
style options:
...
...
@@ -57,7 +61,7 @@ An example using only \UNIX{} style options:
['a1', 'a2']
>>>
\end{verbatim}
%
Using long option names is equally easy:
\begin{verbatim}
...
...
@@ -68,16 +72,9 @@ Using long option names is equally easy:
>>> optlist, args = getopt.getopt(args, 'x', [
... 'condition=', 'output-file=', 'testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')]
[('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x',
'')]
>>> args
['a1', 'a2']
>>>
\end{verbatim}
%
The exception
\code
{
getopt.error
}
is raised when an unrecognized option is found in the argument list or
when an option requiring an argument is given none.
The argument to the exception is a string indicating the cause of the
error. For long options, an argument given to an option which does
not require one will also cause this exception to be raised.
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