Skip to content
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

Add support for mutually exclusive groups in argparse #37

Merged
merged 2 commits into from
Oct 27, 2019
Merged

Add support for mutually exclusive groups in argparse #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a905cf0
Add support for mutually exclusive groups
Chris7 Oct 27, 2019
befc5e8
Update tests
Chris7 Oct 27, 2019
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
15 changes: 13 additions & 2 deletions clinto/parsers/argparse_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ class ArgParseNode(object):
"""
This class takes an argument parser entry and assigns it to a Build spec
"""
def __init__(self, action=None):
def __init__(self, action=None, mutex_group=None):
fields = ACTION_CLASS_TO_TYPE_FIELD.get(type(action), TYPE_FIELDS)
field_type = fields.get(action.type)
if field_type is None:
Expand All @@ -161,6 +161,10 @@ def __init__(self, action=None):
if callable(action.type):
field_type = fields[types.FunctionType]
self.node_attrs = dict([(i, field_type[i]) for i in GLOBAL_ATTRS])
self.node_attrs['mutex_group'] = {
'id': mutex_group[0],
'title': mutex_group[1],
} if mutex_group else {}
null_check = field_type['nullcheck'](action)
for attr, attr_dict in six.iteritems(field_type['attr_kwargs']):
if attr_dict is None:
Expand Down Expand Up @@ -291,6 +295,13 @@ def process_parser(self):
nodes = OrderedDict()
containers = OrderedDict()

mutex_groups = {}
mutex_id_map = {}
for mutex_group in parser._mutually_exclusive_groups:
for action in mutex_group._group_actions:
group_id = mutex_id_map.setdefault(id(mutex_group), len(mutex_id_map))
mutex_groups[id(action)] = (group_id, mutex_group.title)

for action in parser._actions:
# The action is the subparser
if isinstance(action, argparse._SubParsersAction):
Expand All @@ -300,7 +311,7 @@ def process_parser(self):
continue
if action.default == argparse.SUPPRESS:
continue
node = ArgParseNode(action=action)
node = ArgParseNode(action=action, mutex_group=mutex_groups.get(id(action)))
container = action.container.title
container_node = containers.get(container, None)
if container_node is None:
Expand Down
15 changes: 15 additions & 0 deletions clinto/tests/argparse_scripts/mutually_exclusive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import argparse
import sys
import six

parser = argparse.ArgumentParser(description="Something")
group = parser.add_mutually_exclusive_group()
group.add_argument('--foo', action='store_true')
group.add_argument('--bar', action='store_false')
group2 = parser.add_mutually_exclusive_group()
group2.add_argument('--foo2', action='store_true')
group2.add_argument('--bar2', action='store_false')

if __name__ == '__main__':
args = parser.parse_args()
sys.stdout.write('{}'.format(args))
45 changes: 40 additions & 5 deletions clinto/tests/test_parsers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ def test_argparse_script(self):
{
'nodes': [
{'param_action': set([]), 'name': 'first_pos', 'required': True, 'param': '', 'choices': None,
'choice_limit': None, 'model': 'CharField', 'type': 'text', 'help': None},
'choice_limit': None, 'model': 'CharField', 'type': 'text', 'help': None, 'mutex_group': {},},
{'param_action': set([]), 'name': 'second-pos', 'required': True, 'param': '', 'choices': None,
'choice_limit': None, 'model': 'CharField', 'type': 'text', 'help': None}
'choice_limit': None, 'model': 'CharField', 'type': 'text', 'help': None, 'mutex_group': {},}
],
'group': 'positional arguments'
}
Expand Down Expand Up @@ -117,7 +117,8 @@ def test_function_type_script(self):
'type': 'text',
'help': 'Use date in format YYYYMMDD (e.g. 20180131)',
# The default argument
'value': '20180131'
'value': '20180131',
'mutex_group': {},
},
{
'param_action': set([]),
Expand All @@ -129,7 +130,8 @@ def test_function_type_script(self):
'choice_limit': None,
'model': 'CharField',
'type': 'text',
'help': 'Lowercase it'
'help': 'Lowercase it',
'mutex_group': {},
}

],
Expand Down Expand Up @@ -160,11 +162,44 @@ def test_zipapp(self):
{
'nodes': [
{'param_action': set([]), 'name': 'n', 'required': False, 'param': '-n', 'choices': None, 'value': -1,
'choice_limit': None, 'model': 'IntegerField', 'type': 'text', 'help': 'The number of rows to read.'}],
'choice_limit': None, 'model': 'IntegerField', 'type': 'text', 'help': 'The number of rows to read.', 'mutex_group': {},}],
'group': 'optional arguments',
}
)

def test_mutually_exclusive_groups(self):
script_path = os.path.join(self.script_dir, 'mutually_exclusive.py')
parser = Parser(script_path=script_path)
script_params = parser.get_script_description()
self.assertDictEqual(
script_params['inputs'][''][0],
{
'nodes': [
{
'model': 'BooleanField', 'type': 'checkbox', 'mutex_group': {'id': 0, 'title': None},
'name': 'foo', 'required': False, 'help': None, 'param': '--foo', 'param_action': set(),
'choices': None, 'choice_limit': 0, 'checked': False,
},
{
'model': 'BooleanField', 'type': 'checkbox', 'mutex_group': {'id': 0, 'title': None},
'name': 'bar', 'required': False, 'help': None, 'param': '--bar', 'param_action': set(),
'choices': None, 'choice_limit': 0, 'checked': True,
},
{
'model': 'BooleanField', 'type': 'checkbox', 'mutex_group': {'id': 1, 'title': None},
'name': 'foo2', 'required': False, 'help': None, 'param': '--foo2', 'param_action': set(),
'choices': None, 'choice_limit': 0, 'checked': False,
},
{
'model': 'BooleanField', 'type': 'checkbox', 'mutex_group': {'id': 1, 'title': None},
'name': 'bar2', 'required': False, 'help': None, 'param': '--bar2', 'param_action': set(),
'choices': None, 'choice_limit': 0, 'checked': True,
},
],
'group': 'optional arguments',
},
)


class TestDocOpt(unittest.TestCase):
def setUp(self):
Expand Down