Skip to content

gh-155403: Document that store_true/store_false are affected by argument_default #155404

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

Closed
shoutoutuoadi325 wants to merge 1 commit into from
+9 −1
Closed

gh-155403: Document that store_true/store_false are affected by argument_default #155404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,14 +780,20 @@ how the command-line arguments should be handled. The supplied actions are:
* ``'store_true'`` and ``'store_false'`` - These are special cases of
``'store_const'`` that respectively store the values ``True`` and ``False``
with default values of ``False`` and
``True``::
``True``. Note that if ``argument_default`` is set to ``SUPPRESS``,
these defaults are also suppressed::

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)
>>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.parse_args('--foo'.split())
Namespace(foo=True) # bar and baz are suppressed (not present)
Comment on lines +792 to +796

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Mention only arguments registered on the second parser

The second example replaces parser and registers only foo and bar, so baz is not suppressed—it does not exist on this parser at all. This makes the new explanation factually misleading; either register baz again or state only that bar is suppressed.

Useful? React with 👍 / 👎.


* ``'append'`` - This appends each argument value to a list.
It is useful for allowing an option to be specified multiple times.
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2026-08-09-12-00-00.gh-issue-155403.wX8kR2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document that ``'store_true'`` and ``'store_false'`` defaults are affected by
``argument_default`` in the :mod:`argparse` documentation.
Loading