]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-38843: Document behavior of default when the attribute is already set (GH-23653)
authorRaymond Hettinger <rhettinger@users.noreply.github.com>
Mon, 7 Dec 2020 02:29:08 +0000 (18:29 -0800)
committerGitHub <noreply@github.com>
Mon, 7 Dec 2020 02:29:08 +0000 (18:29 -0800)
Doc/library/argparse.rst

index a32b99901a7b4e2b6b532664b16f03faca0ab352..02cd70f4f71cd6e688055a4a7c2c8c012f2289de 100644 (file)
@@ -696,7 +696,7 @@ The add_argument() method
    * const_ - A constant value required by some action_ and nargs_ selections.
 
    * default_ - The value produced if the argument is absent from the
-     command line.
+     command line and if it is absent from the namespace object.
 
    * type_ - The type to which the command-line argument should be converted.
 
@@ -1006,6 +1006,14 @@ was not present at the command line::
    >>> parser.parse_args([])
    Namespace(foo=42)
 
+If the target namespace already has an attribute set, the action *default*
+will not over write it::
+
+   >>> parser = argparse.ArgumentParser()
+   >>> parser.add_argument('--foo', default=42)
+   >>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
+   Namespace(foo=101)
+
 If the ``default`` value is a string, the parser parses the value as if it
 were a command-line argument.  In particular, the parser applies any type_
 conversion argument, if provided, before setting the attribute on the