argparse BooleanOptionalAction displays default=SUPPRESS unlike other action types

[abadger]

BPO	44587
Nosy	@rhettinger, @abadger, @ambv, @mhils
PRs	bpo-38956: don't print BooleanOptionalAction's default twice #27672 gh-88753: Make BooleanOptionalAction's addition of default to help more similar to other actions #27808

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2021-07-09.05:07:37.449>
labels = ['type-bug', 'library', '3.11']
title = 'argparse BooleanOptionalAction displays default=SUPPRESS unlike other action types'
updated_at = <Date 2021-09-03.01:01:18.075>
user = 'https://github.com/abadger'

bugs.python.org fields:

activity = <Date 2021-09-03.01:01:18.075>
actor = 'paul.j3'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2021-07-09.05:07:37.449>
creator = 'a.badger'
dependencies = []
files = []
hgrepos = []
issue_num = 44587
keywords = ['patch']
message_count = 4.0
messages = ['397184', '399730', '399731', '399822']
nosy_count = 5.0
nosy_names = ['rhettinger', 'a.badger', 'lukasz.langa', 'paul.j3', 'mhils']
pr_nums = ['27672', '27808']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue44587'
versions = ['Python 3.11']

[abadger]

This is related to https://bugs.python.org/issue38956 but a different symptom (and the current proposed fix for 38956 will not fix this. My proposed fixes for this would also fix 38956).

I have the following code which uses BooleanOptionalAction along with a default of SUPPRESS (I use SUPPRESS because I merge these with settings from config and environment variables and then validate and add default values using a schema. SUPPRESS allows me to tell when a value was not specified at the command line by the user):

    whole_site_parser.add_argument('--indexes',    
                                   dest='indexes', action=BooleanOptionalAction,    
                                   default=argparse.SUPPRESS,    
                                   help='Test')

That code outputs:

--indexes, --no-indexes
Test (default: ==SUPPRESS==)

Similar code that does not use BooleanOptionalAction does not show default: ==SUPPRESS == even when formatter_class=ArgumentDefaultsHelpFormatter is used.

Looking at the code, this is occurring because BooleanOptionalArgument has its own code to add default: on its own (instead of leaving formatting as the responsibility of the formatter_class). The code in BooleanOptionalArgument handles less cases where the default should be skipped than the ArgumentDefaultsHelpFormatter code; SUPPRESS is one of the missing cases.

I can see two ways of fixing this:

(1) Remove the code from BooleanOptionalArgument that adds the default values. It seems to violate the architecture of argparse which delegates modifications to the help message to the formatter_class so this is a special case which could cause issues for future modifications as well.

(2) If the usefulness of outputting the default values without changing the formatter_class is deemed too important to relinquish, then moving the code that ArgumentDefaultsHelpFormatter uses to determine when to skip adding default to the help message can be extracted from ArgumentDefaultsHelpFormatter and called by both ArgumentDefaultsHelpFormatter and BooleanOptionalArgument .

In a review of a fix for https://github.com/python/cpython/pull/17447/files#r429630944 raymond hettinger thought that outputting of the default values was important to keep although I'm not clear on whether he considered that the usefulness comes at the price of possibly violating argparse's architecture. If he hasn't changed his mind, then #2 is probably the way to resolve this.

I can submit a PR for either of these once I know which direction to take (the first is just removing a few lines of code and I've already written the second one since it seemed like the direction that raymond had last asked for).

Please let me know how you'd like me to proceed.

[ambv]

Toshio, as I commented on #71859, that PR was merged because it's a rather trivial improvement over the status quo. I intend to also release this fix in 3.9.7 on August 30th.

Your idea in this issue to further improve the situation while retaining displaying the default value (option 2 described above) is interesting. If you prepare a PR we can work with, I'll look into merging that as well.

[ambv]

Oh, I forgot to say this explicitly: an important reason why the trivial fix was desirable is that it was a clear-cut bugfix, making it easy to backport all the way to the 3.9 branch where BooleanOptionalAction was introduced.

Having this in place, your potential PR here might be a cleaner refactor without having to worry about backporting. Of course, if we manage to keep it small and isolated, we can bring it to 3.9 and 3.10 as well.