chore: use a dataclass instead of a dict for policies

Author: mayeut

pyproject.toml

@@ -15,8 +15,9 @@ enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 extra_checks = true
 strict = false
 strict_equality = true
-warn_unused_configs = true
+warn_redundant_casts = true
 warn_unreachable = false
+warn_unused_configs = true
 warn_unused_ignores = true
 
 [[tool.mypy.overrides]]

src/auditwheel/elfutils.py

@@ -151,14 +151,14 @@ def get_undefined_symbols(path: str) -> set[str]:
 
 
 def filter_undefined_symbols(
-    path: str, symbols: dict[str, list[str]]
+    path: str, symbols: dict[str, frozenset[str]]
 ) -> dict[str, list[str]]:
     if not symbols:
         return {}
     undef_symbols = set("*") | get_undefined_symbols(path)
     result = {}
     for lib, sym_list in symbols.items():
-        intersection = set(sym_list) & undef_symbols
+        intersection = sym_list & undef_symbols
         if intersection:
             result[lib] = sorted(intersection)
     return result

src/auditwheel/json.py

@@ -8,7 +8,9 @@
 
 def _encode_value(value: Any) -> Any:
     if dataclasses.is_dataclass(value) and not isinstance(value, type):
-        return dataclasses.asdict(value)
+        as_dict = dataclasses.asdict(value)
+        as_dict.pop("policy", None)  # don't dump full policy in logs
+        return as_dict
     if isinstance(value, frozenset):
         return sorted(value)
     if isinstance(value, Enum):

src/auditwheel/main_repair.py

@@ -15,32 +15,32 @@
 def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
     wheel_policy = WheelPolicies()
     policies = wheel_policy.policies
-    policy_names = [p["name"] for p in policies]
-    policy_names += [alias for p in policies for alias in p["aliases"]]
+    policy_names = [p.name for p in policies]
+    policy_names += [alias for p in policies for alias in p.aliases]
     epilog = """PLATFORMS:
 These are the possible target platform tags, as specified by PEP 600.
 Note that old, pre-PEP 600 tags are still usable and are listed as aliases
 below.
 """
     for p in policies:
-        epilog += f"- {p['name']}"
-        if len(p["aliases"]) > 0:
-            epilog += f" (aliased by {', '.join(p['aliases'])})"
+        epilog += f"- {p.name}"
+        if len(p.aliases) > 0:
+            epilog += f" (aliased by {', '.join(p.aliases)})"
         epilog += "\n"
-    highest_policy = wheel_policy.get_policy_name(wheel_policy.priority_highest)
+    highest_policy = wheel_policy.highest.name
     help = """Vendor in external shared library dependencies of a wheel.
 If multiple wheels are specified, an error processing one
 wheel will abort processing of subsequent wheels.
 """
-    p = sub_parsers.add_parser(
+    parser = sub_parsers.add_parser(
         "repair",
         help=help,
         description=help,
         epilog=epilog,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
-    p.add_argument("WHEEL_FILE", help="Path to wheel file.", nargs="+")
-    p.add_argument(
+    parser.add_argument("WHEEL_FILE", help="Path to wheel file.", nargs="+")
+    parser.add_argument(
         "--plat",
         action=EnvironmentDefault,
         metavar="PLATFORM",
@@ -51,22 +51,22 @@ def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
         choices=policy_names,
         default=highest_policy,
     )
-    p.add_argument(
+    parser.add_argument(
         "-L",
         "--lib-sdir",
         dest="LIB_SDIR",
         help=('Subdirectory in packages to store copied libraries. (default: ".libs")'),
         default=".libs",
     )
-    p.add_argument(
+    parser.add_argument(
         "-w",
         "--wheel-dir",
         dest="WHEEL_DIR",
         type=abspath,
         help=('Directory to store delocated wheels (default: "wheelhouse/")'),
         default="wheelhouse/",
     )
-    p.add_argument(
+    parser.add_argument(
         "--no-update-tags",
         dest="UPDATE_TAGS",
         action="store_false",
@@ -76,14 +76,14 @@ def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
         ),
         default=True,
     )
-    p.add_argument(
+    parser.add_argument(
         "--strip",
         dest="STRIP",
         action="store_true",
         help="Strip symbols in the resulting wheel",
         default=False,
     )
-    p.add_argument(
+    parser.add_argument(
         "--exclude",
         dest="EXCLUDE",
         help="Exclude SONAME from grafting into the resulting wheel "
@@ -94,21 +94,21 @@ def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
         action="append",
         default=[],
     )
-    p.add_argument(
+    parser.add_argument(
         "--only-plat",
         dest="ONLY_PLAT",
         action="store_true",
         help="Do not check for higher policy compatibility",
         default=False,
     )
-    p.add_argument(
+    parser.add_argument(
         "--disable-isa-ext-check",
         dest="DISABLE_ISA_EXT_CHECK",
         action="store_true",
         help="Do not check for extended ISA compatibility (e.g. x86_64_v2)",
         default=False,
     )
-    p.set_defaults(func=execute)
+    parser.set_defaults(func=execute)
 
 
 def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
@@ -137,56 +137,54 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
             logger.info(e.message)
             return 1
 
-        policy = wheel_policy.get_policy_by_name(args.PLAT)
-        assert policy is not None
-        reqd_tag = policy["priority"]
+        requested_policy = wheel_policy.get_policy_by_name(args.PLAT)
 
-        if reqd_tag > wheel_policy.get_priority_by_name(wheel_abi.sym_tag):
+        if requested_policy > wheel_abi.sym_policy:
             msg = (
                 f'cannot repair "{wheel_file}" to "{args.PLAT}" ABI because of the '
                 "presence of too-recent versioned symbols. You'll need to compile "
                 "the wheel on an older toolchain."
             )
             parser.error(msg)
 
-        if reqd_tag > wheel_policy.get_priority_by_name(wheel_abi.ucs_tag):
+        if requested_policy > wheel_abi.ucs_policy:
             msg = (
                 f'cannot repair "{wheel_file}" to "{args.PLAT}" ABI because it was '
                 "compiled against a UCS2 build of Python. You'll need to compile "
                 "the wheel against a wide-unicode build of Python."
             )
             parser.error(msg)
 
-        if reqd_tag > wheel_policy.get_priority_by_name(wheel_abi.blacklist_tag):
+        if requested_policy > wheel_abi.blacklist_policy:
             msg = (
                 f'cannot repair "{wheel_file}" to "{args.PLAT}" ABI because it '
                 "depends on black-listed symbols."
             )
             parser.error(msg)
 
-        if reqd_tag > wheel_policy.get_priority_by_name(wheel_abi.machine_tag):
+        if requested_policy > wheel_abi.machine_policy:
             msg = (
                 f'cannot repair "{wheel_file}" to "{args.PLAT}" ABI because it '
                 "depends on unsupported ISA extensions."
             )
             parser.error(msg)
 
-        abis = [policy["name"]] + policy["aliases"]
-        if (not args.ONLY_PLAT) and reqd_tag < wheel_policy.get_priority_by_name(
-            wheel_abi.overall_tag
-        ):
+        abis = [requested_policy.name, *requested_policy.aliases]
+        if (not args.ONLY_PLAT) and requested_policy < wheel_abi.overall_policy:
             logger.info(
                 (
                     "Wheel is eligible for a higher priority tag. "
                     "You requested %s but I have found this wheel is "
                     "eligible for %s."
                 ),
                 args.PLAT,
-                wheel_abi.overall_tag,
+                wheel_abi.overall_policy.name,
             )
-            higher_policy = wheel_policy.get_policy_by_name(wheel_abi.overall_tag)
-            assert higher_policy is not None
-            abis = [higher_policy["name"]] + higher_policy["aliases"] + abis
+            abis = [
+                wheel_abi.overall_policy.name,
+                *wheel_abi.overall_policy.aliases,
+                *abis,
+            ]
 
         patcher = Patchelf()
         out_wheel = repair_wheel(

src/auditwheel/main_show.py

@@ -55,13 +55,10 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
     ]
 
     printp(
-        f'{fn} is consistent with the following platform tag: "{winfo.overall_tag}".'
+        f'{fn} is consistent with the following platform tag: "{winfo.overall_policy.name}".'
     )
 
-    if (
-        wheel_policy.get_priority_by_name(winfo.pyfpe_tag)
-        < wheel_policy.priority_highest
-    ):
+    if winfo.pyfpe_policy < wheel_policy.highest:
         printp(
             "This wheel uses the PyFPE_jbuf function, which is not compatible with the"
             " manylinux1 tag. (see https://www.python.org/dev/peps/pep-0513/"
@@ -70,7 +67,7 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
         if args.verbose < 1:
             return 0
 
-    if wheel_policy.get_priority_by_name(winfo.ucs_tag) < wheel_policy.priority_highest:
+    if winfo.ucs_policy < wheel_policy.highest:
         printp(
             "This wheel is compiled against a narrow unicode (UCS2) "
             "version of Python, which is not compatible with the "
@@ -79,10 +76,7 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
         if args.verbose < 1:
             return 0
 
-    if (
-        wheel_policy.get_priority_by_name(winfo.machine_tag)
-        < wheel_policy.priority_highest
-    ):
+    if winfo.machine_policy < wheel_policy.highest:
         printp("This wheel depends on unsupported ISA extensions.")
         if args.verbose < 1:
             return 0
@@ -98,9 +92,9 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
             f"system-provided shared libraries: {', '.join(libs_with_versions)}"
         )
 
-    if wheel_policy.get_priority_by_name(winfo.sym_tag) < wheel_policy.priority_highest:
+    if winfo.sym_policy < wheel_policy.highest:
         printp(
-            f'This constrains the platform tag to "{winfo.sym_tag}". '
+            f'This constrains the platform tag to "{winfo.sym_policy.name}". '
             "In order to achieve a more compatible tag, you would "
             "need to recompile a new wheel from source on a system "
             "with earlier versions of these libraries, such as "
@@ -109,29 +103,27 @@ def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
         if args.verbose < 1:
             return 0
 
-    libs = winfo.external_refs[
-        wheel_policy.get_policy_name(wheel_policy.priority_lowest)
-    ]["libs"]
+    libs = winfo.external_refs[wheel_policy.lowest.name].libs
     if len(libs) == 0:
         printp("The wheel requires no external shared libraries! :)")
     else:
         printp("The following external shared libraries are required by the wheel:")
         print(json.dumps(dict(sorted(libs.items()))))
 
-    for p in sorted(wheel_policy.policies, key=lambda p: p["priority"]):
-        if p["priority"] > wheel_policy.get_priority_by_name(winfo.overall_tag):
-            libs = winfo.external_refs[p["name"]]["libs"]
+    for p in wheel_policy.policies:
+        if p > winfo.overall_policy:
+            libs = winfo.external_refs[p.name].libs
             if len(libs):
                 printp(
-                    f'In order to achieve the tag platform tag "{p["name"]}" '
+                    f"In order to achieve the tag platform tag {p.name!r} "
                     "the following shared library dependencies "
                     "will need to be eliminated:"
                 )
                 printp(", ".join(sorted(libs.keys())))
-            blacklist = winfo.external_refs[p["name"]]["blacklist"]
+            blacklist = winfo.external_refs[p.name].blacklist
             if len(blacklist):
                 printp(
-                    f'In order to achieve the tag platform tag "{p["name"]}" '
+                    f"In order to achieve the tag platform tag {p.name!r} "
                     "the following black-listed symbol dependencies "
                     "will need to be eliminated:"
                 )