Qt_convert_enum can now find potential enum issues

These have a high chance of false positives so this does not actually
make the changes, simply output the places to look for changes.

Author: MHendricks

CAVEATS.md

@@ -430,4 +430,8 @@ 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.
+that no enum changes are required. This check can only find and fix code that
+is directly using enums on Qt class names. If you used `self.EnumName` or other
+methods of accessing the enum objects the `--partial` check may find them. This is
+unable to automatically fix your code but shows you possible code that you will
+need to manually fix.

Qt_convert_enum.py

@@ -20,6 +20,7 @@
 import re
 import sys
 from pathlib import Path
+from typing import Optional
 
 
 def qt_for_binding(binding):
@@ -38,7 +39,7 @@ def qt_for_binding(binding):
 
 
 class QtEnumConverter:
-    DEFAULT_IGNORED = ".tox,.eggs,build"
+    DEFAULT_IGNORED = ".tox,.eggs,build,dist"
 
     def __init__(self, verbosity=0, ignored: str = DEFAULT_IGNORED):
         self.ignored = ignored.split(",")
@@ -52,6 +53,7 @@ def __init__(self, verbosity=0, ignored: str = DEFAULT_IGNORED):
         # The mapping of short to fully qualified enum names. Used to
         # update python scripts.
         self.enum_map: dict[str, str] = {}
+        self.partial_enum: Optional[re.Pattern] = None
         # Module level view of all the enums also used to check for naming
         # conflicts where the short name maps to multiple long names.
         self.enum_module: dict[str, dict[str, list[str]]] = {}
@@ -148,7 +150,45 @@ def convert_enums_in_file(self, filepath: Path, root: Path, dry_run: bool) -> in
             f.write(content)
         return changes
 
-    def convert_all(self, directory: Path, dry_run: bool) -> int:
+    def find_partials(self, filepath: Path, root: Path) -> int:
+        """Find and report potential partial Enum uses
+
+        We can't automatically replace them as this has a high likelihood of
+        false positives.
+        """
+        if not self.enum_map:
+            self.enums_for_qt_py()
+
+        if not self.partial_enum:
+            enums = {v.split('.')[-1] for v in self.enum_map.values()}
+            self.partial_enum = re.compile(fr"\.({'|'.join(enums)})(?!\w)")
+
+        # Read the content
+        with filepath.open('r', encoding='utf-8', newline='\n', errors='replace') as f:
+            content = f.readlines()
+
+        changes = 0
+        relative = filepath.relative_to(root)
+        for ln, line in enumerate(content):
+            clean_line = line.rstrip()
+            matches = set()
+            for v in self.enum_map.values():
+                clean_line = clean_line.replace(v, "")
+
+            for match in self.partial_enum.findall(clean_line):
+                matches.add(match)
+            if matches:
+                if self.verbosity >= 0:
+                    print(
+                        f'File: "{relative}", line:{ln + 1}, for {", ".join(matches)}'
+                    )
+                if self.verbosity >= 1:
+                    print(f'    {line.strip()}')
+                changes += 1
+
+        return changes
+
+    def convert_all(self, directory: Path, dry_run: bool, partial: bool = False) -> int:
         """Search and replace all enums."""
         ignored = [directory / i for i in self.ignored]
         changes = 0
@@ -174,7 +214,10 @@ def convert_all(self, directory: Path, dry_run: bool) -> int:
                     continue
                 if self.verbosity >= 2:
                     print(f"Checking: {filepath}")
-                changes += self.convert_enums_in_file(filepath, directory, dry_run)
+                if partial:
+                    changes += self.find_partials(filepath, directory)
+                else:
+                    changes += self.convert_enums_in_file(filepath, directory, dry_run)
 
         return changes
 
@@ -249,13 +292,27 @@ def parse_args():
         "have duplicate names on the same class causing ambiguity with short "
         "names. dups requires PySide6 and the others require PySide2 installed.",
     )
+    parser.add_argument(
+        "--partial",
+        action="store_true",
+        help="Report any potential enum uses that can not be automatically fixed. "
+        "This can happen if the code accesses enums from the instance instead of "
+        "directly from the class name.",
+    )
     parser.add_argument(
         '-v',
         '--verbosity',
         action='count',
         default=0,
         help="Increase the verbosity of the output.",
     )
+    parser.add_argument(
+        '-q',
+        '--quiet',
+        action="count",
+        default=0,
+        help="Decrease the verbosity of the output.",
+    )
     parser.add_argument(
         '--check',
         action='store_true',
@@ -282,6 +339,9 @@ def add_binding_info(data, qt):
 if __name__ == "__main__":
     args = parse_args()
 
+    # Merge the quiet and verbosity arguments
+    args.verbosity -= args.quiet
+
     if args.show == "dups":
         # Show duplicate enum short names found in PySide6
         checker = DuplicateEnums()
@@ -303,10 +363,14 @@ 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
-        changes = mapper.convert_all(args.target, dry_run=not args.write)
+        changes = mapper.convert_all(
+            args.target, dry_run=not args.write, partial=args.partial
+        )
 
         # Report the number of enum changes
-        if args.write:
+        if args.partial:
+            print(f"{changes} partial enums found.")
+        elif args.write:
             print(f"{changes} enums changed.")
         else:
             print(f"{changes} enums require changes.")

setup.cfg

@@ -4,6 +4,7 @@ universal=1
 [flake8]
 select = B, C, E, F, N, W, B9
 extend-ignore =
+    B907,
     E203,
     E501,
     E722,

tests.py

@@ -2,6 +2,7 @@
 """Tests that run once"""
 import io
 import os
+import re
 import sys
 import imp
 import shutil
@@ -1646,6 +1647,8 @@ def test_multiple_preferred():
     if QAbstractItemView.Box:
         print(QTreeWidget.Box)
         print(QFrame.Box)
+        # Note: Not using a Qt class so this will only be found by the --partial check
+        self.Box
     """
 )
 
@@ -1654,6 +1657,7 @@ def test_multiple_preferred():
     u"""
     # a comment QStyle.CC_ComboBox that has a enum in it
     print(QFrame.Box)
+    print(self.Box)
     """
 )
 
@@ -1724,15 +1728,31 @@ def test_convert_enum():
             assert "6 enums changed." in output
 
         check = enum_file_1.replace("WindowActive", "WindowState.WindowActive")
-        check = check.replace("Box", "Shape.Box")
+        name_re = re.compile(r"(?<!self)\.Box")
+        check = name_re.sub(".Shape.Box", check)
         with open(init_file) as fle:
             assert fle.read() == check
 
         check = enum_file_2.replace("CC_ComboBox", "ComplexControl.CC_ComboBox")
-        check = check.replace("QFrame.Box", "QFrame.Shape.Box")
+        check = name_re.sub(".Shape.Box", check)
         with open(example_file) as fle:
             assert fle.read() == check
 
+        # Check using `--partial`
+        output = subprocess.check_output(
+            cmd + ["--partial", "-v"], cwd=self.tempdir, universal_newlines=True
+        )
+        check = textwrap.dedent(
+            u"""\
+            File: "__init__.py", line:7, for Box
+                self.Box
+            File: "api{slash}example.py", line:4, for Box
+                print(self.Box)
+            2 partial enums found.
+            """
+        ).format(slash=os.sep)
+        assert output == check
+
     def test_convert_enum_map():
         """Test enum map generation for conversion from short to long enums"""
         code_path = os.path.join(os.path.dirname(__file__), "Qt_convert_enum.py")