add safeguard when modimporter is outdated

Author: nbusseneau

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-  Recommend users to update Mod Importer when it fails to run due to being outdated.
+
 ## [1.7.1] - 2022-07-14
 
 ### Fixed

hephaistos/cli.py

@@ -8,7 +8,7 @@
 
 from hephaistos import backups, config, hashes, helpers, interactive, lua_mod, patchers, sjson_data
 from hephaistos.config import LOGGER
-from hephaistos.helpers import HadesNotFound, HUD, Platform, Scaling
+from hephaistos.helpers import HadesNotFound, HUD, ModImporterRuntimeError, Platform, Scaling
 
 
 class ParserBase(ArgumentParser):
@@ -95,6 +95,8 @@ def __start(self) -> None:
         # handle subcommand args via SubcommandBase.dispatch handler
         try:
             args.dispatch(**vars(args))
+        except ModImporterRuntimeError as e:
+            LOGGER.error(e)
         except Exception as e:
             LOGGER.exception(e) # log any unhandled exception
         # if in interactive mode, loop until user manually closes

hephaistos/helpers.py

@@ -263,26 +263,40 @@ def remember_cwd():
         os.chdir(cwd)
 
 
+class ModImporterRuntimeError(RuntimeError): ...
+
+
 def run_modimporter(modimporter_file: Path, clean_only: bool=False) -> None:
     """Run modimporter from the Content directory, as if the user did it."""
     with remember_cwd():
         # temporarily switch to modimporter working dir (Content)
         os.chdir(modimporter_file.parent)
         # dynamically import modimporter.py if using Python version
         if modimporter_file.suffix == '.py':
-            spec = importlib.util.spec_from_file_location("modimporter", modimporter_file.name)
-            modimporter = importlib.util.module_from_spec(spec)
-            spec.loader.exec_module(modimporter)
-            modimporter.game = 'Hades'
-            modimporter.clean_only = clean_only
-            modimporter.LOGGER.setLevel(logging.ERROR)
-            modimporter.start()
+            try:
+                spec = importlib.util.spec_from_file_location("modimporter", modimporter_file.name)
+                modimporter = importlib.util.module_from_spec(spec)
+                spec.loader.exec_module(modimporter)
+                modimporter.game = 'Hades'
+                modimporter.clean_only = clean_only
+                modimporter.LOGGER.setLevel(logging.ERROR)
+                modimporter.start()
+            except AttributeError as e:
+                LOGGER.error(e)
+                raise ModImporterRuntimeError("Failed to import 'modimporter.py': your copy of 'modimporter.py' is likely outdated, please update it (a version >= 1.3.0 is required)")
         # otherwise execute modimporter directly if using binary version
         else:
             args = [modimporter_file.name, '--no-input', '--quiet', '--game', 'Hades']
             if clean_only:
                 args += ['--clean']
-            subprocess.run(args)
+            try:
+                subprocess.run(args, check=True, text=True, stderr=subprocess.PIPE)
+            except subprocess.CalledProcessError as e:
+                if "unrecognized arguments" in e.stderr:
+                    LOGGER.error(e)
+                    raise ModImporterRuntimeError("Failed to import 'modimporter.py': your copy of 'modimporter.py' is likely outdated, please update it (a version >= 1.3.0 is required)")
+                else:
+                    raise e
 
 
 def configure_screen_variables(width: int, height: int, scaling: Scaling) -> Scaling: