Oct 14, 2024 · Sep 25, 2024 · Oct 14, 2024
diff --git a/Lib/argparse.py b/Lib/argparse.py
        if action.metavar is not None:
            result = action.metavar
        elif action.choices is not None:
            choice_strs = [str(choice) for choice in action.choices]
            result = '{%s}' % ','.join(choice_strs)
            result = '{%s}' % ','.join(map(str, action.choices))
        else:
            result = default_metavar

            elif hasattr(value, '__name__'):
                params[name] = value.__name__
        if params.get('choices') is not None:
            choices_str = ', '.join([str(c) for c in params['choices']])
            params['choices'] = choices_str
            params['choices'] = ', '.join(map(str, params['choices']))
        return help_string % params

    def _iter_indented_subactions(self, action):
    elif argument.dest not in (None, SUPPRESS):
        return argument.dest
    elif argument.choices:
        return '{' + ','.join(argument.choices) + '}'
        return '{%s}' % ','.join(map(str,argument.choices))
    else:
        return None

            if isinstance(choices, str):
                choices = iter(choices)
            if value not in choices:
                args = {'value': value,
                        'choices': ', '.join(map(repr, action.choices))}
                args = {'value':str(value),
                        'choices': ', '.join(map(str, action.choices))}
                msg = _('invalid choice: %(value)r (choose from %(choices)s)')
                raise ArgumentError(action, msg % args)

diff --git a/Lib/test/test_argparse.py b/Lib/test/test_argparse.py
 import argparse
 import warnings

 from enum import StrEnum
 from test.support import captured_stderr
 from test.support import import_helper
 from test.support import os_helper
    ]


 class TestStrEnumChoices(TestCase):
    class Color(StrEnum):
        RED = "red"
        GREEN = "green"
        BLUE = "blue"

    def test_parse_enum_value(self):
        parser = argparse.ArgumentParser()
        parser.add_argument('--color', choices=self.Color)
        args = parser.parse_args(['--color', 'red'])
        self.assertEqual(args.color, self.Color.RED)

    def test_help_message_contains_enum_choices(self):
        parser = argparse.ArgumentParser()
        parser.add_argument('--color', choices=self.Color, help='Choose a color')
        self.assertIn('[--color {red,green,blue}]', parser.format_usage())
        self.assertIn('  --color {red,green,blue}', parser.format_help())

    def test_invalid_enum_value_raises_error(self):
        parser = argparse.ArgumentParser(exit_on_error=False)
        parser.add_argument('--color', choices=self.Color)
        self.assertRaisesRegex(
            argparse.ArgumentError,
            r"invalid choice: 'yellow' \(choose from red, green, blue\)",
            parser.parse_args,
            ['--color', 'yellow'],
        )

 # ================
 # Positional tests
 # ================
            parser.parse_args(('baz',))
        self.assertRegex(
            excinfo.exception.stderr,
            r"error: argument {foo,bar}: invalid choice: 'baz' \(choose from'foo', 'bar'\)\n$"
            r"error: argument {foo,bar}: invalid choice: 'baz' \(choose from foo,bar\)\n$"
        )

    def test_optional_subparsers(self):
diff --git a/Misc/NEWS.d/next/Library/2024-04-19-05-58-50.gh-issue-117766.J3xepp.rst b/Misc/NEWS.d/next/Library/2024-04-19-05-58-50.gh-issue-117766.J3xepp.rst
 Always use :func:`str` to print ``choices`` in :mod:`argparse`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -547,8 +547,7 @@ def _metavar_formatter(self, action, default_metavar):
		if action.metavar is not None:
		result = action.metavar
		elif action.choices is not None:
		choice_strs = [str(choice) for choice in action.choices]
		result = '{%s}' % ','.join(choice_strs)
		result = '{%s}' % ','.join(map(str, action.choices))
		else:
		result = default_metavar

Expand DownExpand Up		@@ -599,8 +598,7 @@ def _expand_help(self, action):
		elif hasattr(value, '__name__'):
		params[name] = value.__name__
		if params.get('choices') is not None:
		choices_str = ', '.join([str(c) for c in params['choices']])
		params['choices'] = choices_str
		params['choices'] = ', '.join(map(str, params['choices']))
		return help_string % params

		def _iter_indented_subactions(self, action):
Expand DownExpand Up		@@ -717,7 +715,7 @@ def _get_action_name(argument):
		elif argument.dest not in (None, SUPPRESS):
		return argument.dest
		elif argument.choices:
		return '{' + ','.join(argument.choices) + '}'
		return '{%s}' % ','.join(map(str,argument.choices))
		else:
		return None

Expand DownExpand Up		@@ -2607,8 +2605,8 @@ def _check_value(self, action, value):
		if isinstance(choices, str):
		choices = iter(choices)
		if value not in choices:
		args = {'value': value,
		'choices': ', '.join(map(repr, action.choices))}
		args = {'value':str(value),
		'choices': ', '.join(map(str, action.choices))}
		msg = _('invalid choice: %(value)r (choose from %(choices)s)')
		raise ArgumentError(action, msg % args)

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,6 +16,7 @@
		import argparse
		import warnings

		from enum import StrEnum
		from test.support import captured_stderr
		from test.support import import_helper
		from test.support import os_helper
Expand DownExpand Up		@@ -985,6 +986,34 @@ class TestDisallowLongAbbreviationAllowsShortGroupingPrefix(ParserTestCase):
		]


		class TestStrEnumChoices(TestCase):
		class Color(StrEnum):
		RED = "red"
		GREEN = "green"
		BLUE = "blue"

		def test_parse_enum_value(self):
		parser = argparse.ArgumentParser()
		parser.add_argument('--color', choices=self.Color)
		args = parser.parse_args(['--color', 'red'])
		self.assertEqual(args.color, self.Color.RED)

		def test_help_message_contains_enum_choices(self):
		parser = argparse.ArgumentParser()
		parser.add_argument('--color', choices=self.Color, help='Choose a color')
		self.assertIn('[--color {red,green,blue}]', parser.format_usage())
		self.assertIn(' --color {red,green,blue}', parser.format_help())

		def test_invalid_enum_value_raises_error(self):
		parser = argparse.ArgumentParser(exit_on_error=False)
		parser.add_argument('--color', choices=self.Color)
		self.assertRaisesRegex(
		argparse.ArgumentError,
		r"invalid choice: 'yellow' \(choose from red, green, blue\)",
		parser.parse_args,
		['--color', 'yellow'],
		)

		# ================
		# Positional tests
		# ================
Expand DownExpand Up		@@ -2485,7 +2514,7 @@ def test_wrong_argument_subparsers_no_destination_error(self):
		parser.parse_args(('baz',))
		self.assertRegex(
		excinfo.exception.stderr,
		r"error: argument {foo,bar}: invalid choice: 'baz' \(choose from'foo', 'bar'\)\n$"
		r"error: argument {foo,bar}: invalid choice: 'baz' \(choose from foo,bar\)\n$"
		)

		def test_optional_subparsers(self):
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Always use :func:`str` to print ``choices`` in :mod:`argparse`.