Provide i18n with gettext

[evgeny-p]

It would be useful to wrap every public message with gettext function to allow i18n for application.

[b1kers]

• 1

[lapause]

+1

For those interrested, I've made a gist showing how to catch click exceptions and translate them.
It's quick and dirty (use regexps), but right now it does the job:

https://gist.github.com/lapause/ed148b2b1481f83f39c5

To core developers: if you don't want to implement i18n, you could create one exception class by error type (±3 inheriting from UsageError, ±14 from BadParameter) and use attributes to store dynamic elements (parameter and file names/types.... By doing so it would allow developers to just trap exceptions of interrest to them and re-raise them with customized messages without having to mess with regexps depending of the exact messages used by the library.

To core developers (2): I'm pretty sure my monkey patching of the click.Command.main is not the best way to go, but http://click.pocoo.org/4/exceptions/ could really benefit from a real life example of how to invoke directly a command declared with multiple arguments, decorators...

[untitaker]

1. Agreed, I'd like to see this too. However, I suppose this would also require a much more fine-grained exception hierarchy, one class for each error message. Right now some parts of click raise such generic ones as RuntimeError.
2. I think you're supposed to subclass Command so you can override main properly, and then pass the subclass like @click.command(cls=TranslatingCommand).

[Un1oR]

+1

[warsaw]

I'm playing around with click in Mailman 3 to replace our homegrown cli parsing code. All of our help text is marked with _() and we use flufl.i18n to do the actual run time translations. I may have more opinions as I get farther along, but for now I don't see any real problem with option help text. E.g. this works fine:

@click.option(
    '-v', '--verbose',
    is_flag=True, default=False,
    help=_('Display more debugging information to the log file.'))

It gets tricky in one place: use of the function's docstring for the help prologue. Python only assigns unadorned strings to __doc__. So there's no good way to mark the help prologue for translation, extraction and also use it in click.

Of course, I might be missing a lot as I've just started digging in. ;)

[thechief389]

Should this be implemented in click itself or as part of click-contrib?

Also, command() and group() have help parameters so you could do

@click.command(cls=TranslatingCommand, help=_('translatable string'))
def func():
    # No docstring here.
    pass

[davidism]

This issue appears to be asking for i18n on Click's internal messages, such as exception strings. There should be nothing preventing use of i18n on your own strings.

[thechief389]

What I meant was should this be built into click or should there be a separate library?

[davidism]

What you're showing isn't related to what's being asked for. Nothing has to change for what you're showing. Internal message have to be wrapped for what's being asked for.

[thechief389]

I'm asking if translating the strings should be built in.