Merge pull request #81 from homebysix/1.16.2

homebysix · web-flow · commit 7c1eb213fdac · 2024-06-10T09:16:01.000-07:00
1.16.2 merge to main
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,12 +10,16 @@ repos:
       - id: check-merge-conflict
       - id: check-yaml
       - id: end-of-file-fixer
-      - id: fix-encoding-pragma
       - id: mixed-line-ending
       - id: no-commit-to-branch
         args: [--branch, main]
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.16.0
+    hooks:
+      - id: pyupgrade
+        args: ['--py36-plus']
   - repo: https://github.com/python/black
     rev: 24.4.2
     hooks:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,21 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.16.2] - 2024-06-10
+
+### Fixed
+
+- Fixed two bugs in shebang validation that would result in ModuleNotFoundError when running check-munki-pkgsinfo hook.
+
+### Removed
+
+- Dropped Python 2 string instance validation. No further support will be provided for Python 2.
+
+### Changed
+
+- Added PyUpgrade hook to this repo's own pre-commit linting, in order to ensure modern Python syntax.
+- Don't specify `"r"` mode when using `open()`, as this is the default behavior.
+
 ## [1.16.1] - 2024-06-08
 
 ### Added
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ For any hook in this repo you wish to use, add the following to your pre-commit
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.16.1
+    rev: v1.16.2
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -141,7 +141,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.16.1
+    rev: v1.16.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -151,7 +151,7 @@ But if you also use the `--categories` argument, you would move the trailing `--
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.16.1
+    rev: v1.16.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -163,7 +163,7 @@ If it looks better to your eye, feel free to use a multi-line list for long argu
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.16.1
+    rev: v1.16.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: [
diff --git a/pre_commit_hooks/check_autopkg_recipe_list.py b/pre_commit_hooks/check_autopkg_recipe_list.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks AutoPkg recipe lists (in txt, plist, yaml, or json format)
 for common issues.
 
@@ -37,7 +36,7 @@ def main(argv=None):
     for filename in args.filenames:
         recipe_list = None
         if filename.endswith(".txt"):
-            with open(filename, "r", encoding="utf-8") as openfile:
+            with open(filename, encoding="utf-8") as openfile:
                 recipe_list = [
                     line
                     for line in openfile.read().splitlines()
@@ -54,7 +53,7 @@ def main(argv=None):
             # AutoPkg does not support YAML recipe lists, but AutoPkg users
             # may have developed custom tooling for this.
             try:
-                with open(filename, "r", encoding="utf-8") as openfile:
+                with open(filename, encoding="utf-8") as openfile:
                     recipe_list = yaml.load(openfile)
             except Exception as err:
                 print(f"{filename}: yaml parsing error: {err}")
@@ -63,7 +62,7 @@ def main(argv=None):
             # AutoPkg does not support JSON recipe lists, but AutoPkg users
             # may have developed custom tooling for this.
             try:
-                with open(filename, "r", encoding="utf-8") as openfile:
+                with open(filename, encoding="utf-8") as openfile:
                     recipe_list = json.load(openfile)
             except Exception as err:
                 print(f"{filename}: json parsing error: {err}")
@@ -73,7 +72,7 @@ def main(argv=None):
             print(f"{filename}: invalid recipe list")
             retval = 1
         else:
-            if any((".munki" in recipe for recipe in recipe_list)):
+            if any(".munki" in recipe for recipe in recipe_list):
                 if "MakeCatalogs" not in recipe_list[-1]:
                     print("{}: MakeCatalogs should be the last item in the list")
                     retval = 1
diff --git a/pre_commit_hooks/check_autopkg_recipes.py b/pre_commit_hooks/check_autopkg_recipes.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks AutoPkg recipes to ensure they meet various
 requirements."""
 
@@ -100,7 +99,7 @@ def validate_comments(filename, strict):
     plutil -convert xml1."""
 
     passed = True
-    with open(filename, "r", encoding="utf-8") as openfile:
+    with open(filename, encoding="utf-8") as openfile:
         recipe_text = openfile.read()
         if "<!--" in recipe_text and "-->" in recipe_text:
             if strict:
diff --git a/pre_commit_hooks/check_git_config_email.py b/pre_commit_hooks/check_git_config_email.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks to ensure the Git config email matches one of the specified domains."""
 
 import argparse
@@ -43,7 +42,7 @@ def main(argv=None):
             print("Git config email does not look like an email address.")
             print("Git config email: " + user_email)
             retval = 1
-        elif not any((user_email.endswith("@" + x) for x in args.domains)):
+        elif not any(user_email.endswith("@" + x) for x in args.domains):
             print("Git config email is from an unexpected domain.")
             print("Git config email: " + user_email)
             print("Expected domains: " + str(args.domains))
diff --git a/pre_commit_hooks/check_jamf_extension_attributes.py b/pre_commit_hooks/check_jamf_extension_attributes.py
@@ -1,11 +1,10 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """Check Jamf extension attributes for common issues."""
 
 import argparse
 import re
 
-from util import validate_shebangs
+from pre_commit_hooks.util import validate_shebangs
 
 
 def build_argument_parser():
@@ -33,7 +32,7 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
-        with open(filename, "r", encoding="utf-8") as openfile:
+        with open(filename, encoding="utf-8") as openfile:
             ea_content = openfile.read()
 
         # Ensure script contains both <result> and </result> tags
diff --git a/pre_commit_hooks/check_jamf_json_manifests.py b/pre_commit_hooks/check_jamf_json_manifests.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks Jamf JSON schema custom app manifests for inconsistencies and common issues."""
 
 # References:
diff --git a/pre_commit_hooks/check_jamf_profiles.py b/pre_commit_hooks/check_jamf_profiles.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """Check Jamf scripts for common issues."""
 
 import argparse
diff --git a/pre_commit_hooks/check_jamf_scripts.py b/pre_commit_hooks/check_jamf_scripts.py
@@ -1,10 +1,9 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """Check Jamf scripts for common issues."""
 
 import argparse
 
-from util import validate_shebangs
+from pre_commit_hooks.util import validate_shebangs
 
 
 def build_argument_parser():
@@ -32,7 +31,7 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
-        with open(filename, "r", encoding="utf-8") as openfile:
+        with open(filename, encoding="utf-8") as openfile:
             script_content = openfile.read()
 
         # Ensure script starts with a shebang of some sort.
diff --git a/pre_commit_hooks/check_munki_pkgsinfo.py b/pre_commit_hooks/check_munki_pkgsinfo.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks Munki pkginfo files to ensure they are valid."""
 
 import argparse
@@ -8,12 +7,12 @@
 from pathlib import Path
 from xml.parsers.expat import ExpatError
 
-from util import validate_shebangs
 
 from pre_commit_hooks.util import (
     validate_pkginfo_key_types,
     validate_required_keys,
     validate_restart_action_key,
+    validate_shebangs,
 )
 
 
diff --git a/pre_commit_hooks/check_munkiadmin_scripts.py b/pre_commit_hooks/check_munkiadmin_scripts.py
@@ -1,11 +1,10 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook ensures MunkiAdmin scripts are executable."""
 
 import argparse
 import os
 
-from util import validate_shebangs
+from pre_commit_hooks.util import validate_shebangs
 
 
 def build_argument_parser():
@@ -34,7 +33,7 @@ def main(argv=None):
             retval = 1
 
         # Ensure scripts have a proper shebang
-        with open(filename, "r", encoding="utf-8") as openfile:
+        with open(filename, encoding="utf-8") as openfile:
             script_content = openfile.read()
         if not validate_shebangs(script_content, filename):
             print(f"{filename}: does not start with a valid shebang")
diff --git a/pre_commit_hooks/check_munkipkg_buildinfo.py b/pre_commit_hooks/check_munkipkg_buildinfo.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """Check MunkiPkg build-info files to ensure they are valid."""
 
 import argparse
@@ -86,15 +85,15 @@ def main(argv=None):
                 break  # no need to continue testing this file
         elif filename.endswith((".yaml", ".yml")):
             try:
-                with open(filename, "r", encoding="utf-8") as openfile:
+                with open(filename, encoding="utf-8") as openfile:
                     buildinfo = yaml.load(openfile)
             except Exception as err:
                 print(f"{filename}: yaml parsing error: {err}")
                 retval = 1
                 break  # no need to continue testing this file
         elif filename.endswith(".json"):
             try:
-                with open(filename, "r", encoding="utf-8") as openfile:
+                with open(filename, encoding="utf-8") as openfile:
                     buildinfo = json.load(openfile)
             except Exception as err:
                 print(f"{filename}: json parsing error: {err}")
diff --git a/pre_commit_hooks/check_outset_scripts.py b/pre_commit_hooks/check_outset_scripts.py
@@ -1,11 +1,10 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """Check Outset scripts to ensure they are executable."""
 
 import argparse
 import os
 
-from util import validate_shebangs
+from pre_commit_hooks.util import validate_shebangs
 
 
 def build_argument_parser():
@@ -32,7 +31,7 @@ def main(argv=None):
             retval = 1
 
         # Ensure scripts have a proper shebang
-        with open(filename, "r", encoding="utf-8") as openfile:
+        with open(filename, encoding="utf-8") as openfile:
             script_content = openfile.read()
         if not validate_shebangs(script_content, filename):
             print(f"{filename}: does not start with a valid shebang")
diff --git a/pre_commit_hooks/check_plists.py b/pre_commit_hooks/check_plists.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks XML property list (plist) files for basic syntax errors."""
 
 import argparse
diff --git a/pre_commit_hooks/check_preference_manifests.py b/pre_commit_hooks/check_preference_manifests.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook checks Apple preference manifest plists for inconsistencies and common issues."""
 
 # References:
diff --git a/pre_commit_hooks/forbid_autopkg_overrides.py b/pre_commit_hooks/forbid_autopkg_overrides.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook prevents AutoPkg overrides from being added to the repo."""
 
 import argparse
diff --git a/pre_commit_hooks/forbid_autopkg_trust_info.py b/pre_commit_hooks/forbid_autopkg_trust_info.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook prevents AutoPkg recipes with trust info from being added to the
 repo."""
 
diff --git a/pre_commit_hooks/munki_makecatalogs.py b/pre_commit_hooks/munki_makecatalogs.py
@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- coding: utf-8 -*-
 """This hook runs the "makecatalogs" command to ensure all referenced packages
 are present and catalogs are up to date."""
 
diff --git a/pre_commit_hooks/util.py b/pre_commit_hooks/util.py
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#!/usr/bin/python`
`2`		`-# -- coding: utf-8 --`
`3`	`2`	`"""This hook checks Jamf JSON schema custom app manifests for inconsistencies and common issues."""`
`4`	`3`
`5`	`4`	`# References:`