diff options
author | Raymond Hettinger <rhettinger@users.noreply.github.com> | 2020-12-06 18:29:08 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-06 18:29:08 -0800 |
commit | 752cdf21eb2be0a26ea6a34a0de33a458459aead (patch) | |
tree | dc0c9e09a303cb54a5be3ced9de6dce482cd29ee /Doc | |
parent | 8a62887dfb4bb2835048780ad673362f7ee3c7bf (diff) | |
download | cpython-git-752cdf21eb2be0a26ea6a34a0de33a458459aead.tar.gz |
bpo-38843: Document behavior of default when the attribute is already set (GH-23653)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/argparse.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index a32b99901a..02cd70f4f7 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -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 |