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

Merged revisions 77308 via svnmerge from 

svn+ssh://pythondev@svn.python.org/python/branches/py3k

................
  r77308 | ezio.melotti | 2010-01-04 23:53:17 +0200 (Mon, 04 Jan 2010) | 9 lines

  Merged revisions 77306 via svnmerge from
  svn+ssh://pythondev@svn.python.org/python/trunk

  ........
    r77306 | ezio.melotti | 2010-01-04 23:43:02 +0200 (Mon, 04 Jan 2010) | 1 line

    #3340: document print/get_usage and print/get_version
  ........
................
This commit is contained in:
Ezio Melotti 2010-01-04 21:54:31 +00:00
parent 2505f1ee6c
commit 6ea2a3deb8
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Doc/library/optparse.rst
View File

@ -598,6 +598,20 @@ For example, if your script is called ``/usr/bin/foo``::
$ /usr/bin/foo --version
foo 1.0
The following two methods can be used to print and get the ``version`` string:
.. method:: OptionParser.print_version(file=None)
Print the version message for the current program (``self.version``) to
*file* (default stdout). As with :meth:`print_usage`, any occurrence
of ``"%prog"`` in ``self.version`` is replaced with the name of the current
program. Does nothing if ``self.version`` is empty or undefined.
.. method:: OptionParser.get_version()
Same as :meth:`print_version` but returns the version string instead of
printing it.
.. _optparse-how-optparse-handles-errors:
@ -1384,6 +1398,18 @@ OptionParser supports several other public methods:
constructor keyword argument. Passing ``None`` sets the default usage
string; use :data:`optparse.SUPPRESS_USAGE` to suppress a usage message.
.. method:: OptionParser.print_usage(file=None)
Print the usage message for the current program (``self.usage``) to *file*
(default stdout). Any occurrence of the string ``"%prog"`` in ``self.usage``
is replaced with the name of the current program. Does nothing if
``self.usage`` is empty or not defined.
.. method:: OptionParser.get_usage()
Same as :meth:`print_usage` but returns the usage string instead of
printing it.
.. method:: OptionParser.set_defaults(dest=value, ...)
Set default values for several option destinations at once. Using