Scan entire directories with path given on command line

Author: flashcode

CHANGELOG.md

@@ -11,6 +11,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 ### Changed
 
 - **Breaking**: improve typing annotations, Python 3.9 is now required
+- Scan entire directories with path given on command line
 - Use uv for packaging
 - Use ruff and ty linters
 

README.md

@@ -46,7 +46,7 @@ $ uv run msgcheck
 Syntax:
 
 ```
-$ msgcheck [options] file.po [file.po...]
+$ msgcheck [options] files [files...]
 ```
 
 Options:

src/msgcheck/msgcheck.py

@@ -152,9 +152,9 @@ def msgcheck_parser() -> argparse.ArgumentParser:
         version=version,
     )
     parser.add_argument(
-        "file",
+        "files",
         nargs="+",
-        help="gettext file(s) to check (*.po files)",
+        help="files or directories with gettext files (*.po)",
     )
     return parser
 
@@ -187,7 +187,7 @@ def msgcheck_check_files(args: argparse.Namespace) -> list[tuple[str, list[PoRep
     # check all files
     try:
         po_check.set_spelling_options(args.spelling, args.dicts, args.pwl)
-        result = po_check.check_files(args.file)
+        result = po_check.check_files(args.files)
     except (ImportError, OSError) as exc:
         print("FATAL:", exc, sep=" ")
         sys.exit(1)
@@ -240,12 +240,8 @@ def msgcheck_display_result(args: argparse.Namespace, result: list[tuple[str, li
             print(f"{filename}: {errors} errors ({str_result})")
 
     # display total (if many files processed)
-    if len(args.file) > 1:
-        print("---")
-        if files_with_errors == 0:
-            print(f"TOTAL: {files_ok} files OK")
-        else:
-            print(f"TOTAL: {files_ok} files OK, {files_with_errors} files with {total_errors} errors")
+    str_errors = f", {files_with_errors} files with {total_errors} errors" if files_with_errors > 0 else ""
+    print(f"TOTAL: {files_ok} files OK{str_errors}")
 
     return files_with_errors
 

src/msgcheck/po.py

@@ -25,6 +25,7 @@
 
 from __future__ import annotations
 
+import os
 import re
 import subprocess
 import tempfile
@@ -614,42 +615,40 @@ def check_pofile(self, po_file: PoFile) -> list[PoReport]:
 
         return reports
 
-    def check_files(self, files: list[str]) -> list[tuple[str, list[PoReport]]]:
-        """Check translations in PO files.
+    def check_file(self, filename: str) -> list[PoReport]:
+        """Check compilation and translations in a PO file.
 
         Return a list of tuples: (filename, [PoReport, PoReport, ...]).
         """
-        result = []
+        po_file = PoFile(filename)
+        # read the file
+        try:
+            po_file.read()
+        except OSError as exc:
+            return [PoReport(str(exc), "read", po_file.filename)]
+        # compile the file (except if disabled)
+        compile_rc = 0
+        if self.checks["compile"]:
+            compile_output, compile_rc = po_file.compile()
+        if compile_rc != 0:
+            # compilation failed
+            return [PoReport(compile_output, "compile", po_file.filename)]
+        # compilation OK
+        return self.check_pofile(po_file)
 
-        for filename in files:
-            po_file = PoFile(filename)
-            # read the file
-            try:
-                po_file.read()
-            except OSError as exc:
-                result.append(
-                    (
-                        po_file.filename,
-                        [PoReport(str(exc), "read", po_file.filename)],
-                    ),
-                )
-                continue
-            # compile the file (except if disabled)
-            compile_rc = 0
-            if self.checks["compile"]:
-                compile_output, compile_rc = po_file.compile()
-            if compile_rc == 0:
-                # compilation OK
-                result.append((po_file.filename, self.check_pofile(po_file)))
-            else:
-                # compilation failed
-                result.append(
-                    (
-                        po_file.filename,
-                        [
-                            PoReport(compile_output, "compile", po_file.filename),
-                        ],
-                    ),
-                )
+    def check_files(self, files: list[str]) -> list[tuple[str, list[PoReport]]]:
+        """Check compilation and translations in PO files.
 
+        Return a list of tuples: (filename, [PoReport, PoReport, ...]).
+        """
+        result: list[tuple[str, list[PoReport]]] = []
+        for path in files:
+            if Path(path).is_dir():
+                for root, _, filenames in os.walk(path):
+                    for filename in filenames:
+                        if filename.endswith(".po"):
+                            path_po = Path(root) / filename
+                            result.append((str(path_po), self.check_file(str(path_po))))
+            else:
+                result.append((path, self.check_file(path)))
         return result