Improve debugging (#1261)

* Update pyinstaller

* Improve type hinting in pyinstaller spec

* Improve logging setup

* Add a main script with debug logging

* Disable debug logging of some modules

* Add a debug executable

Author: gentlegiantJGC

.github/workflows/python-build.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine pyinstaller~=5.6 build
+        pip install setuptools wheel twine pyinstaller~=6.18 build
 
     - name: Setup
       run: |

Amulet.spec

@@ -4,7 +4,7 @@
 
 from PyInstaller.utils.hooks import collect_submodules
 
-from typing import Dict, Tuple, Set
+from typing import Dict, Tuple, Set, TYPE_CHECKING
 import sys
 import os
 import glob
@@ -21,6 +21,13 @@ import PyMCTranslate
 import minecraft_model_reader
 import amulet_map_editor
 
+if TYPE_CHECKING:
+    from PyInstaller.building.build_main import Analysis
+    from PyInstaller.building.datastruct import Tree
+    from PyInstaller.building.api import PYZ, EXE, COLLECT
+    import PyInstaller.building.osx
+    from PyInstaller.building.osx import BUNDLE
+
 sys.modules["FixTk"] = None
 
 AMULET_NBT_PATH = amulet_nbt.__path__[0]
@@ -40,7 +47,10 @@ hidden.extend(collect_submodules("OpenGL.GL.shaders"))
 
 
 a = Analysis(
-    [os.path.join(AMULET_MAP_EDITOR, "__main__.py")],
+    [
+        os.path.join(AMULET_MAP_EDITOR, "__main__.py"),
+        os.path.join(AMULET_MAP_EDITOR, "__main_debug__.py"),
+    ],
     binaries=[],
     datas=[],
     hiddenimports=hidden,
@@ -97,6 +107,7 @@ sys.stdout.flush()  # fix the log being out of order
 pyz = PYZ(a.pure, a.zipped_data)
 exe = EXE(
     pyz,
+    a.scripts[:-1],
     a.scripts,
     [],
     exclude_binaries=True,
@@ -108,8 +119,22 @@ exe = EXE(
     console=os.name == "nt", # Only show the console on windows
     icon="icon.ico",
 )
+exe_debug = EXE(
+    pyz,
+    a.scripts[:-2] + a.scripts[-1:],
+    [],
+    exclude_binaries=True,
+    name="amulet_app_debug",
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    console=os.name == "nt", # Only show the console on windows
+    icon="icon.ico",
+)
 coll = COLLECT(
     exe,
+    exe_debug,
     a.binaries,
     a.zipfiles,
     a.datas,

amulet_map_editor/__main__.py

@@ -62,20 +62,31 @@ def _init_log():
         ):
             os.remove(path)
 
-    log = logging.getLogger()
-    log.setLevel(logging.DEBUG if "amulet-debug" in sys.argv else logging.INFO)
+    debug = "--amulet-debug" in sys.argv
 
     file_handler = logging.FileHandler(
-        os.path.join(logs_path, f"amulet_{os.getpid()}.log"), "w", encoding="utf-8"
+        os.path.join(logs_path, f"amulet_{os.getpid()}.log"),
+        "w",
+        encoding="utf-8",
     )
     file_handler.setFormatter(
-        logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+        logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s")
     )
-    log.addHandler(file_handler)
 
     console_handler = logging.StreamHandler()
-    console_handler.setFormatter(logging.Formatter("%(levelname)s - %(message)s"))
-    log.addHandler(console_handler)
+    console_handler.setFormatter(
+        logging.Formatter(
+            "%(levelname)s - %(name)s - %(message)s"
+            if debug
+            else "%(levelname)s - %(message)s"
+        )
+    )
+
+    logging.basicConfig(
+        level=logging.DEBUG if debug else logging.INFO,
+        handlers=[file_handler, console_handler],
+        force=True,
+    )
 
 
 def main():

amulet_map_editor/__main_debug__.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+
+
+def _on_error(e):
+    """Code to handle errors"""
+    try:
+        import traceback
+        import sys
+        import os
+
+    except ImportError as e:
+        # Something has gone seriously wrong
+        print(e)
+        print("Failed to import requirements. Check that you extracted correctly.")
+        input("Press ENTER to continue.")
+    else:
+        err = "\n".join(
+            [traceback.format_exc()]
+            + ["Failed to import requirements. Check that you extracted correctly."]
+            * isinstance(e, ImportError)
+            + [str(e)]
+        )
+        print(err)
+        try:
+            with open("crash.log", "w") as f:
+                f.write(err)
+        except OSError:
+            pass
+        input("Press ENTER to continue.")
+        sys.exit(1)
+
+
+try:
+    import sys
+
+    if sys.version_info[:2] < (3, 7):
+        raise Exception("Must be using Python 3.7+")
+    import logging
+    import os
+    import traceback
+    import glob
+    import time
+    import wx
+    import platformdirs
+
+    if sys.platform == "linux" and wx.VERSION >= (4, 1, 1):
+        # bug 247
+        os.environ["PYOPENGL_PLATFORM"] = "egl"
+except Exception as e_:
+    _on_error(e_)
+
+
+def _init_log():
+    logs_path = os.environ["LOG_DIR"]
+    # set up handlers
+    os.makedirs(logs_path, exist_ok=True)
+    # remove all log files older than a week
+    for path in glob.glob(os.path.join(glob.escape(logs_path), "*.log")):
+        if (
+            os.path.isfile(path)
+            and os.path.getmtime(path) < time.time() - 3600 * 24 * 7
+        ):
+            os.remove(path)
+
+    file_handler = logging.FileHandler(
+        os.path.join(logs_path, f"amulet_{os.getpid()}.log"),
+        "w",
+        encoding="utf-8",
+    )
+    file_handler.setFormatter(
+        logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s")
+    )
+
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(
+        logging.Formatter("%(levelname)s - %(name)s - %(message)s")
+    )
+
+    logging.basicConfig(
+        level=logging.DEBUG,
+        handlers=[file_handler, console_handler],
+        force=True,
+    )
+
+
+def main():
+    try:
+        # Initialise default paths.
+        data_dir = platformdirs.user_data_dir("AmuletMapEditor", "AmuletTeam")
+        os.environ.setdefault("DATA_DIR", data_dir)
+        config_dir = platformdirs.user_config_dir("AmuletMapEditor", "AmuletTeam")
+        if config_dir == data_dir:
+            config_dir = os.path.join(data_dir, "Config")
+        os.environ.setdefault("CONFIG_DIR", config_dir)
+        os.environ.setdefault(
+            "CACHE_DIR", platformdirs.user_cache_dir("AmuletMapEditor", "AmuletTeam")
+        )
+        os.environ.setdefault(
+            "LOG_DIR", platformdirs.user_log_dir("AmuletMapEditor", "AmuletTeam")
+        )
+
+        _init_log()
+        from amulet_map_editor.api.framework import AmuletApp
+
+    except Exception as e:
+        _on_error(e)
+    else:
+        try:
+            app = AmuletApp(0)
+            app.MainLoop()
+        except Exception as e:
+            log = logging.getLogger(__name__)
+            log.critical(
+                f"Amulet Crashed. Sorry about that. Please report it to a developer if you think this is an issue. \n{traceback.format_exc()}"
+            )
+            input("Press ENTER to continue.")
+
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

amulet_map_editor/api/framework/app.py

@@ -12,6 +12,8 @@
 
 # Disable OpenGL_accelerate logging
 logging.getLogger("OpenGL.acceleratesupport").setLevel(logging.CRITICAL)
+logging.getLogger("OpenGL.GL.shaders").setLevel(logging.INFO)
+logging.getLogger("PIL.PngImagePlugin").setLevel(logging.INFO)
 
 log = logging.getLogger(__name__)