Merge pull request #13 from roopahc/AllOptionGroup

Added a feature AllOptionGroup

Author: espdev

click_option_group/__init__.py

@@ -15,6 +15,7 @@
     GroupedOption,
     OptionGroup,
     RequiredAnyOptionGroup,
+    AllOptionGroup,
     RequiredAllOptionGroup,
     MutuallyExclusiveOptionGroup,
     RequiredMutuallyExclusiveOptionGroup,
@@ -29,6 +30,7 @@
     'GroupedOption',
     'OptionGroup',
     'RequiredAnyOptionGroup',
+    'AllOptionGroup',
     'RequiredAllOptionGroup',
     'MutuallyExclusiveOptionGroup',
     'RequiredMutuallyExclusiveOptionGroup',

click_option_group/_core.py

@@ -351,3 +351,30 @@ def handle_parse_result(self, option: GroupedOption, ctx: click.Context, opts: d
                           f'"{self.get_default_name(ctx)}" option group:')
             error_text += f'\n{self.get_error_hint(ctx)}'
             raise click.UsageError(error_text, ctx=ctx)
+
+
+class AllOptionGroup(OptionGroup):
+    """Option group with required all/none options of this group
+
+    `AllOptionGroup` defines the behavior:
+    - All options from the group must be set or None must be set.
+    """
+
+    @property
+    def forbidden_option_attrs(self) -> ty.List[str]:
+        return ['required', 'hidden']
+
+    @property
+    def name_extra(self) -> ty.List[str]:
+        return super().name_extra + ['all_or_none']
+
+    def handle_parse_result(self, option: GroupedOption, ctx: click.Context, opts: dict) -> None:
+        option_names = set(self.get_options(ctx))
+
+        if not option_names.isdisjoint(opts) and option_names.intersection(opts) != option_names:
+            error_text = f'All options should be specified or None should be specified from the group ' \
+                         f'"{self.get_default_name(ctx)}".'
+            error_text += f'\nMissing required options from "{self.get_default_name(ctx)}" option group.'
+            error_text += f'\n{self.get_error_hint(ctx)}'
+            error_text += '\n'
+            raise click.UsageError(error_text, ctx=ctx)

docs/api.rst

@@ -79,6 +79,11 @@ API Reference
 
 ----
 
+.. autoclass:: AllOptionGroup
+    :members:
+
+----
+
 .. autoclass:: RequiredAllOptionGroup
     :members:
 

tests/test_click_option_group.py

@@ -10,6 +10,7 @@
     OptionGroup,
     GroupedOption,
     RequiredAnyOptionGroup,
+    AllOptionGroup,
     RequiredAllOptionGroup,
     MutuallyExclusiveOptionGroup,
     RequiredMutuallyExclusiveOptionGroup,
@@ -282,6 +283,36 @@ def cli(foo, bar):
     assert 'foo,bar' in result.output
 
 
+def test_all_option_group(runner):
+    group = AllOptionGroup()
+    assert group.name_extra == ['all_or_none']
+
+    @click.command()
+    @optgroup.group(cls=AllOptionGroup)
+    @optgroup.option('--foo')
+    @optgroup.option('--bar')
+    def cli(foo, bar):
+        click.echo(f'{foo},{bar}')
+    result = runner.invoke(cli, ['--help'])
+    assert '[all_or_none]' in result.output
+
+    result = runner.invoke(cli, [])
+    assert not result.exception
+    assert result.exit_code == 0
+
+    result = runner.invoke(cli, ['--foo', 'foo'])
+    assert result.exception
+    assert result.exit_code == 2
+    assert 'All options should be specified or None should be specified from the group' in result.output
+    assert '--foo' in result.output
+    assert '--bar' in result.output
+
+    result = runner.invoke(cli, ['--foo', 'foo', '--bar', 'bar'])
+    assert not result.exception
+    assert result.exit_code == 0
+    assert 'foo,bar' in result.output
+
+
 def test_required_all_option_group(runner):
     group = RequiredAllOptionGroup()
     assert group.name_extra == ['required_all']