Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

#6977: getopt does not support optional option arguments.

This commit is contained in:
Georg Brandl 2009-10-22 15:54:35 +00:00
parent 76d6d4a010
commit d1bed8e5ef
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Doc/library/getopt.rst
View File

@ -30,19 +30,20 @@ exception:
.. note::
Unlike GNU :cfunc:`getopt`, after a non-option argument, all further arguments
are considered also non-options. This is similar to the way non-GNU Unix systems
work.
Unlike GNU :cfunc:`getopt`, after a non-option argument, all further
arguments are considered also non-options. This is similar to the way
non-GNU Unix systems work.
*long_options*, if specified, must be a list of strings with the names of the
long options which should be supported. The leading ``'-``\ ``-'`` characters
should not be included in the option name. Long options which require an
argument should be followed by an equal sign (``'='``). To accept only long
options, *options* should be an empty string. Long options on the command line
can be recognized so long as they provide a prefix of the option name that
matches exactly one of the accepted options. For example, if *long_options* is
``['foo', 'frob']``, the option :option:`--fo` will match as :option:`--foo`,
but :option:`--f` will not match uniquely, so :exc:`GetoptError` will be raised.
long options which should be supported. The leading ``'-``\ ``-'``
characters should not be included in the option name. Long options which
require an argument should be followed by an equal sign (``'='``). Optional
arguments are not supported. To accept only long options, *options* should
be an empty string. Long options on the command line can be recognized so
long as they provide a prefix of the option name that matches exactly one of
the accepted options. For example, if *long_options* is ``['foo', 'frob']``,
the option :option:`--fo` will match as :option:`--foo`, but :option:`--f`
will not match uniquely, so :exc:`GetoptError` will be raised.
The return value consists of two elements: the first is a list of ``(option,
value)`` pairs; the second is the list of program arguments left after the