1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a link target for argparse.Namespace (#8982)

Browse Source
This commit is contained in:
Éric Araujo 2011-07-29 17:59:17 +02:00
parent e801aa2a1d
commit 63b18a4445
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Doc/library/argparse.rst
View File

@ -110,7 +110,7 @@ Parsing arguments
:class:`ArgumentParser` parses args through the :class:`ArgumentParser` parses args through the
:meth:`~ArgumentParser.parse_args` method. This will inspect the command line, :meth:`~ArgumentParser.parse_args` method. This will inspect the command line,
convert each arg to the appropriate type and then invoke the appropriate action. convert each arg to the appropriate type and then invoke the appropriate action.
In most cases, this means a simple namespace object will be built up from In most cases, this means a simple :class:`Namespace` object will be built up from
attributes parsed out of the command line:: attributes parsed out of the command line::
>>> parser.parse_args(['--sum', '7', '-1', '42']) >>> parser.parse_args(['--sum', '7', '-1', '42'])
@ -722,7 +722,7 @@ the Action API. The easiest way to do this is to extend
* ``parser`` - The ArgumentParser object which contains this action. * ``parser`` - The ArgumentParser object which contains this action.
* ``namespace`` - The namespace object that will be returned by * ``namespace`` - The :class:`Namespace` object that will be returned by
:meth:`~ArgumentParser.parse_args`. Most actions add an attribute to this :meth:`~ArgumentParser.parse_args`. Most actions add an attribute to this
object. object.
@ -1333,11 +1333,14 @@ interactive prompt::
The Namespace object The Namespace object
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
By default, :meth:`~ArgumentParser.parse_args` will return a new object of type .. class:: Namespace
:class:`Namespace` where the necessary attributes have been set. This class is
deliberately simple, just an :class:`object` subclass with a readable string Simple class used by default by :meth:`~ArgumentParser.parse_args` to create
representation. If you prefer to have dict-like view of the attributes, you an object holding attributes and return it.
can use the standard Python idiom via :func:`vars`::
This class is deliberately simple, just an :class:`object` subclass with a
readable string representation. If you prefer to have dict-like view of the
attributes, you can use the standard Python idiom, :func:`vars`::
>>> parser = argparse.ArgumentParser() >>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo') >>> parser.add_argument('--foo')