Specify utf-8 encoding when reading/writing plain text files

Author: homebysix

pre_commit_hooks/check_autopkg_recipe_list.py

@@ -37,7 +37,7 @@ def main(argv=None):
     for filename in args.filenames:
         recipe_list = None
         if filename.endswith(".txt"):
-            with open(filename, "r") as openfile:
+            with open(filename, "r", encoding="utf-8") as openfile:
                 recipe_list = [
                     line
                     for line in openfile.read().splitlines()
@@ -54,7 +54,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") as openfile:
+                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))
@@ -63,7 +63,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") as openfile:
+                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))

pre_commit_hooks/check_autopkg_recipes.py

@@ -20,7 +20,7 @@
 # Import AutoPkg libraries, but ignore any warnings generated by the import.
 @contextmanager
 def suppress_stdout():
-    with open(os.devnull, "w") as devnull:
+    with open(os.devnull, "w", encoding="utf-8") as devnull:
         old_stdout = sys.stdout
         sys.stdout = devnull
         try:
@@ -100,7 +100,7 @@ def validate_comments(filename, strict):
     plutil -convert xml1."""
 
     passed = True
-    with open(filename, "r") as openfile:
+    with open(filename, "r", encoding="utf-8") as openfile:
         recipe_text = openfile.read()
         if "<!--" in recipe_text and "-->" in recipe_text:
             if strict:
@@ -548,7 +548,7 @@ def main(argv=None):
             break  # No need to continue checking this file
 
         # For future implementation of validate_unused_input_vars()
-        # with open(filename, "r") as openfile:
+        # with open(filename, "r", encoding='utf-8') as openfile:
         #     recipe_text = openfile.read()
 
         # Top level keys that all AutoPkg recipes should contain.

pre_commit_hooks/check_jamf_extension_attributes.py

@@ -25,7 +25,7 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
-        with open(filename, "r") as openfile:
+        with open(filename, "r", encoding="utf-8") as openfile:
             ea_content = openfile.read()
 
         if "<result>" not in ea_content or "</result>" not in ea_content:

pre_commit_hooks/check_jamf_scripts.py

@@ -3,7 +3,6 @@
 """Check Jamf scripts for common issues."""
 
 import argparse
-import os
 
 
 def build_argument_parser():
@@ -25,7 +24,7 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
-        with open(filename, "r") as openfile:
+        with open(filename, "r", encoding="utf-8") as openfile:
             script_content = openfile.read()
 
         # Ensure script starts with a shebang of some sort.

pre_commit_hooks/check_munkipkg_buildinfo.py

@@ -89,15 +89,15 @@ def main(argv=None):
                 break  # no need to continue testing this file
         elif filename.endswith((".yaml", ".yml")):
             try:
-                with open(filename, "r") as openfile:
+                with open(filename, "r", encoding="utf-8") as openfile:
                     buildinfo = yaml.load(openfile)
             except Exception as err:
                 print("{}: yaml parsing error: {}".format(filename, err))
                 retval = 1
                 break  # no need to continue testing this file
         elif filename.endswith(".json"):
             try:
-                with open(filename, "r") as openfile:
+                with open(filename, "r", encoding="utf-8") as openfile:
                     buildinfo = json.load(openfile)
             except Exception as err:
                 print("{}: json parsing error: {}".format(filename, err))