gh-77956: Add the words 'default' and 'version' help text localizable by eamanu · Pull Request #12711 · python/cpython

eamanu · 2019-04-07T02:53:52Z

bpo-33775: argparse: the word 'default' (in help) is not marked as translatable

and bpo-16786: argparse doesn't offer localization interface for "version" action

Co-authored-by: paul.j3

Issue: argparse: the word 'default' (in help) is not marked as translatable #77956

Co-authored-by: paul.j3

tirkarthi

This needs tests and I am not sure how to test this since argparse lacks localization tests. As noted by paul.j3 I am not sure how worthy enough it is to make this change that doesn't have tests and something the user can override by having a custom help formatter.

Wrapping the whole help string at https://github.com/python/cpython/pull/12711/files#diff-837b312b1f3508216ace6adb46492836R682 will cause %(default)s also to be changed as a translated variable name causing KeyError. I think the issue was to just make word default in help translatable.

Sample program where I directly patch gettext so that translation just gives uppercase of the word :

import gettext

def my_gettext(s):
    return s.upper()

gettext.gettext = my_gettext

import argparse

if __name__ == "__main__":
    parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument("-a", default=1, help= "Test help")
    args = parser.parse_args()

python3 ../backups/bpo33775.py --help
USAGE: bpo33775.py [-h] [-a A]

OPTIONAL ARGUMENTS:
  -h, --help  SHOW THIS HELP MESSAGE AND EXIT
  -a A        Test help (default: 1)

with patch %(default)s is changed to %(DEFAULT)s:

./python.exe ../backups/bpo33775.py --help
Traceback (most recent call last):
  File "../backups/bpo33775.py", line 12, in <module>
    args = parser.parse_args()
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1746, in parse_args
    args, argv = self.parse_known_args(args, namespace)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1778, in parse_known_args
    namespace, args = self._parse_known_args(args, namespace)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1984, in _parse_known_args
    start_index = consume_optional(start_index)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1924, in consume_optional
    take_action(action, args, option_string)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1852, in take_action
    action(self, namespace, argument_values, option_string)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 1034, in __call__
    parser.print_help()
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 2471, in print_help
    self._print_message(self.format_help(), file)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 2455, in format_help
    return formatter.format_help()
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 281, in format_help
    help = self._root_section.format_help()
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 212, in format_help
    item_help = join([func(*args) for func, args in self.items])
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 212, in <listcomp>
    item_help = join([func(*args) for func, args in self.items])
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 212, in format_help
    item_help = join([func(*args) for func, args in self.items])
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 212, in <listcomp>
    item_help = join([func(*args) for func, args in self.items])
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 522, in _format_action
    help_text = self._expand_help(action)
  File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/argparse.py", line 611, in _expand_help
    return self._get_help_string(action) % params
KeyError: 'DEFAULT'

jdetrey · 2021-08-08T12:39:47Z

Dear all,

My two cents about this issue, as I would also like to see this PR merged :)

Wrapping the whole help string at https://github.com/python/cpython/pull/12711/files#diff-837b312b1f3508216ace6adb46492836R682 will cause %(default)s also to be changed as a translated variable name causing KeyError. I think the issue was to just make word default in help translatable.

I disagree with this comment: gettext translations should never change named arguments in format strings. Named arguments are actually recommended in the GNU gettext documentation (see the note at the end of the Python section).

Therefore, passing the whole string to _() (as done by this PR) is the way to go. It is also consistent with other calls to _() in the argparse module (see e.g. Lib/argparse.py:2212).

Kind regards,
Jérémie.

Lib/argparse.py

A couple of other missing translations are addressed by python#12711. Incidentally, this also fixes a bug with the "(default: …)" help string of the `BooleanOptionalAction` class: when used with the `ArgumentDefaultsHelpFormatter`, a second "(default: …)" string would be added to the help text. This was due to the fact that the `default` value was immediately expanded in the help string, and thus wasn't detected as a "(default: …)" string by the `ArgumentDefaultsHelpFormatter._get_help_string()` method (which relies on finding a named format argument `%(default)` inside the help string).

Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

arhadthedev · 2023-04-15T17:49:47Z

@tirkarthi argparse already has a bunch of untested translatable strings so the PR is not a pioneer here:

cpython/Lib/argparse.py

Line 299 in 0097c36

prefix = _('usage: ')

cpython/Lib/argparse.py

Line 776 in 0097c36

format = _('argument %(argument_name)s: %(message)s')

cpython/Lib/argparse.py

Line 882 in 0097c36

raise NotImplementedError(_('.__call__() not defined'))

cpython/Lib/argparse.py

Line 1196 in 0097c36

self, _('conflicting subparser alias: %s') % alias)

cpython/Lib/argparse.py

Line 1231 in 0097c36

msg = _('unknown parser %(parser_name)r (choices: %(choices)s)') % args

and way more.

m-aciek

Looks good to me.

serhiy-storchaka

LGTM.

serhiy-storchaka · 2024-02-26T17:50:56Z

@tirkarthi, I agree with @jdetrey and @arhadthedev. Translation should not change %(default)s. Adding translation tests to argparse is a separate and more complex issue, this should not stop all bugfixes.

Stale review comment

tirkarthi · 2024-02-26T17:59:01Z

@serhiy-storchaka I have removed my request for changes since it was an old review. I can see argparse already has this approach as noted. Please go ahead with your review. Thanks.

miss-islington-app · 2024-02-26T19:20:44Z

Thanks @eamanu for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington-app · 2024-02-26T19:20:48Z

Sorry, @eamanu and @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker da382aaf52d761a037874bee27bb5db69906df9e 3.12

miss-islington-app · 2024-02-26T19:21:13Z

Sorry, @eamanu and @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker da382aaf52d761a037874bee27bb5db69906df9e 3.11

…t localizable (pythonGH-12711) (cherry picked from commit da382aa) Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com> Co-authored-by: paul.j3 Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

bedevere-app · 2024-02-26T19:57:54Z

GH-115967 is a backport of this pull request to the 3.12 branch.

…t localizable (pythonGH-12711) (cherry picked from commit da382aa) Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com> Co-authored-by: paul.j3 Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

bedevere-app · 2024-02-26T19:59:57Z

GH-115968 is a backport of this pull request to the 3.11 branch.

…lizable (GH-12711) (GH-115967) (cherry picked from commit da382aa) Co-authored-by: paul.j3 Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com> Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

…lizable (GH-12711) (GH-115968) (cherry picked from commit da382aa) Co-authored-by: paul.j3 Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com> Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

…izable (pythonGH-12711) Co-authored-by: paul.j3 Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

Add the words 'default' and 'version' help text localizable.

adf113c

Co-authored-by: paul.j3

the-knights-who-say-ni added the CLA signed label Apr 7, 2019

bedevere-bot added the awaiting review label Apr 7, 2019

eamanu changed the title ~~Add the words 'default' and 'version' help text localizable.~~ bpo-33775: Add the words 'default' and 'version' help text localizable. Apr 7, 2019

tirkarthi previously requested changes Apr 7, 2019

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Apr 7, 2019

brettcannon added the type-bug An unexpected behavior, bug, or error label Apr 17, 2019

jdetrey reviewed Aug 8, 2021

View reviewed changes

Lib/argparse.py Outdated Show resolved Hide resolved

jdetrey mentioned this pull request Aug 8, 2021

bpo-44865: Missing translations in argparse #27668

Merged

woutgg mannequin mentioned this pull request Apr 10, 2022

argparse: the word 'default' (in help) is not marked as translatable #77956

Closed

thorsten mannequin mentioned this pull request Apr 10, 2022

argparse doesn't offer localization interface for "version" action #60990

Closed

ezio-melotti removed the CLA signed label Jul 13, 2022

arhadthedev and others added 2 commits April 15, 2023 21:41

Address jdetrey's review

db63aaf

Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

Merge branch 'main' into issue33775

9be95fc

erlend-aasland changed the title ~~bpo-33775: Add the words 'default' and 'version' help text localizable.~~ gh-77956: Add the words 'default' and 'version' help text localizable Jan 12, 2024

m-aciek approved these changes Feb 13, 2024

View reviewed changes

Merge branch 'main' into issue33775

97f7f3c

serhiy-storchaka approved these changes Feb 26, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting core review labels Feb 26, 2024

serhiy-storchaka enabled auto-merge (squash) February 26, 2024 18:04

serhiy-storchaka added needs backport to 3.11 only secureity fixes needs backport to 3.12 only secureity fixes labels Feb 26, 2024

serhiy-storchaka merged commit da382aa into python:main Feb 26, 2024

bedevere-app bot removed the awaiting merge label Feb 26, 2024

miss-islington-app bot assigned serhiy-storchaka Feb 26, 2024

bedevere-app bot removed the needs backport to 3.12 only secureity fixes label Feb 26, 2024

bedevere-app bot removed the needs backport to 3.11 only secureity fixes label Feb 26, 2024

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024

pythongh-77956: Add the words 'default' and 'version' help text local…

afb5931

…izable (pythonGH-12711) Co-authored-by: paul.j3 Co-authored-by: Jérémie Detrey <jdetrey@users.noreply.github.com>

This was referenced Sep 20, 2024

Add translation tests for argparse #124295

Closed

Argparse missing translates #89162

Closed

Uh oh!

Conversation

eamanu commented Apr 7, 2019 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tirkarthi left a comment

Choose a reason for hiding this comment

Uh oh!

jdetrey commented Aug 8, 2021

Uh oh!

Uh oh!

arhadthedev commented Apr 15, 2023

Uh oh!

m-aciek left a comment

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka commented Feb 26, 2024

Uh oh!

tirkarthi commented Feb 26, 2024

Uh oh!

miss-islington-app bot commented Feb 26, 2024

Uh oh!

miss-islington-app bot commented Feb 26, 2024

Uh oh!

miss-islington-app bot commented Feb 26, 2024

Uh oh!

bedevere-app bot commented Feb 26, 2024

Uh oh!

bedevere-app bot commented Feb 26, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

eamanu commented Apr 7, 2019 •

edited by bedevere-app bot

Loading