Skip to content

GH-87358: Add clarification about nargs and default argparse behaviour #124094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 24, 2024
Merged

GH-87358: Add clarification about nargs and default argparse behaviour #124094

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb2e693
add clarification about nargs and default
savannahostrowski Sep 14, 2024
16c45cd
fix trailing whitespace
savannahostrowski Sep 14, 2024
770b732
update phrasing for clarity
savannahostrowski Sep 22, 2024
3bfd5ad
appease linter
savannahostrowski Sep 22, 2024
f311d3e
Merge branch 'main' into gh-87358
savannahostrowski Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1123,6 +1123,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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside: we have a (somewhat unusual) convention of using italics for arguments instead of literal code formatting:

https://devguide.python.org/documentation/markup/

But I see we're using literals elsewhere in this file so it's best to be consistent.

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::
Expand Down
Loading