Switch .format() to f-strings and apply various flake8 recommendations

Author: homebysix

pre_commit_hooks/check_autopkg_recipe_list.py

@@ -48,7 +48,7 @@ def main(argv=None):
                 with open(filename, "rb") as openfile:
                     recipe_list = plistlib.load(openfile).get("recipes")
             except (ExpatError, ValueError) as err:
-                print("{}: plist parsing error: {}".format(filename, err))
+                print(f"{filename}: plist parsing error: {err}")
                 retval = 1
         elif filename.endswith((".yaml", ".yml")):
             # AutoPkg does not support YAML recipe lists, but AutoPkg users
@@ -57,7 +57,7 @@ def main(argv=None):
                 with open(filename, "r", encoding="utf-8") as openfile:
                     recipe_list = yaml.load(openfile)
             except Exception as err:
-                print("{}: yaml parsing error: {}".format(filename, err))
+                print(f"{filename}: yaml parsing error: {err}")
                 retval = 1
         elif filename.endswith(".json"):
             # AutoPkg does not support JSON recipe lists, but AutoPkg users
@@ -66,11 +66,11 @@ def main(argv=None):
                 with open(filename, "r", encoding="utf-8") as openfile:
                     recipe_list = json.load(openfile)
             except Exception as err:
-                print("{}: json parsing error: {}".format(filename, err))
+                print(f"{filename}: json parsing error: {err}")
                 retval = 1
 
         if not recipe_list or not isinstance(recipe_list, list):
-            print("{}: invalid recipe list".format(filename))
+            print(f"{filename}: invalid recipe list")
             retval = 1
         else:
             if any((".munki" in recipe for recipe in recipe_list)):

pre_commit_hooks/check_autopkg_recipes.py

@@ -105,14 +105,13 @@ def validate_comments(filename, strict):
         if "<!--" in recipe_text and "-->" in recipe_text:
             if strict:
                 print(
-                    "{}: Convert from <!-- --> style comments "
-                    "to a Comment key.".format(filename)
+                    f"{filename}: Convert from <!-- --> style comments to a Comment key."
                 )
                 passed = False
             else:
                 print(
-                    "{}: WARNING: Recommend converting from <!-- --> style comments "
-                    "to a Comment key.".format(filename)
+                    f"{filename}: WARNING: Recommend converting from <!-- --> style comments "
+                    "to a Comment key."
                 )
 
     return passed
@@ -126,9 +125,7 @@ def validate_processor_keys(process, filename):
     if missing_processor_keys:
         for missing_proc in missing_processor_keys:
             print(
-                '{}: Item in processor array is missing "Processor" key:\n{}'.format(
-                    filename, missing_proc
-                )
+                f'{filename}: Item in processor array is missing "Processor" key:\n{missing_proc}'
             )
         passed = False
 
@@ -159,14 +156,12 @@ def validate_endofcheckphase(process, filename):
     )
     if endofcheck_idx is None:
         print(
-            "{}: Contains a download processor, but no EndOfCheckPhase "
-            "processor.".format(filename)
+            f"{filename}: Contains a download processor, but no EndOfCheckPhase processor."
         )
         passed = False
     elif endofcheck_idx < downloader_idx:
         print(
-            "{}: EndOfCheckPhase typically goes after a download processor, "
-            "not before.".format(filename)
+            f"{filename}: EndOfCheckPhase typically goes after a download processor, not before."
         )
         passed = False
 
@@ -223,8 +218,7 @@ def validate_minimumversion(process, min_vers, ignore_min_vers_before, filename)
         if proc in [x.get("Processor") for x in process]:
             if Version(min_vers) < Version(proc_min_versions[proc]):
                 print(
-                    "{}: {} processor requires minimum AutoPkg "
-                    "version {}".format(filename, proc, proc_min_versions[proc])
+                    f"{filename}: {proc} processor requires minimum AutoPkg version {proc_min_versions[proc]}"
                 )
                 passed = False
 
@@ -241,8 +235,7 @@ def validate_no_deprecated_procs(process, filename):
     for proc in process:
         if proc.get("Processor") in deprecated_procs:
             print(
-                "{}: WARNING: Deprecated processor {} "
-                "is used.".format(filename, proc.get("Processor"))
+                f'{filename}: WARNING: Deprecated processor {proc.get("Processor")} is used.'
             )
 
     return passed
@@ -259,10 +252,8 @@ def validate_no_superclass_procs(process, filename):
     for proc in process:
         if proc.get("Processor") in superclass_procs:
             print(
-                "{}: WARNING: The processor {} is intended to be used "
-                "by other processors, not used directly in recipes.".format(
-                    filename, proc.get("Processor")
-                )
+                f"{filename}: WARNING: The processor {proc.get('Processor')} is intended to be used "
+                "by other processors, not used directly in recipes."
             )
 
     return passed
@@ -324,9 +315,7 @@ def validate_jamf_processor_order(process, filename):
 #         subst = "%" + input_var + "%"
 #         if subst not in recipe_text:
 #             print(
-#                 "{}: WARNING: Input variable {} not referenced in recipe.".format(
-#                     filename, input_var
-#                 )
+#                 f"{filename}: WARNING: Input variable {input_var} not referenced in recipe."
 #             )
 
 #     return passed
@@ -353,8 +342,8 @@ def validate_no_var_in_app_path(process, filename):
             for _, argvalue in proc["Arguments"].items():
                 if isinstance(argvalue, str) and "%NAME%.app" in argvalue:
                     print(
-                        "{}: Use actual app name instead of %NAME%.app in {} "
-                        "processor argument.".format(filename, proc.get("Processor"))
+                        f"{filename}: Use actual app name instead of %NAME%.app in {proc.get('Processor')} "
+                        "processor argument."
                     )
                     passed = False
 
@@ -405,13 +394,13 @@ def validate_proc_type_conventions(process, filename):
     passed = True
     processors = [x.get("Processor") for x in process]
     for recipe_type in proc_type_conventions:
-        type_hint = ".{}.".format(recipe_type)
+        type_hint = f".{recipe_type}."
         if type_hint not in filename:
             for processor in processors:
                 if processor in proc_type_conventions[recipe_type]:
                     print(
-                        "{}: Processor {} is not conventional for this "
-                        "recipe type.".format(filename, processor)
+                        f"{filename}: Processor {processor} is not conventional for this "
+                        "recipe type."
                     )
                     passed = False
 
@@ -445,7 +434,7 @@ def validate_required_proc_for_types(process, filename):
     processors = [x.get("Processor") for x in process]
     for recipe_type in required_proc_for_type:
         req_procs = required_proc_for_type[recipe_type]
-        type_hint = ".{}.".format(recipe_type)
+        type_hint = f".{recipe_type}."
         if type_hint in filename:
             if recipe_type == "pkg" and processors == []:
                 # OK for pkg recipes to have an empty process list, as long as
@@ -455,13 +444,13 @@ def validate_required_proc_for_types(process, filename):
             if not any([x in processors for x in req_procs]):
                 if len(req_procs) == 1:
                     print(
-                        "{}: Recipe type {} should contain processor "
-                        "{}.".format(filename, recipe_type, req_procs[0])
+                        f"{filename}: Recipe type {recipe_type} should contain processor "
+                        f"{req_procs[0]}."
                     )
                 else:
                     print(
-                        "{}: Recipe type {} should contain one of these "
-                        "processors: {}.".format(filename, recipe_type, req_procs)
+                        f"{filename}: Recipe type {recipe_type} should contain one of these "
+                        f"processors: {req_procs}."
                     )
                 passed = False
 
@@ -495,23 +484,14 @@ def validate_proc_args(process, filename):
 
             if not core_procs[proc["Processor"]]:
                 print(
-                    "{}: Unknown argument {} for processor {}, "
-                    "which does not accept any arguments.".format(
-                        filename,
-                        arg,
-                        proc["Processor"],
-                    )
+                    f"{filename}: Unknown argument {arg} for processor {proc['Processor']}, "
+                    "which does not accept any arguments."
                 )
                 passed = False
             elif arg not in core_procs[proc["Processor"]]:
                 print(
-                    "{}: Unknown argument {} for processor {}. "
-                    "Allowed arguments are: {}".format(
-                        filename,
-                        arg,
-                        proc["Processor"],
-                        ", ".join(core_procs[proc["Processor"]]),
-                    )
+                    f"{filename}: Unknown argument {arg} for processor {proc['Processor']}. Allowed arguments are: "
+                    + ", ".join(core_procs[proc["Processor"]])
                 )
                 passed = False
 
@@ -550,9 +530,7 @@ def main(argv=None):
         # Ensure the recipe identifier isn't duplicated.
         if recipe["Identifier"] in seen_identifiers:
             print(
-                '{}: Identifier "{}" is shared by another recipe in this repo.'.format(
-                    filename, recipe["Identifier"]
-                )
+                f'{filename}: Identifier "{recipe["Identifier"]}" is shared by another recipe in this repo.'
             )
             retval = 1
         else:
@@ -566,10 +544,7 @@ def main(argv=None):
             if not validate_recipe_prefix(recipe, filename, args.recipe_prefix):
                 retval = 1
         if recipe["Identifier"] == recipe.get("ParentRecipe"):
-            print(
-                "{}: Identifier and ParentRecipe should not "
-                "be the same.".format(filename)
-            )
+            print(f"{filename}: Identifier and ParentRecipe should not be the same.")
             retval = 1
 
         # Validate that all input variables are used.
@@ -601,9 +576,7 @@ def main(argv=None):
             for os_vers_key in os_vers_corrections:
                 if os_vers_key in input_key["pkginfo"]:
                     print(
-                        "{}: You used {} when you probably meant {}.".format(
-                            filename, os_vers_key, os_vers_corrections[os_vers_key]
-                        )
+                        f"{filename}: You used {os_vers_key} when you probably meant {os_vers_corrections[os_vers_key]}."
                     )
                     retval = 1
 

pre_commit_hooks/check_jamf_json_manifests.py

@@ -71,13 +71,8 @@ def validate_key_types(name, manifest, filename):
         if manifest_key in manifest:
             if not isinstance(manifest[manifest_key], expected_type):
                 print(
-                    "{}: {} key {} should be type {}, not type {}".format(
-                        filename,
-                        name,
-                        manifest_key,
-                        expected_type,
-                        type(manifest[manifest_key]),
-                    )
+                    f"{filename}: {name} key {manifest_key} should be type "
+                    f"{expected_type}, not type {type(manifest[manifest_key])}"
                 )
                 passed = False
 
@@ -98,7 +93,7 @@ def validate_type(name, property, filename):
                 break
 
     if type_found not in MANIFEST_TYPES:
-        print('{}: Unexpected "{}" type "{}"'.format(filename, name, type_found))
+        print(f'{filename}: Unexpected "{name}" type "{type_found}"')
         passed = False
 
     return passed, type_found
@@ -121,55 +116,42 @@ def validate_list_item_types(name, manifest, filename):
                 desired_types = [MANIFEST_LIST_TYPES[name]]
             if actual_type not in desired_types:
                 print(
-                    '{}: "{}" items should be {}, not {}'.format(
-                        filename, name, MANIFEST_LIST_TYPES[name], actual_type
-                    )
+                    f'{filename}: "{name}" items should be {MANIFEST_LIST_TYPES[name]}, not {actual_type}'
                 )
                 passed = False
 
     return passed
 
 
-def validate_default(name, property, type_found, filename):
+def validate_default(name, prop, type_found, filename):
     """Ensure that default values have the expected type."""
     passed = True
 
     for test_key in ("default",):
-        if test_key in property:
-            if type(property[test_key]) == datetime:
+        if test_key in prop:
+            if isinstance(prop[test_key], datetime):
                 actual_type = str
             else:
-                actual_type = type(property[test_key])
+                actual_type = type(prop[test_key])
             if actual_type != PLIST_TYPES.get(type_found):
                 print(
-                    "{}: {} value for {} should be {}, not {}".format(
-                        filename,
-                        test_key,
-                        name,
-                        PLIST_TYPES.get(type_found),
-                        type(property[test_key]),
-                    )
+                    f"{filename}: {test_key} value for {name} should be {PLIST_TYPES.get(type_found)}, not {type(prop[test_key])}"
                 )
                 passed = False
 
     return passed
 
 
-def validate_urls(name, property, filename):
+def validate_urls(name, prop, filename):
     """Ensure that URL values are actual URLs."""
     passed = True
 
     url_keys = ("pfm_app_url", "pfm_documentation_url")
     for url_key in url_keys:
-        if url_key in property:
-            if not property[url_key].startswith("http"):
+        if url_key in prop:
+            if not prop[url_key].startswith("http"):
                 print(
-                    "{}: {} {} value doesn't look like a URL: {}".format(
-                        filename,
-                        name,
-                        url_key,
-                        property[url_key],
-                    )
+                    f"{filename}: {name} {url_key} value doesn't look like a URL: {prop[url_key]}"
                 )
                 passed = False
 
@@ -228,7 +210,7 @@ def main(argv=None):
             with open(filename, "rb") as openfile:
                 manifest = json.load(openfile)
         except json.decoder.JSONDecodeError as err:
-            print("{}: json parsing error: {}".format(filename, err))
+            print(f"{filename}: json parsing error: {err}")
             retval = 1
             break  # No need to continue checking this file
 

pre_commit_hooks/check_jamf_profiles.py

@@ -28,9 +28,9 @@ def main(argv=None):
     for filename in args.filenames:
         try:
             with open(filename, "rb") as openfile:
-                profile = plistlib.load(openfile)
+                _ = plistlib.load(openfile)
         except (ExpatError, ValueError) as err:
-            print("{}: plist parsing error: {}".format(filename, err))
+            print(f"{filename}: plist parsing error: {err}")
             retval = 1
 
     return retval