Note the store_true and store_false also create the appropriate defaults.
authorRaymond Hettinger <python@rcn.com>
Sun, 20 Nov 2011 19:05:23 +0000 (11:05 -0800)
committerRaymond Hettinger <python@rcn.com>
Sun, 20 Nov 2011 19:05:23 +0000 (11:05 -0800)
Doc/library/argparse.rst

index 3b8311098a26fb72265fe24a51f09748e8a88bd5..38e3f3ee7a4aa4e696eb77573d3470fdb713bb27 100644 (file)
@@ -670,15 +670,17 @@ how the command-line arguments should be handled. The supported actions are:
     >>> parser.parse_args('--foo'.split())
     Namespace(foo=42)
 
-* ``'store_true'`` and ``'store_false'`` - These store the values ``True`` and
-  ``False`` respectively.  These are special cases of ``'store_const'``.  For
-  example::
+* ``'store_true'`` and ``'store_false'`` - These are special cases of
+  ``'store_const'`` using for storing the values ``True`` and ``False``
+  respectively.  In addition, they create default values of *False* and *True*
+  respectively.  For example::
 
     >>> parser = argparse.ArgumentParser()
     >>> parser.add_argument('--foo', action='store_true')
     >>> parser.add_argument('--bar', action='store_false')
+    >>> parser.add_argument('--baz', action='store_false')
     >>> parser.parse_args('--foo --bar'.split())
-    Namespace(bar=False, foo=True)
+    Namespace(bar=False, baz=True, foo=True)
 
 * ``'append'`` - This stores a list, and appends each argument value to the
   list.  This is useful to allow an option to be specified multiple times.