Qt_convert_enum.py can now be used as a qc check

With --check added to the command, the return code will be updated with
the number of enums that require(d) fixing.

Author: MHendricks

CAVEATS.md

@@ -427,3 +427,7 @@ enums that need replaced in each file.
 
 To actually update the code add `--write` flag. This updates existing files and
 does not make backups of the existing files, so make sure to do that first.
+
+To check for enum use regression you can add `--check`. This will change the return
+code to the number of enums that require changing. A return code of zero indicates
+that no enum changes are required.

Qt_convert_enum.py

@@ -98,7 +98,7 @@ def enums_for_qt_py(self):
             module = getattr(self.Qt, module_name)
             self.enums_for_module(module)
 
-    def convert_enums_in_file(self, filepath: Path, root: Path, dry_run: bool) -> None:
+    def convert_enums_in_file(self, filepath: Path, root: Path, dry_run: bool) -> int:
         """Convert the enums in the given file.
 
         Based on https://stackoverflow.com/a/72658216 by Kristof Mulier
@@ -111,6 +111,7 @@ def convert_enums_in_file(self, filepath: Path, root: Path, dry_run: bool) -> No
         with filepath.open('r', encoding='utf-8', newline='\n', errors='replace') as f:
             content = f.read()
 
+        changes = 0
         # Loop over all the keys in 'self.enum_map'. Perform a replacement in the
         # 'content' for each of them.
         for k, v in self.enum_map.items():
@@ -137,17 +138,20 @@ def convert_enums_in_file(self, filepath: Path, root: Path, dry_run: bool) -> No
             q = "'"
             print(f'{q}{relative_path}{q}: Replace {q}{k}{q} => {q}{v}{q} ({n})')
             content = new_content
+            # Record the number of enums updated in this file
+            changes += n
 
         if dry_run:
-            return
+            return changes
 
         with filepath.open('w', encoding='utf-8', newline='\n', errors='replace') as f:
             f.write(content)
-        return
+        return changes
 
-    def convert_all(self, directory: Path, dry_run: bool) -> None:
+    def convert_all(self, directory: Path, dry_run: bool) -> int:
         """Search and replace all enums."""
         ignored = [directory / i for i in self.ignored]
+        changes = 0
         # Using os.walk instead of pathlib's walk to support older python's
         for _root, _, files in os.walk(directory):
             root = Path(_root)
@@ -170,8 +174,9 @@ def convert_all(self, directory: Path, dry_run: bool) -> None:
                     continue
                 if self.verbosity >= 2:
                     print(f"Checking: {filepath}")
-                self.convert_enums_in_file(filepath, directory, dry_run)
-                continue
+                changes += self.convert_enums_in_file(filepath, directory, dry_run)
+
+        return changes
 
 
 class DuplicateEnums:
@@ -251,6 +256,13 @@ def parse_args():
         default=0,
         help="Increase the verbosity of the output.",
     )
+    parser.add_argument(
+        '--check',
+        action='store_true',
+        help="The Return Code becomes the number of enums that were/require "
+        "changing. Can be used with --write. Use this to check for enum use "
+        "regression.",
+    )
     parser.add_argument(
         'target', type=Path, nargs="?", help="Directory to process recursively"
     )
@@ -291,4 +303,13 @@ def add_binding_info(data, qt):
         print(json.dumps(mappings, indent=4, sort_keys=True))
     else:
         # Search .py files and update to fully qualified enum names
-        mapper.convert_all(args.target, dry_run=not args.write)
+        changes = mapper.convert_all(args.target, dry_run=not args.write)
+
+        # Report the number of enum changes
+        if args.write:
+            print(f"{changes} enums changed.")
+        else:
+            print(f"{changes} enums require changes.")
+        # Set the return code to the number of enums being changed if enabled
+        if args.check:
+            sys.exit(changes)

tests.py

@@ -1648,11 +1648,34 @@ def test_convert_enum():
 
         assert enum_check in output
 
+        # Check using the "--check" command outputs the same text but uses
+        # the return code for the number of enums being changed.
+        try:
+            output = subprocess.check_output(
+                cmd + ["--check"], cwd=self.tempdir, universal_newlines=True
+            )
+        except subprocess.CalledProcessError as error:
+            assert error.returncode == 6
+            assert error.stdout == output
+            # The number of changes are added to the end of the output
+            assert "6 enums require changes." in output
+
         # Test actually updating the files.
         cmd.append("--write")
         output = subprocess.check_output(cmd, cwd=self.tempdir, universal_newlines=True)
         assert enum_check in output
 
+        # "--check" is respected in --write mode
+        try:
+            output = subprocess.check_output(
+                cmd + ["--check"], cwd=self.tempdir, universal_newlines=True
+            )
+        except subprocess.CalledProcessError as error:
+            assert error.returncode == 6
+            assert error.stdout == output
+            # The number of changes are added to the end of the output
+            assert "6 enums changed." in output
+
         check = enum_file_1.replace("WindowActive", "WindowState.WindowActive")
         check = check.replace("Box", "Shape.Box")
         with open(init_file) as fle: