From 6a05e879d4f3b2ac6982ce640b0aaf9c0463f8bb Mon Sep 17 00:00:00 2001 From: Savannah Ostrowski Date: Tue, 24 Sep 2024 09:30:01 -0700 Subject: [PATCH] GH-87358: Add clarification about nargs and default argparse behaviour (GH-124094) (cherry picked from commit 20ccda000b5f8365d5f864fd07876804157c2378) Co-authored-by: Savannah Ostrowski --- Doc/library/argparse.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index c4e2dbcac2156c..5f7cecd2cad18e 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::