argparse - subparsers does not retain namespace

[nickpapior]

BPO	27859
Nosy	@ericvw, @Mariatta
Superseder	bpo-9351: argparse set_defaults on subcommands should override top level set_defaults
Files	argparse_subspacenamespace.py: Example showing the crash of the argparse failure. issue27859test.py

^{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 = <Date 2016-10-06.15:46:59.301>
created_at = <Date 2016-08-25.15:02:10.526>
labels = ['type-feature', 'library']
title = 'argparse - subparsers does not retain namespace'
updated_at = <Date 2016-10-06.15:46:59.300>
user = 'https://bugs.python.org/nickpapior'

bugs.python.org fields:

activity = <Date 2016-10-06.15:46:59.300>
actor = 'ned.deily'
assignee = 'none'
closed = True
closed_date = <Date 2016-10-06.15:46:59.301>
closer = 'ned.deily'
components = ['Library (Lib)']
creation = <Date 2016-08-25.15:02:10.526>
creator = 'nickpapior'
dependencies = []
files = ['44222', '44363']
hgrepos = []
issue_num = 27859
keywords = []
message_count = 5.0
messages = ['273654', '274337', '274368', '277936', '278173']
nosy_count = 4.0
nosy_names = ['ericvw', 'paul.j3', 'nickpapior', 'Mariatta']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'resolved'
status = 'closed'
superseder = '9351'
type = 'enhancement'
url = 'https://bugs.python.org/issue27859'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

[nickpapior]

Using argparse does not retain the Namespace variable across sub-parsers.

This prohibits customization of Actions due to "upper" level arguments not being stored in the namespace passed to the sub-parsers.

Hence, one may not create different sub-parsers which depend on an upper level flag.

The reason is the subparser command:
subnamespace, arg_strings = parser.parse_known_args(arg_strings, None)

Which by default passes None as the namespace argument.

A simple patch would be to copy the original namespace, which may then be altered. And subsequently restored, based on changes to that namespace.

[paulj3]

This call used to be

namespace, arg_strings = parser.parse_known_args(arg_strings, namespace)

But in 2014 (2.7.9) http://bugs.python.org/issue9351 was implemented

As noted in the title and comment in the code, the idea was to give more power to the defaults set in the subparser.

But as noted in the subsequent posts, the patch has raised some backward compatibility issues.

Generally having the action for one argument depend on the value of another argument is tricky, because arguments may be parsed in any order. (but there is a 'test_argparse.py' case that does that kind of testing). It is safer to test for any interactions after parsing is all done.

Now in the subparser case, there is an order. Main parser arguments have to come first.

I suggested in 9351 a way of allowing both behaviors - use of new namespace or use of the existing one. But as you can see there hasn't been any further action in the past 2 years.

[paulj3]

I've posted a file that runs your code as you expect.

It uses a custom Action class (like your test case). It subclasses ._SubParsersAction, and replaces the 9351 namespace use with the original one. I use the registry to change the class that parser.add_subparsers() uses.

The stock argparse.py file does not need to be changed.

ps

In your custom Action I access namespace.foo with getattr(namespace, 'foo', None) which is how argparse accesses the namespace, and does not throw attribute errors.

[nickpapior]

Sorry I haven't responded previously.

Thanks a lot for helping me. I hadn't realized the register function.

[Mariatta]

Seems like this can be closed.
Thanks.