Thanks to visit codestin.com
Credit goes to github.com

Skip to content

GH-127133: Remove ability to nest argument groups & mutually exclusive groups #127186

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

Merged
iritkatriel merged 12 commits into from
Nov 24, 2024
Merged

GH-127133: Remove ability to nest argument groups & mutually exclusive groups #127186

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e9bf875
Remove functionality and update docs
savannahostrowski Nov 23, 2024
41464a5
Change error type
savannahostrowski Nov 23, 2024
b9f3e4d
📜🤖 Added by blurb_it.
blurb-it[bot] Nov 23, 2024
76aadc6
Add PR number
savannahostrowski Nov 23, 2024
17556c0
Merge branch 'main' into gh-127133
savannahostrowski Nov 23, 2024
1673277
Fix sphinx
savannahostrowski Nov 23, 2024
baed27b
Fix refs in whatsnew
savannahostrowski Nov 23, 2024
813a2f5
Fix references in news entry
savannahostrowski Nov 23, 2024
6c837ab
precommit
savannahostrowski Nov 23, 2024
d835745
Apply suggestions from code review
savannahostrowski Nov 24, 2024
9708536
Reframe docs to focus on exception
savannahostrowski Nov 24, 2024
c55dbee
Fix test exception messages
savannahostrowski Nov 24, 2024
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
Prev Previous commit
Next Next commit
Change error type
  • Loading branch information
@savannahostrowski
savannahostrowski committed Nov 23, 2024
commit 41464a52f0c357a0bd4fd41652807e2eadf15f40
6 changes: 6 additions & 0 deletions Lib/argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,6 +1708,9 @@ def _remove_action(self, action):
super(_ArgumentGroup, self)._remove_action(action)
self._group_actions.remove(action)

def add_argument_group(self, *args, **kwargs):
raise ValueError('nested argument groups are not supported')
Comment thread
savannahostrowski marked this conversation as resolved.
Outdated
Comment thread
savannahostrowski marked this conversation as resolved.
Outdated

class _MutuallyExclusiveGroup(_ArgumentGroup):

def __init__(self, container, required=False):
Expand All @@ -1727,6 +1730,9 @@ def _remove_action(self, action):
self._container._remove_action(action)
self._group_actions.remove(action)

def add_mutually_exclusive_group(self, **kwargs):
raise ValueError('nested mutually exclusive groups are not supported')
Comment thread
savannahostrowski marked this conversation as resolved.
Outdated

def _prog_name(prog=None):
if prog is not None:
return prog
Expand Down
15 changes: 15 additions & 0 deletions Lib/test/test_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2954,6 +2954,13 @@ def test_group_prefix_chars_default(self):
self.assertEqual(msg, str(cm.warning))
self.assertEqual(cm.filename, __file__)

def test_nested_argument_group(self):
parser = argparse.ArgumentParser()
g = parser.add_argument_group()
self.assertRaisesRegex(ValueError,
'nested argument groups are not supported',
g.add_argument_group)

# ===================
# Parent parser tests
# ===================
Expand Down Expand Up @@ -3254,6 +3261,14 @@ def test_empty_group(self):
with self.assertRaises(ValueError):
parser.parse_args(['-h'])

def test_nested_mutex_groups(self):
parser = argparse.ArgumentParser(prog='PROG')
g = parser.add_mutually_exclusive_group()
g.add_argument("--spam")
self.assertRaisesRegex(ValueError,
'nested mutually exclusive groups are not supported',
g.add_mutually_exclusive_group)
Comment thread
savannahostrowski marked this conversation as resolved.
Outdated

class MEMixin(object):

def test_failures_when_not_required(self):
Expand Down