cpython: d832756a82d9 (original) (raw)
Mercurial > cpython
changeset 68978:d832756a82d9
Issue #8982: Improve the documentation for the argparse Namespace object. (Merge from 3.2.) [#8982]
| Steven Bethard steven.bethard@gmail.com | |
|---|---|
| date | Sat, 26 Mar 2011 19:55:36 +0100 |
| parents | a76257a99636(current diff)423b50086b67(diff) |
| children | 439e185c3a7b |
| files | Doc/library/argparse.rst Misc/NEWS |
| diffstat | 2 files changed, 18 insertions(+), 5 deletions(-)[+] [-] Doc/library/argparse.rst 21 Misc/NEWS 2 |
line wrap: on
line diff
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -1330,13 +1330,24 @@ of :data:sys.argv. This can be accomp
Namespace(accumulate=, integers=[1, 2, 3, 4])
-Custom namespaces
-^^^^^^^^^^^^^^^^^
+The Namespace object
+^^^^^^^^^^^^^^^^^^^^
+
+By default, :meth:parse_args will return a new object of type :class:Namespace
+where the necessary attributes have been set. 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 via :func:vars::
+
It may also be useful to have an :class:ArgumentParser assign attributes to an
-already existing object, rather than the newly-created :class:Namespace object
-that is normally used. This can be achieved by specifying the namespace=
-keyword argument::
+already existing object, rather than a new :class:Namespace object. This can
+be achieved by specifying the namespace= keyword argument::
>>> class C:
... pass