Better script for checking translations

Don't just run msgfmt to detect errors, print the affected entries too.
This makes it much easier to find and correct them at Crowdin.

Author: vslavik

.github/workflows/check-translations.yml

@@ -19,9 +19,8 @@ jobs:
     - name: Install GNU gettext
       run: sudo apt-get install gettext
 
-    - name: Check PO files with msgfmt -v -c
-      run: |
-        for i in locales/*.po ; do
-          echo "checking $i..."
-          msgfmt -v -c -o /dev/null $i
-        done
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Check translations
+      run: uv run scripts/check-translations.py --github

scripts/check-translations.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [
+#     "polib",
+#     "rich",
+# ]
+# ///
+
+"""
+Checks correctness of translation PO files.
+"""
+
+import argparse
+import polib
+import subprocess
+import sys
+import glob
+from rich import print
+
+
+
+def _matching_po_entry(po, lineno):
+    """
+    Find the PO entry that matches the given line number.
+    Note that entries are multiline and lineno may be in the middle of an entry.
+    """
+    last = None
+    for entry in po:
+        if entry.linenum > lineno:
+            break
+        last = entry
+    return last
+
+
+def _print_error(fn, entry, lineno, text, github):
+    """
+    Print the error message for the given entry.
+    """
+    if github:
+        if entry:
+            details = text + '\n' + str(entry)
+            details = details.replace('\n', '%0A')
+            print(f'::error title="{fn}:{lineno}:{text}"::{details}')
+        else:
+            print(f'::error title="error in {fn}"::{lineno}:{text}')
+    else:
+        print(f'[red]{fn}:{lineno}:{text}[/red]')
+        if entry:
+            print(entry)
+
+
+def process_po(filename, stderr, github):
+    """
+    Parse and pretty-print errors in the file.
+    The error format is: <file>:<line>: <error>
+    """
+    po = polib.pofile(filename)
+    # dict indexed with POEntry and containing all error messages for it
+    errors = []
+
+    for line in stderr.split('\n'):
+        if not line:
+            continue
+        parts = line.split(':')
+        fn = parts[0]
+        if fn != filename:
+            continue
+        lineno = int(parts[1])
+        text = ':'.join(parts[2:])
+        entry = _matching_po_entry(po, lineno)
+        _print_error(filename, entry, lineno, text, github)
+        if entry:
+            errors.append(entry)
+
+
+def check_translations(po_files, github=False):
+    status = True
+    for po_file in po_files:
+        result = subprocess.run(['msgfmt', '-v', '-c', '-o', '/dev/null', po_file], capture_output=True, text=True)
+        if result.returncode != 0:
+            status = False
+            process_po(po_file, result.stderr, github)
+    return status
+
+
+
+def main():
+    parser = argparse.ArgumentParser(description='Check correctness of translation PO files.')
+    parser.add_argument('--github', action='store_true', help='Format output for GitHub Actions')
+    args = parser.parse_args()
+
+    po_files = glob.glob('locales/*.po')
+    status = check_translations(po_files, args.github)
+    sys.exit(0 if status else 1)
+
+
+if __name__ == "__main__":
+    main()

scripts/travis-check-translations.sh

@@ -119,8 +119,5 @@ scripts/do-update-translations-lists.sh
 
 git status
 echo ""
-exit_code=0
-for i in locales/*.po ; do
-    msgfmt -c -o /dev/null $i || exit_code=$?
-done
-exit $exit_code
+
+uv run scripts/check-translations.sh