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

#1415508: Document two functions

This commit is contained in:
Andrew M. Kuchling 2008-09-28 01:08:47 +00:00
parent ac77166e90
commit 7a4a93b8e9
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/library/optparse.rst
View File

@ -1198,17 +1198,32 @@ traditional Unix exit status for command-line errors).
Querying and manipulating your option parser Querying and manipulating your option parser
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Sometimes, it's useful to poke around your option parser and see what's there. The default behavior of the option parser can be customized slightly,
OptionParser provides a couple of methods to help you out: and you can also poke around your option parser and see what's there.
OptionParser provides several methods to help you out:
``has_option(opt_str)`` ``disable_interspersed_args()``
Return true if the OptionParser has an option with option string ``opt_str`` Set parsing to stop on the first non-option. Use this if you have a
(e.g., ``"-q"`` or ``"--verbose"``). command processor which runs another command which has options of
its own and you want to make sure these options don't get
confused. For example, each command might have a different
set of options.
``enable_interspersed_args()``
Set parsing to not stop on the first non-option, allowing
interspersing switches with command arguments. For example,
``"-s arg1 --long arg2"`` would return ``["arg1", "arg2"]``
as the command arguments and ``-s, --long`` as options.
This is the default behavior.
``get_option(opt_str)`` ``get_option(opt_str)``
Returns the Option instance with the option string ``opt_str``, or ``None`` if Returns the Option instance with the option string ``opt_str``, or ``None`` if
no options have that option string. no options have that option string.
``has_option(opt_str)``
Return true if the OptionParser has an option with option string ``opt_str``
(e.g., ``"-q"`` or ``"--verbose"``).
``remove_option(opt_str)`` ``remove_option(opt_str)``
If the OptionParser has an option corresponding to ``opt_str``, that option is If the OptionParser has an option corresponding to ``opt_str``, that option is
removed. If that option provided any other option strings, all of those option removed. If that option provided any other option strings, all of those option