mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 15:40:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

#6977: getopt does not support optional option arguments.

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