From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Tue, 24 Sep 2024 18:08:02 +0000 (+0200) Subject: [3.13] GH-87358: Add clarification about nargs and default argparse behaviour (GH... X-Git-Tag: v3.13.0rc3~99 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b4b182a84d0b349622c089c99cc3ab30cd485269;p=thirdparty%2FPython%2Fcpython.git [3.13] GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (#124440) GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (cherry picked from commit 20ccda000b5f8365d5f864fd07876804157c2378) Co-authored-by: Savannah Ostrowski --- diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index c4e2dbcac215..5f7cecd2cad1 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -1122,6 +1122,9 @@ is used when no command-line argument was present:: >>> parser.parse_args([]) Namespace(foo=42) +For required_ arguments, the ``default`` value is ignored. For example, this +applies to positional arguments with nargs_ values other than ``?`` or ``*``, +or optional arguments marked as ``required=True``. Providing ``default=argparse.SUPPRESS`` causes no attribute to be added if the command-line argument was not present::