Created warnings.py. Closes #40.

Author: MyNameIsTrez

Python/convert.py

@@ -1,22 +1,18 @@
-import os, sys, time, shutil, math, json, pathlib, webbrowser
+import os, sys, time, shutil, math, pathlib, webbrowser
 from pathlib import Path
-from jsoncomment import JsonComment
 from playsound import playsound
 
 from Python import shared_globals as cfg
 from Python import regex_rules
 from Python import zips as zips_py
 from Python import update_progress
 from Python import palette
+from Python import warnings
 
 
-warnings_file_name = "Warnings.json"
-warnings_path = os.path.join("ConversionRules", warnings_file_name)
-warnings_available = os.path.isfile(warnings_path)
+foo = "bar"
 
 conversion_rules = {}
-warning_rules = {}
-warnings = []
 
 
 # TODO: Move to shared_globals.py
@@ -30,35 +26,8 @@ def resource_path(relative_path):
 output_folder_path = ".." if getattr(sys, 'frozen', False) else "Output"
 
 
-def load_conversion_and_warning_rules():
-	json_parser = JsonComment(json)
-
-	json_files_found = 0
-	try:
-		for name in os.listdir("ConversionRules"):
-			if name.endswith(".json") and name != warnings_file_name:
-				json_files_found += 1
-				with open(os.path.join("ConversionRules", name)) as f:
-					conversion_rules.update(json_parser.load(f)) 
-		if warnings_available:
-			with open(warnings_path) as f:
-				warning_rules.update(json_parser.load(f))
-	except:
-		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder wasn't found next to this executable. You can get the missing folder from the Legacy Mod Converter GitHub repo.", title="Missing ConversionRules folder", custom_text="Go to GitHub"))
-
-	if json_files_found == 0:
-		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder didn't contain any JSON files. You can get the JSON files from the Legacy Mod Converter GitHub repo.", title="Missing JSON files", custom_text="Go to GitHub"))
-
-
-
-def check_github_button_clicked_and_exit(clicked_github_button):
-	if clicked_github_button:
-		webbrowser.open("https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter")
-	sys.exit()
-
-
 def convert():
-	global output_folder_path, warnings
+	global output_folder_path
 
 	print("") # Only prints a newline.
 
@@ -84,18 +53,19 @@ def convert():
 	if cfg.sg.user_settings_get_entry("output_zips"):
 		zips_py.create_zips(input_folder_path, output_folder_path)
 
-	if len(warnings) > 0:
-		warnings_popup()
-
-	warnings = []
+	elapsed = math.floor(time.time() - time_start)
 
 	update_progress.increment_progress() # TODO: This is a temporary solution for zipping not being accounted in the progress.
 
-	elapsed = math.floor(time.time() - time_start)
 	if cfg.sg.user_settings_get_entry("play_finish_sound"):
 		playsound(resource_path("Media/finish.wav"), block=False)
 	print("Finished in {} {}".format(elapsed, pluralize("second", elapsed)))
 
+	if len(warnings.warning_results) > 0:
+		warnings.warnings_popup()
+
+	warnings.warning_results = []
+
 
 def get_mod_subfolder(input_folder_path, input_subfolder_path):
 	if input_folder_path.endswith(".rte"):
@@ -149,12 +119,12 @@ def create_converted_file(input_file_path, output_file_path, input_folder_path):
 			for line in file_in:
 				line_number += 1
 
-				if warnings_available:
-					regex_rules.playsound_warning(line, file_path, line_number, warnings)
+				if warnings.warnings_available:
+					regex_rules.playsound_warning(line, file_path, line_number)
 
-					for old_str, new_str in warning_rules.items():
+					for old_str, new_str in warnings.warning_rules.items():
 						if old_str in line:
-							warnings.append("'{}' line {}: {} -> {}".format(file_path, line_number, old_str, new_str))
+							warnings.warning_results.append("'{}' line {}: {} -> {}".format(file_path, line_number, old_str, new_str))
 
 				all_lines_list.append(line)
 
@@ -169,12 +139,5 @@ def create_converted_file(input_file_path, output_file_path, input_folder_path):
 	# 	shutil.copyfile(input_file_path, output_file_path)
 
 
-def warnings_popup():
-	if warnings_available:
-		w = max(30, len(max(warnings, key=len)))
-		h = min(50, len(warnings)) + 1 # + 1 necessary because popup_scrolled adds an extra line.
-		cfg.sg.popup_scrolled("\n".join(warnings), title="Lines needing manual replacing", size=(w, h), button_color=cfg.sg.theme_button_color(), background_color=cfg.sg.theme_background_color())
-
-
 def pluralize(word, count):
 	return word + "s" if count != 1 else word

Python/gui.py

@@ -4,6 +4,7 @@
 
 from Python import shared_globals as cfg
 from Python import convert
+from Python import warnings
 
 
 no_path_set_color = "#b35858"
@@ -82,7 +83,7 @@ def init_window():
 	]
 
 	cfg.sg = sg
-	convert.load_conversion_and_warning_rules()
+	warnings.load_conversion_and_warning_rules()
 
 	window = sg.Window("Legacy Mod Converter", layout, icon=resource_path("Media/legacy-mod-converter.ico"), font=("Helvetica", 16))
 	cfg.progress_bar = window["-PROGRESS BAR-"]

Python/palette.py

@@ -1,7 +1,6 @@
-import os
+import os, sys, io, cv2
 
 from PIL import Image
-import cv2
 
 
 palette = Image.open(os.path.join("Media", "palette.bmp")).getpalette()
@@ -14,22 +13,63 @@ def is_input_image(full_filename):
 def process_image(full_filename, input_image_path, output_image_path):
 	global palette
 
-	# A bmp threw an "Unsupported BMP compression (1)" with Image.open(), so we open it in cv2 first.
-	# cv2 solution: https://stackoverflow.com/a/52416250/13279557
-	# cv2 to PIL:   https://stackoverflow.com/a/43234001/13279557
-	# old_img = Image.fromarray(cv2.imread(input_image_path)) # TODO: This may work just as well as the line below for all cases. 
-	old_img = Image.fromarray(cv2.cvtColor(cv2.imread(input_image_path), cv2.COLOR_BGR2RGB))
+	old_img = get_old_img(input_image_path)
 
-	scale = 1
-	old_img = old_img.resize((int(old_img.width * scale), int(old_img.height * scale)))
+	# scale = 1
+	# old_img = old_img.resize((int(old_img.width * scale), int(old_img.height * scale)))
 
-	# putpalette() always expects 256 * 3 ints.
-	for k in range(256 - int(len(palette) / 3)):
-		for j in range(3):
-			palette.append(palette[j])
+	# # putpalette() always expects 256 * 3 ints.
+	# for k in range(256 - int(len(palette) / 3)):
+	# 	for j in range(3):
+	# 		palette.append(palette[j])
 
-	palette_img = Image.new('P', (1, 1))
-	palette_img.putpalette(palette)
-	new_img = old_img.convert(mode="RGB").quantize(palette=palette_img, dither=False)
+	# palette_img = Image.new('P', (1, 1))
+	# palette_img.putpalette(palette)
+	# new_img = old_img.convert(mode="RGB").quantize(palette=palette_img, dither=False)
 
-	new_img.save(os.path.splitext(output_image_path)[0] + ".png")
+	# new_img.save(os.path.splitext(output_image_path)[0] + ".png")
+
+
+def get_old_img(input_image_path):
+	# This prevents cv2 from printing warnings to the terminal.
+	# TODO: Fix the cv2 and PIL bmp reading issue instead of redirecting a warning away from the terminal.
+	with suppress_stdout_stderr():
+		# A bmp threw an "Unsupported BMP compression (1)" with Image.open(), so we open it in cv2 first.
+		# cv2 solution: https://stackoverflow.com/a/52416250/13279557
+		# cv2 to PIL:   https://stackoverflow.com/a/43234001/13279557
+		# old_img = Image.fromarray(cv2.imread(input_image_path)) # TODO: This may work just as well as the line below for all cases.
+		old_img = Image.fromarray(cv2.cvtColor(cv2.imread(input_image_path), cv2.COLOR_BGR2RGB))
+
+	return old_img
+
+
+# This stackoverflow's question answers itself in the question with the solution to getting rid of "libpng warning: iCCP: known incorrect sRGB profile".
+# https://stackoverflow.com/q/11130156/13279557
+class suppress_stdout_stderr(object):
+    '''
+    A context manager for doing a "deep suppression" of stdout and stderr in 
+    Python, i.e. will suppress all print, even if the print originates in a 
+    compiled C/Fortran sub-function.
+    	This will not suppress raised exceptions, since exceptions are printed
+    to stderr just before a script exits, and after the context manager has
+    exited (at least, I think that is why it lets exceptions through).      
+
+    '''
+    def __init__(self):
+        # Open a pair of null files
+        self.null_fds =  [os.open(os.devnull,os.O_RDWR) for x in range(2)]
+        # Save the actual stdout (1) and stderr (2) file descriptors.
+        self.save_fds = [os.dup(1), os.dup(2)]
+
+    def __enter__(self):
+        # Assign the null pointers to stdout and stderr.
+        os.dup2(self.null_fds[0],1)
+        os.dup2(self.null_fds[1],2)
+
+    def __exit__(self, *_):
+        # Re-assign the real stdout/stderr back to (1) and (2)
+        os.dup2(self.save_fds[0],1)
+        os.dup2(self.save_fds[1],2)
+        # Close all file descriptors
+        for fd in self.null_fds + self.save_fds:
+            os.close(fd)

Python/regex_rules.py

@@ -1,5 +1,7 @@
 import re
 
+from Python import warnings
+
 
 def regex_replace(all_lines):
 	all_lines = simple_replace(all_lines, "Framerate = (.*)", "SpriteAnimMode = 7")
@@ -81,9 +83,9 @@ def regex_replace_bmps_and_wavs(all_lines):
 	return all_lines
 
 
-def playsound_warning(line, file_path, line_number, warnings):
+def playsound_warning(line, file_path, line_number):
 	pattern = "PlaySound(.*)"
 	message = "No longer supported. Create a SoundContainer with CreateSoundContainer in the appropriate Create function."
 	matches = re.findall(pattern, line)
 	if len(matches) > 0 and matches[0].count(",") > 2:
-		warnings.append("'{}' line {}: {} -> {}".format(file_path, line_number, pattern, message))
+		warnings.warning_results.append("'{}' line {}: {} -> {}".format(file_path, line_number, pattern, message))

Python/warnings.py

@@ -0,0 +1,46 @@
+import os, sys, json
+from jsoncomment import JsonComment
+
+from Python import shared_globals as cfg
+from Python import convert
+
+
+warnings_file_name = "Warnings.json"
+warnings_path = os.path.join("ConversionRules", warnings_file_name)
+warnings_available = os.path.isfile(warnings_path)
+
+warning_rules = {}
+warning_results = []
+
+
+def load_conversion_and_warning_rules():
+	json_parser = JsonComment(json)
+
+	json_files_found = 0
+	try:
+		for name in os.listdir("ConversionRules"):
+			if name.endswith(".json") and name != warnings_file_name:
+				json_files_found += 1
+				with open(os.path.join("ConversionRules", name)) as f:
+					convert.conversion_rules.update(json_parser.load(f)) 
+		if warnings_available:
+			with open(warnings_path) as f:
+				warning_rules.update(json_parser.load(f))
+	except:
+		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder wasn't found next to this executable. You can get the missing folder from the Legacy Mod Converter GitHub repo.", title="Missing ConversionRules folder", custom_text="Go to GitHub"))
+
+	if json_files_found == 0:
+		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder didn't contain any JSON files. You can get the JSON files from the Legacy Mod Converter GitHub repo.", title="Missing JSON files", custom_text="Go to GitHub"))
+
+
+def check_github_button_clicked_and_exit(clicked_github_button):
+	if clicked_github_button:
+		webbrowser.open("https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter")
+	sys.exit()
+
+
+def warnings_popup():
+	if warnings_available:
+		w = max(30, len(max(warning_results, key=len)))
+		h = min(50, len(warning_results)) + 1 # + 1 necessary because popup_scrolled adds an extra line.
+		cfg.sg.popup_scrolled("\n".join(warning_results), title="Lines needing manual replacing", size=(w, h), button_color=cfg.sg.theme_button_color(), background_color=cfg.sg.theme_background_color())