From 2e5ddb8c4902b44fa9940857b3edac6740cfe01b Mon Sep 17 00:00:00 2001 From: Savannah Ostrowski Date: Thu, 30 Jul 2026 08:59:59 -0700 Subject: [PATCH] GH-148468: Accept string-like proxy objects in colorized argparse help (GH-154653) (cherry picked from commit a147366eb74ca3afd5953069d209de7ea6b5da0f) Co-authored-by: Savannah Ostrowski Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- Lib/argparse.py | 2 +- Lib/test/test_argparse.py | 35 +++++++++++++++++++ ...-07-24-21-49-45.gh-issue-148468.pHoF_Q.rst | 1 + 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 Misc/NEWS.d/next/Library/2026-07-24-21-49-45.gh-issue-148468.pHoF_Q.rst diff --git a/Lib/argparse.py b/Lib/argparse.py index 42891516b3bb2a..c5e3ffe74c0629 100644 --- a/Lib/argparse.py +++ b/Lib/argparse.py @@ -711,7 +711,7 @@ def _format_args(self, action, default_metavar): return result def _expand_help(self, action): - help_string = self._get_help_string(action) + help_string = str(self._get_help_string(action)) if '%' not in help_string: return self._apply_text_markup(help_string) params = dict(vars(action), prog=self._prog) diff --git a/Lib/test/test_argparse.py b/Lib/test/test_argparse.py index fbeb933841129e..dc3c6cfe12db15 100644 --- a/Lib/test/test_argparse.py +++ b/Lib/test/test_argparse.py @@ -7893,6 +7893,41 @@ def test_backtick_markup_in_argument_help_color_disabled(self): self.assertIn("set the `foo` value", help_text) self.assertNotIn("\x1b[", help_text) + def test_argument_help_interpolation_accepts_string_like_proxy(self): + class LazyStr: + def __init__(self, message): + self._message = message + + def __str__(self): + return self._message + + def __getattr__(self, name): + return getattr(str(self), name) + + def __contains__(self, item): + return item in self._message + + def __mod__(self, other): + return self._message % other + + parser = argparse.ArgumentParser(prog="PROG", color=True) + parser.add_argument( + "--foo", + default="bar", + help=LazyStr("foo (default: %(default)s)"), + ) + parser.add_argument( + "--baz", + help=LazyStr("baz plain text"), + ) + + interp = self.theme.interpolated_value + reset = self.theme.reset + + help_text = parser.format_help() + self.assertIn(f"foo (default: {interp}bar{reset})", help_text) + self.assertIn("baz plain text", help_text) + def test_help_with_format_specifiers(self): # GH-142950: format specifiers like %x should work with color=True parser = argparse.ArgumentParser(prog='PROG', color=True) diff --git a/Misc/NEWS.d/next/Library/2026-07-24-21-49-45.gh-issue-148468.pHoF_Q.rst b/Misc/NEWS.d/next/Library/2026-07-24-21-49-45.gh-issue-148468.pHoF_Q.rst new file mode 100644 index 00000000000000..d1d0deb139bc20 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2026-07-24-21-49-45.gh-issue-148468.pHoF_Q.rst @@ -0,0 +1 @@ +Fix a regression in :mod:`argparse` where colorized argument help containing format specifiers did not accept string-like proxy objects.