bpo-33775: Add the words 'default' and 'version' help text localizable. #12711
Conversation
Co-authored-by: paul.j3
eamanu
changed the title
There was a problem hiding this comment.
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'
|
Dear all, My two cents about this issue, as I would also like to see this PR merged :)
I disagree with this comment: Therefore, passing the whole string to Kind regards, |
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>
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