Recent commits to derivepassphrase.git (2aa16e5903369994e0df761a1061f007e945f596)

Merge topic branch 'i18n-l10n-infrastructure' into master

2025-01-01T00:17:28+01:00

* t/i18n-l10n-infrastructure:
  Add a changelog entry for the new i18n/l10n infrastructure
  Fix coverage
  Reimplement `--help` and `--version` options in a translatable way
  Replace strings in `derivepassphrase export vault` with translatable ones
  Force logging calls in error callback to be uninterpolated
  Provide a function to reload translations for derivepassphrase
  Add a writer function for derivepassphrase's .po template
  Fix some translation typos and inconsistent translation comments
  Update the CLI to use the translatable strings
  Add more translatable strings and serialization machinery
  Extract translatable log messages into separate module
  Add an actual derivepassphrase-vault(1) manpage, plus better manpage contents
  Make the mutually exclusive options helper function print the correct parameter name
  Add small fixes to changelog, docstrings and variable names
</pre>

Add a changelog entry for the new i18n/l10n infrastructure

2025-01-01T00:17:17+01:00

</pre>

Fix coverage

2024-12-31T23:58:59+01:00

Exclude further machinery from coverage that isn't meant to be tested.
</pre>

Reimplement `--help` and `--version` options in a translatable way

2024-12-31T22:30:36+01:00

Reimplement the machinery for displaying help texts and version
information, supporting translatable strings.  Besides the one-line help
texts for the `--help` and `--version` options, the version information
text is a translatable string itself, in case the name and version
number should be rearranged, or prefixed or suffixed, or whatever.
</pre>

Replace strings in `derivepassphrase export vault` with translatable ones

2024-12-31T22:18:29+01:00

Apparently, we overlooked this in
59d73c8320650a6bcb77eed759c694949d350cdb.
</pre>

Force logging calls in error callback to be uninterpolated

2024-12-31T22:08:02+01:00

Remove the `args` argument to the error callback and to the underlying
`logging` function, forcing logger to skip log message interpolation in
any case.
</pre>

Provide a function to reload translations for derivepassphrase

2024-12-31T18:40:01+01:00

</pre>

Add a writer function for derivepassphrase's .po template

2024-12-31T16:03:01+01:00

To be used together with the gettext toolset.

Many things are hard-coded.
</pre>

Fix some translation typos and inconsistent translation comments

2024-12-31T16:03:01+01:00

</pre>

Update the CLI to use the translatable strings

2024-12-30T23:45:01+01:00

We implement the translations in a deferred manner, via objects that
stringify to their correct translation.  Since `click` 8.1, help texts
are (mostly) stored first and processed only when the help page is
emitted.  Accordingly, this system can be adapted to support our
translatable strings: we need only ensure the help text is stringified
just before it is formatted and emitted.  This in turn can be achieved
by reimplementing the help page assembly and formatting in a custom
`click.Command` class, as has already been done to implement help/option
group support.  Once this is in place, it remains to exchange all inline
help texts with the corresponding translatable string, and adapt the
tests to the new messages.

While most of the changes are straightforward, some subtleties remain.

First, the help texts are now supplied as (separately translatable)
paragraphs to the `click.command` decorator, instead of being extracted
from the respective function docstring.  The docstrings in return have
been shortened down.

Second, since the new capabilities are implemented via custom
`click.Command`, `click.MultiCommand` and `click.Option` subclasses,
every option and command must derive from one of these classes.  This
necessitates the creation of an empty `StandardOption` class for options
without an option group, and making `_DefaultToVaultGroup` a subclass of
`CommandWithHelpGroups`.

Third, since the `click.Option` class actually processes its help text
eagerly, the subclass must hide the (non-string) help text from the
`click.Option` constructor and later restore it.

Finally, while the tests currently pass as before, they now implicitly
rely on *not* loading any translations.  Furthermore, there is no
mechanism in place with which to isolate the translation system from the
user's environment for testing purposes, nor is there a (controlled)
mechanism to test `derivepassphrase` under a different language.  Once
there are actual translations, future commits will need to establish
such a missing mechanism for translation loading/switching/forcing.
</pre>