Add ArgumentParser.add_mutually_dependence_group

[dongwm]

BPO	23298
Nosy	@bitdancer
Superseder	bpo-11588: Add "necessarily inclusive" groups to argparse
Files	argparse_lib.patch: patch for Lib/argparse.py argparse_doc.patch: patch for Doc/library/argparse.rst argparse_test.patch: patch for Lib/test/test_argparse.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 2017-02-01.02:22:42.311>
created_at = <Date 2015-01-22.05:41:52.422>
labels = ['type-feature', 'library']
title = 'Add ArgumentParser.add_mutually_dependence_group'
updated_at = <Date 2019-04-25.01:07:47.278>
user = 'https://bugs.python.org/dongwm'

bugs.python.org fields:

activity = <Date 2019-04-25.01:07:47.278>
actor = 'martin.panter'
assignee = 'none'
closed = True
closed_date = <Date 2017-02-01.02:22:42.311>
closer = 'paul.j3'
components = ['Library (Lib)']
creation = <Date 2015-01-22.05:41:52.422>
creator = 'dongwm'
dependencies = []
files = ['37814', '37815', '37816']
hgrepos = []
issue_num = 23298
keywords = ['patch']
message_count = 4.0
messages = ['234475', '234495', '238940', '286581']
nosy_count = 4.0
nosy_names = ['bethard', 'r.david.murray', 'paul.j3', 'dongwm']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'closed'
superseder = '11588'
type = 'enhancement'
url = 'https://bugs.python.org/issue23298'
versions = ['Python 3.5']

[dongwm]

Sometimes I need to use argparse like this:

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_dependence_group()
>>> group.add_argument('--foo')
>>> group.add_argument('--bar')
>>> parser.parse_args(['--foo', 'f', '--bar', 'b'])
Namespace(bar='b', foo='f')
>>> parser.parse_args(['--foo', 'f'])
PROG: error: --foo dependence on --bar
>>> parser.parse_args(['--bar', 'b'])
PROG: error: --bar dependence on --foo

I have some optional argument. but if any argument in a group was present on the command line. i need the others must also was present on. so i think add_mutually_dependence_group does make sense.

[bitdancer]

Well, it doesn't make much sense in the English language sense. If I got that error message I'd have no idea what was wrong.

It sounds like what you want to do is dynamically make some arguments be required, depending on whether or not other arguments are present or not.

[paulj3]

http://bugs.python.org/issue11588 is an earlier request for 'necessarily inclusive' groups.

The patches that I proposed there are more general, allowing for other logical combinations of arguments, as well as nesting groups. As such it is more complex than your patch, but the basic testing idea is the same -

At the end of _parse_known_args check the group's actions
against the ones that have been parsed.  I use the existing
'seen_actions' or 'seen_nondefault_actions' rather than 
check the namespace directly.

I also tried to construct this testing as a 'hook' that the user could customize.

Your test, since it uses the Namespace and Action default, rather than the 'seen_actions' set, could just as well be run AFTER parse_args. That's the kind of testing that Stackoverflow answers often suggest for similar questions.

In some cases it's also possible to write custom Action classes that handle this kind of interdependency.

[paulj3]

I propose closing this with reference to http://bugs.python.org/issue11588