bpo-26952: [argparse] clearer error when formatting an empty mutually… (GH-30099)

diff --git a/Lib/argparse.py b/Lib/argparse.py
index b44fa4f0f65c39b9895c1bdc0194a693232ae9fa..8a81801ba923671d3782c18d0502723cc5367a69 100644 (file)
--- a/Lib/argparse.py
+++ b/Lib/argparse.py
@@ -392,6 +392,9 @@ class HelpFormatter(object):
         group_actions = set()
         inserts = {}
         for group in groups:
+            if not group._group_actions:
+                raise ValueError(f'empty group {group}')
+
             try:
                 start = actions.index(group._group_actions[0])
             except ValueError:

diff --git a/Lib/test/test_argparse.py b/Lib/test/test_argparse.py
index f3edde3de8eefba5341f32a9e1f782378b2027d1..eb37d4d365d24e20e54032d7083b1c8b40a8fad1 100644 (file)
--- a/Lib/test/test_argparse.py
+++ b/Lib/test/test_argparse.py
@@ -2601,6 +2601,13 @@ class TestMutuallyExclusiveGroupErrors(TestCase):
               '''
         self.assertEqual(parser.format_help(), textwrap.dedent(expected))
 
+    def test_empty_group(self):
+        # See issue 26952
+        parser = argparse.ArgumentParser()
+        group = parser.add_mutually_exclusive_group()
+        with self.assertRaises(ValueError):
+            parser.parse_args(['-h'])
+
 class MEMixin(object):
 
     def test_failures_when_not_required(self):

diff --git a/Misc/NEWS.d/next/Library/2021-12-14-13-18-45.bpo-26952.hjhISq.rst b/Misc/NEWS.d/next/Library/2021-12-14-13-18-45.bpo-26952.hjhISq.rst
new file mode 100644 (file)
index 0000000..379dbb5
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2021-12-14-13-18-45.bpo-26952.hjhISq.rst
@@ -0,0 +1 @@
+:mod:`argparse` raises :exc:`ValueError` with clear message when trying to render usage for an empty mutually-exclusive group. Previously it raised a cryptic :exc:`IndexError`.
\ No newline at end of file