Add type hints to functions

Author: homebysix

pre_commit_hooks/check_autopkg_recipe_list.py

@@ -8,14 +8,15 @@
 import argparse
 import json
 import plistlib
+from typing import List, Optional
 from xml.parsers.expat import ExpatError
 
 import ruamel.yaml
 
 yaml = ruamel.yaml.YAML(typ="safe")
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -25,7 +26,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_autopkg_recipes.py

@@ -6,6 +6,7 @@
 import os
 import sys
 from contextlib import contextmanager
+from typing import Any, Dict, List
 
 from packaging.version import Version
 
@@ -23,7 +24,7 @@
 
 # Import AutoPkg libraries, but ignore any warnings generated by the import.
 @contextmanager
-def suppress_stdout():
+def suppress_stdout() -> Any:
     with open(os.devnull, "w", encoding="utf-8") as devnull:
         old_stdout = sys.stdout
         sys.stdout = devnull
@@ -36,15 +37,18 @@ def suppress_stdout():
 sys.path.append("/Library/AutoPkg")
 try:
     with suppress_stdout():
-        from autopkglib import get_processor, processor_names
+        from autopkglib import (  # type: ignore[import-not-found]
+            get_processor,
+            processor_names,
+        )
 
     HAS_AUTOPKGLIB = True
 except ImportError:
     # Silently skip checks that require autopkglib.
     HAS_AUTOPKGLIB = False
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -83,7 +87,9 @@ def build_argument_parser():
     return parser
 
 
-def validate_recipe_prefix(recipe, filename, prefix):
+def validate_recipe_prefix(
+    recipe: Dict[str, Any], filename: str, prefix: List[str]
+) -> bool:
     """Verify that the recipe identifier starts with the expected prefix."""
 
     passed = True

pre_commit_hooks/check_git_config_email.py

@@ -3,9 +3,10 @@
 
 import argparse
 import subprocess
+from typing import List, Optional
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -19,7 +20,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_jamf_extension_attributes.py

@@ -3,11 +3,12 @@
 
 import argparse
 import re
+from typing import List, Optional
 
 from pre_commit_hooks.util import validate_shebangs
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -23,7 +24,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_jamf_json_manifests.py

@@ -8,6 +8,7 @@
 import argparse
 import json
 from datetime import datetime
+from typing import Any, Dict, List, Optional, Tuple
 
 from pre_commit_hooks.util import validate_required_keys
 
@@ -34,7 +35,7 @@
 }
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -44,7 +45,7 @@ def build_argument_parser():
     return parser
 
 
-def validate_key_types(name, manifest, filename):
+def validate_key_types(name: str, manifest: Dict[str, Any], filename: str) -> bool:
     """Validation of manifest key types."""
 
     # Manifest keys and their known types. Omitted keys are left unvalidated.
@@ -78,7 +79,9 @@ def validate_key_types(name, manifest, filename):
     return passed
 
 
-def validate_type(name, property, filename):
+def validate_type(
+    name: str, property: Dict[str, Any], filename: str
+) -> Tuple[bool, Optional[str]]:  # noqa: A002
     """Ensure property type keu is present and among expected values."""
     passed = True
     type_found = None
@@ -98,7 +101,9 @@ def validate_type(name, property, filename):
     return passed, type_found
 
 
-def validate_list_item_types(name, manifest, filename):
+def validate_list_item_types(
+    name: str, manifest: Dict[str, Any], filename: str
+) -> bool:
     """Validation of list member items."""
 
     passed = True
@@ -109,10 +114,13 @@ def validate_list_item_types(name, manifest, filename):
             except IndexError:
                 # Probably an empty array; no way to validate items
                 continue
-            if isinstance(MANIFEST_LIST_TYPES[name], tuple):
-                desired_types = MANIFEST_LIST_TYPES[name]
+            manifest_list_type = MANIFEST_LIST_TYPES[name]
+            if isinstance(manifest_list_type, tuple):
+                # MANIFEST_LIST_TYPES[name] is a tuple of types
+                desired_types = list(manifest_list_type)
             else:
-                desired_types = [MANIFEST_LIST_TYPES[name]]
+                # MANIFEST_LIST_TYPES[name] is a single type
+                desired_types = [manifest_list_type]
             if actual_type not in desired_types:
                 print(
                     f'{filename}: "{name}" items should be {MANIFEST_LIST_TYPES[name]}, not {actual_type}'
@@ -122,7 +130,9 @@ def validate_list_item_types(name, manifest, filename):
     return passed
 
 
-def validate_default(name, prop, type_found, filename):
+def validate_default(
+    name: str, prop: Dict[str, Any], type_found: Optional[str], filename: str
+) -> bool:
     """Ensure that default values have the expected type."""
     passed = True
 
@@ -132,16 +142,16 @@ def validate_default(name, prop, type_found, filename):
                 actual_type = str
             else:
                 actual_type = type(prop[test_key])
-            if actual_type != MANIFEST_TYPES.get(type_found):
+            if actual_type != MANIFEST_TYPES.get(type_found) if type_found else None:
                 print(
-                    f"{filename}: {test_key} value for {name} should be {MANIFEST_TYPES.get(type_found)}, not {type(prop[test_key])}"
+                    f"{filename}: {test_key} value for {name} should be {MANIFEST_TYPES.get(type_found) if type_found else 'Unknown'}, not {type(prop[test_key])}"
                 )
                 passed = False
 
     return passed
 
 
-def validate_urls(name, prop, filename):
+def validate_urls(name: str, prop: Dict[str, Any], filename: str) -> bool:
     """Ensure that URL values are actual URLs."""
     passed = True
 
@@ -157,7 +167,7 @@ def validate_urls(name, prop, filename):
     return passed
 
 
-def validate_properties(properties, filename):
+def validate_properties(properties: Dict[str, Any], filename: str) -> bool:
     """Given a list of properties, run validation on their contents."""
     passed = True
 
@@ -196,7 +206,7 @@ def validate_properties(properties, filename):
     return passed
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.
@@ -214,7 +224,7 @@ def main(argv=None):
             break  # No need to continue checking this file
 
         # Check for presence of required keys.
-        required_keys = ("title", "properties", "description")
+        required_keys = ["title", "properties", "description"]
         if not validate_required_keys(manifest, filename, required_keys):
             retval = 1
             break  # No need to continue checking this file

pre_commit_hooks/check_jamf_profiles.py

@@ -3,10 +3,11 @@
 
 import argparse
 import plistlib
+from typing import List, Optional
 from xml.parsers.expat import ExpatError
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -16,7 +17,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_jamf_scripts.py

@@ -2,11 +2,12 @@
 """Check Jamf scripts for common issues."""
 
 import argparse
+from typing import List, Optional
 
 from pre_commit_hooks.util import validate_shebangs
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -22,7 +23,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_munki_pkgsinfo.py

@@ -5,6 +5,7 @@
 import os
 import plistlib
 from pathlib import Path
+from typing import List, Optional
 from xml.parsers.expat import ExpatError
 
 from pre_commit_hooks.util import (
@@ -19,7 +20,7 @@
 )
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -70,7 +71,7 @@ def build_argument_parser():
     return parser
 
 
-def _check_case_sensitive_path(path):
+def _check_case_sensitive_path(path: str) -> bool:
     """Check whether a path exists, and on case-sensitive filesystems check
     that there is no case conflict."""
     # Return immediately if the file does not exist
@@ -88,7 +89,7 @@ def _check_case_sensitive_path(path):
         p = p.parent
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Typical extensions for installer packages.

pre_commit_hooks/check_munkiadmin_scripts.py

@@ -3,11 +3,12 @@
 
 import argparse
 import os
+from typing import List, Optional
 
 from pre_commit_hooks.util import validate_shebangs
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -17,7 +18,7 @@ def build_argument_parser():
     return parser
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.

pre_commit_hooks/check_munkipkg_buildinfo.py

@@ -4,6 +4,7 @@
 import argparse
 import json
 import plistlib
+from typing import Any, Dict, List, Optional
 from xml.parsers.expat import ExpatError
 
 import ruamel.yaml
@@ -13,7 +14,7 @@
 yaml = ruamel.yaml.YAML(typ="safe")
 
 
-def build_argument_parser():
+def build_argument_parser() -> argparse.ArgumentParser:
     """Build and return the argument parser."""
 
     parser = argparse.ArgumentParser(
@@ -28,7 +29,7 @@ def build_argument_parser():
     return parser
 
 
-def validate_buildinfo_key_types(buildinfo, filename):
+def validate_buildinfo_key_types(buildinfo: Dict[str, Any], filename: str) -> bool:
     """Ensure build-info files contain the proper types."""
 
     # Pkginfo keys and their known types. Omitted keys are left unvalidated.
@@ -61,7 +62,7 @@ def validate_buildinfo_key_types(buildinfo, filename):
     return passed
 
 
-def main(argv=None):
+def main(argv: Optional[List[str]] = None) -> int:
     """Main process."""
 
     # Parse command line arguments.
@@ -104,7 +105,7 @@ def main(argv=None):
         # Top level keys that all build-info files should contain.
         # NOTE: Even though other keys are listed as non-"optional" in the documentation,
         # name and version appear to be the only ones that are actually required.
-        required_keys = ("name", "version")
+        required_keys = ["name", "version"]
         if not validate_required_keys(buildinfo, filename, required_keys):
             retval = 1
             break  # No need to continue checking this file