Add output formats extract and misspelled, make options -e/-m aliases on --output-format

Author: flashcode

CHANGELOG.md

@@ -18,7 +18,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 
 ### Added
 
-- Add option `-o` (or `--output-format`) to customize output format
+- Add option `-o` (or `--output-format`) to customize output format, options `-e` and `-m` are now aliases on this option
 - Add official pre-commit hook
 
 ## Version 4.1.0 (2024-10-23)

README.md

@@ -60,12 +60,16 @@ Options:
 - `-s id|str`, `--spelling id|str`: check spelling (`id` = source messages, `str` = translations)
 - `-d <dicts>`, `--dicts <dicts>`: comma-separated list of extra dictionaries to use (in addition to file language)
 - `-P <file>`, `--pwl <file>`: file(s) with personal list of words used when checking spelling (this option can be given multiple times)
-- `-m`, `--only-misspelled`: display only misspelled words (no error, line number and translation)
+- `-m`, `--only-misspelled`: display only misspelled words (alias of `--output-format=misspelled`)
 - `-w`, `--no-whitespace`: do not check whitespace at beginning/end of strings
 - `-W`, `--no-whitespace-eol`: do not check whitespace at end of lines inside strings
-- `-e`, `--extract`: display all translations and exit (all checks except compilation are disabled in this mode)
+- `-e`, `--extract`: display all translations and exit (alias of `--output-format=extract`)
 - `-i`, `--ignore-errors`: display but ignore errors (always return 0)
-- `-o`, `--output-format`: output format
+- `-o`, `--output-format`: output format:
+  - `full`: complete output
+  - `oneline`: one line output
+  - `extract`: display all translations (all checks except compilation are disabled in this mode)
+  - `misspelled`: display only misspelled words
 - `-q`, `--quiet`: quiet mode: only display number of errors
 - `-v`, `--version`: display version and exit
 

src/msgcheck/msgcheck.py

@@ -42,6 +42,13 @@
 
 from msgcheck.po import PoCheck, PoFileReport
 
+HELP_OUTPUT_FORMATS = [
+    "full = complete output",
+    "oneline = one line output",
+    "extract = display all translations (all checks except compilation are disabled in this mode)",
+    "misspelled = display only misspelled words",
+]
+
 
 class CustomHelpFormatter(argparse.RawDescriptionHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
     """Help formatter with raw description/epilog and default values."""
@@ -59,7 +66,7 @@ def msgcheck_parser() -> argparse.ArgumentParser:
 
 The script returns:
   0: all files checked are OK (or one of these options given:
-     --extract, --only-misspelled or --ignore-errors given)
+     --output-format={extract|misspelled} or --ignore-errors given)
   n: number of files with errors (1 ≤ n ≤ 255)
 """,
     )
@@ -116,7 +123,7 @@ def msgcheck_parser() -> argparse.ArgumentParser:
         "-m",
         "--only-misspelled",
         action="store_true",
-        help="display only misspelled words (no error, line number and translation)",
+        help="display only misspelled words (alias of --output-format=misspelled)",
     )
     parser.add_argument(
         "-w",
@@ -134,7 +141,7 @@ def msgcheck_parser() -> argparse.ArgumentParser:
         "-e",
         "--extract",
         action="store_true",
-        help="display all translations and exit (all checks except compilation are disabled in this mode)",
+        help="display all translations and exit (alias of --output-format=extract)",
     )
     parser.add_argument(
         "-i",
@@ -145,9 +152,9 @@ def msgcheck_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "-o",
         "--output-format",
-        choices=["full", "oneline"],
+        choices=["full", "oneline", "extract", "misspelled"],
         default="full",
-        help="output format: full = complete output, oneline = one line output",
+        help=f"output format: {', '.join(HELP_OUTPUT_FORMATS)}",
     )
     parser.add_argument(
         "-q",
@@ -190,10 +197,15 @@ def msgcheck_check_files(args: argparse.Namespace) -> list[PoFileReport]:
         "no_punct",
         "no_whitespace",
         "no_whitespace_eol",
-        "extract",
     ):
         if args.__dict__[option]:
             po_check.set_check(option.lstrip("no_"), not option.startswith("no_"))
+    if args.extract:
+        args.output_format = "extract"
+    elif args.only_misspelled:
+        args.output_format = "misspelled"
+    if args.output_format == "extract":
+        po_check.set_check("extract")
 
     # check all files
     try:
@@ -216,7 +228,7 @@ def msgcheck_display_errors(args: argparse.Namespace, result: list[PoFileReport]
         files_with_errors += 1
         total_errors += len(report)
         if not args.quiet:
-            if args.only_misspelled:
+            if args.output_format == "misspelled":
                 words = []
                 for error in report:
                     words.extend(error.get_misspelled_words())
@@ -231,9 +243,8 @@ def msgcheck_display_result(args: argparse.Namespace, result: list[PoFileReport]
     # display errors
     files_ok, files_with_errors, total_errors = msgcheck_display_errors(args, result)
 
-    # exit now if we extracted translations or if we displayed only
-    # misspelled words
-    if args.extract or args.only_misspelled:
+    # exit now if we extracted translations or if we displayed only misspelled words
+    if args.output_format in ("extract", "misspelled"):
         sys.exit(0)
 
     # display files with number of errors

src/msgcheck/po.py

@@ -526,7 +526,7 @@ def __repr__(self) -> str:
         """Return PO checker as string."""
         return f"checks: {self.checks}, dicts: {self.dicts}, extra_checkers: {self.extra_checkers}"
 
-    def set_check(self, check: str, state: bool) -> None:
+    def set_check(self, check: str, state: bool = True) -> None:
         """Enable/disable a specific check."""
         if check in self.checks:
             self.checks[check] = state

tests/test_msgcheck.py

@@ -59,7 +59,7 @@ def test_read() -> None:
 def test_extract() -> None:
     """Test extract on a gettext file."""
     po_check = PoCheck()
-    po_check.set_check("extract", True)
+    po_check.set_check("extract")
     result = po_check.check_files([local_path("fr.po")])
     assert len(result) == 1
     assert "fr.po" in result[0].filename
@@ -145,7 +145,7 @@ def test_checks() -> None:
 def test_checks_fuzzy() -> None:
     """Test checks on a gettext file including fuzzy strings."""
     po_check = PoCheck()
-    po_check.set_check("fuzzy", True)
+    po_check.set_check("fuzzy")
     result = po_check.check_files([local_path("fr_errors.po")])
 
     # be sure we have one file in result
@@ -158,7 +158,7 @@ def test_checks_fuzzy() -> None:
 def test_checks_noqa() -> None:
     """Test checks on a gettext file including `noqa`-commented lines."""
     po_check = PoCheck()
-    po_check.set_check("check_noqa", True)
+    po_check.set_check("check_noqa")
     result = po_check.check_files([local_path("fr_errors.po")])
 
     # be sure we have one file in result
@@ -409,7 +409,7 @@ def test_punct_full_stop_ja_zh(language: str, msgid: str, msgstr: str, error_mes
 def test_invalid_utf8() -> None:
     """Test checks on a file with invalid UTF-8 chars."""
     po_check = PoCheck()
-    po_check.set_check("fuzzy", True)
+    po_check.set_check("fuzzy")
     result = po_check.check_files([local_path("fr_invalid_utf8.po")])
 
     # be sure we have one file in result