Title: Cannot use lazy translation proxies in argparse help · Issue #148468 · python/cpython · GitHub
Open Graph Title: Cannot use lazy translation proxies in argparse help · Issue #148468 · python/cpython
X Title: Cannot use lazy translation proxies in argparse help · Issue #148468 · python/cpython
Description: Bug report Bug description: #142960 introduced a regression for lazy strings in the help= parameter of ArgumentParser.add_argument(). This is used at least by the Sphinx CLI with its _TranslationProxy, at least during testing, where sphi...
Open Graph Description: Bug report Bug description: #142960 introduced a regression for lazy strings in the help= parameter of ArgumentParser.add_argument(). This is used at least by the Sphinx CLI with its _TranslationPr...
X Description: Bug report Bug description: #142960 introduced a regression for lazy strings in the help= parameter of ArgumentParser.add_argument(). This is used at least by the Sphinx CLI with its _TranslationPr...
Opengraph URL: https://github.com/python/cpython/issues/148468
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Cannot use lazy translation proxies in argparse help","articleBody":"# Bug report\n\n### Bug description:\n\nhttps://github.com/python/cpython/pull/142960 introduced a regression for lazy strings in the `help=` parameter of `ArgumentParser.add_argument()`. This is used at least [by the Sphinx CLI](https://github.com/sphinx-doc/sphinx/blob/cc7c6f435ad37bb12264f8118c8461b230e6830c/sphinx/ext/autosummary/generate.py#L898-L900) with its [`_TranslationProxy`](https://github.com/sphinx-doc/sphinx/blob/cc7c6f435ad37bb12264f8118c8461b230e6830c/sphinx/locale/__init__.py#L21-L26), at least during testing, where [`sphinx.locale.init_console` is monkeypatched](https://github.com/sphinx-doc/sphinx/blob/cc7c6f435ad37bb12264f8118c8461b230e6830c/tests/conftest.py#L39).\n\nThe new version of `_expand_help()` calls `re.sub()` on help strings when color is enabled, but `re.sub()` requires an actual str/bytes object and rejects string-like proxies that only implement `__str__`/`__mod__`.\n\n```python\n# mre_argparse_lazy_str.py\n\nimport argparse\n\n\nclass LazyStr:\n \"\"\"Minimal stand-in for gettext lazy-translation objects.\"\"\"\n\n def __init__(self, message: str) -\u003e None:\n self._message = message\n\n def __str__(self) -\u003e str:\n return self._message # resolve lazily\n\n def __mod__(self, other):\n return self._message % other # supports 'help % params'\n\n def __contains__(self, item) -\u003e bool:\n return item in self._message # supports '\"%\" in help'\n\n\np = argparse.ArgumentParser(description='demo')\n# Works fine without color; fails with FORCE_COLOR=1 (or a color TTY):\np.add_argument('--output', default='out.txt', help=LazyStr('write to %(default)s'))\np.parse_args([])\nprint('OK – parsed without error')\n```\n\n```console\n$ uvx -p 3.15.0a4 python mre_argparse_lazy_str.py\nOK – parsed without error\n```\n\n```console\n$ uvx -p 3.15.0a5 python mre_argparse_lazy_str.py\nTraceback (most recent call last):\n File \"/Users/personal/.local/share/uv/python/cpython-3.15.0a5-macos-aarch64-none/lib/python3.15/argparse.py\", line 1822, in _check_help\n formatter._expand_help(action)\n ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^\n File \"/Users/personal/.local/share/uv/python/cpython-3.15.0a5-macos-aarch64-none/lib/python3.15/argparse.py\", line 725, in _expand_help\n return _re.sub(fmt_spec, colorize, help_string, flags=_re.VERBOSE)\n ~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n File \"/Users/personal/.local/share/uv/python/cpython-3.15.0a5-macos-aarch64-none/lib/python3.15/re/__init__.py\", line 206, in sub\n return _compile(pattern, flags).sub(repl, string, count)\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^\nTypeError: expected string or bytes-like object, got 'LazyStr'\n\nThe above exception was the direct cause of the following exception:\n\nTraceback (most recent call last):\n File \"/Users/personal/Contrib/sphinx-doc/sphinx/mre_argparse_lazy_str.py\", line 47, in \u003cmodule\u003e\n p.add_argument('--output', default='out.txt', help=LazyStr('write to %(default)s'))\n ~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n File \"/Users/personal/.local/share/uv/python/cpython-3.15.0a5-macos-aarch64-none/lib/python3.15/argparse.py\", line 1630, in add_argument\n self._check_help(action)\n ~~~~~~~~~~~~~~~~^^^^^^^^\n File \"/Users/personal/.local/share/uv/python/cpython-3.15.0a5-macos-aarch64-none/lib/python3.15/argparse.py\", line 1824, in _check_help\n raise ValueError('badly formed help string') from exc\nValueError: badly formed help string\n```\n\nIf this indeed something CPython rather than Sphinx should fix, the simplest solution would be to coerce `help_string`:\n\n```diff\n- return _re.sub(fmt_spec, colorize, help_string, flags=_re.VERBOSE)\n+ return _re.sub(fmt_spec, colorize, str(help_string), flags=_re.VERBOSE)\n```\n\nand I'd be happy to send a PR if that's the case.\n\n## Related\n\n- https://github.com/python/cpython/issues/142950\n\n### CPython versions tested on:\n\n3.15\n\n### Operating systems tested on:\n\nmacOS\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-150276\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/edgarrmondragon","@type":"Person","name":"edgarrmondragon"},"datePublished":"2026-04-12T19:42:23.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/148468/cpython/issues/148468"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:532e9874-0c78-6f3d-c78f-05d14063805b |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B282:2C87B4:9637A6:CD1980:6A5551C1 |
| html-safe-nonce | c394566b25008fe11e47b00f2f2e7ba28b1ba2333ead25172e64e7097b2bfc06 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMjgyOjJDODdCNDo5NjM3QTY6Q0QxOTgwOjZBNTU1MUMxIiwidmlzaXRvcl9pZCI6Ijg2ODA4NjY1OTc2OTc4MzU0NTciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 24dcf753030f0ca4efb9cc9d07a021b2c12b51655a08ce5ca0ccaf74a9716ffc |
| hovercard-subject-tag | issue:4249692247 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/148468/issue_layout |
| twitter:image | https://opengraph.githubassets.com/bbe3bccabfafbc682b3d6371b2ab18b0af2b4258cd3398cf573a1c393da324b2/python/cpython/issues/148468 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/bbe3bccabfafbc682b3d6371b2ab18b0af2b4258cd3398cf573a1c393da324b2/python/cpython/issues/148468 |
| og:image:alt | Bug report Bug description: #142960 introduced a regression for lazy strings in the help= parameter of ArgumentParser.add_argument(). This is used at least by the Sphinx CLI with its _TranslationPr... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | edgarrmondragon |
| hostname | github.com |
| expected-hostname | github.com |
| None | cd9eea424140838b22e9eabd53d92b5702617ddd6d76efcd3a37f08d44309ca5 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 3084b9f587e8f1e19803bbe0c77ac77ce3c99c5c |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width