refactor: single entry for settings checker. import extension check settings as dict.

Author: andkay

activitysim/abm/models/settings_checker.py

@@ -610,7 +610,12 @@ def try_load_and_check_spec_coefs(
     return errors
 
 
-def check_model_settings(state: State, checker_settings=CHECKER_SETTINGS) -> None:
+def check_model_settings(
+        state: State, 
+        checker_settings: dict = CHECKER_SETTINGS, 
+        extension_settings: dict = {}, 
+        log_file: str ="settings_checker.log"
+) -> None:
 
     # Collect all errors
     all_errors = []
@@ -619,14 +624,18 @@ def check_model_settings(state: State, checker_settings=CHECKER_SETTINGS) -> Non
     formatter = logging.Formatter(
         "%(asctime)s - %(levelname)s - %(message)s", datefmt="%Y-%m-%d %H:%M:%S"
     )
-    out_log_file = state.get_log_file_path("settings_checker.log")
+    out_log_file = state.get_log_file_path(log_file)
     if os.path.exists(out_log_file):
         os.remove(out_log_file)
     module_handler = logging.FileHandler(out_log_file)
     module_handler.setFormatter(formatter)
     file_logger.addHandler(module_handler)
     file_logger.propagate = False
 
+    # add extension settings to checker settings
+    if extension_settings is not None:
+        checker_settings.update(extension_settings)
+    
     # extract all model components
     all_models = state.settings.models
 
@@ -718,8 +727,8 @@ def check_model_settings(state: State, checker_settings=CHECKER_SETTINGS) -> Non
             logger.error(f"\t{str(e)}")
             file_logger.error(f"\t{str(e)}")
         raise RuntimeError(
-            "Encountered error in settings checker. See settings_checker.log for details."
+            f"Encountered one or more errors in settings checker. See f{log_file} for details."
         )
-    msg = "Setting Checker Complete. No runtime errors were raised. Check settings_checker.log for warnings. These may prevent model from successfully running."
+    msg = f"Setting Checker Complete. No runtime errors were raised. Check f{log_file} for warnings. These *may* prevent model from successfully running."
     logger.info(msg)
     file_logger.info(msg)

activitysim/cli/run.py

@@ -174,7 +174,7 @@ def inject_arg(name, value):
                 logger.exception(f"Error {err}")
                 raise
             finally:
-                del sys.path[0]
+               del sys.path[0]
         inject_arg("imported_extensions", args.ext)
     else:
         inject_arg("imported_extensions", ())
@@ -285,7 +285,7 @@ def run(args):
         # Memory sidecar is only useful for single process runs
         # multiprocess runs log memory usage without blocking in the controlling process.
         mem_prof_log = state.get_log_file_path("memory_profile.csv")
-        from ..core.memory_sidecar import MemorySidecar
+        from activitysim.core.memory_sidecar import MemorySidecar
 
         memory_sidecar_process = MemorySidecar(mem_prof_log)
     else:
@@ -372,9 +372,23 @@ def run(args):
 
     t0 = tracing.print_elapsed_time()
 
-    logger.info("Checking Settings Files")
+    
     if state.settings.check_model_settings == True:
-        check_model_settings(state)
+        logger.info("Settings checker will check core settings files. See settings_checker.log for details.")
+        # get any additional settings definitions from extensions
+        extension_checker_settings = {}
+        extension_names = state.get_injectable("imported_extensions")
+        if extension_names:
+            for ext in extension_names:
+                try:
+                    settings_checker_ext = importlib.import_module(ext + ".settings_checker")
+                    extension_checker_settings.update(settings_checker_ext.EXTENSION_CHECKER_SETTINGS)
+                    # settings_checker_ext.check_extension_model_settings(state, log_file="settings_checker_extensions.log")
+                except ImportError:
+                    logger.warning(
+                        f"Extension {ext} does not have a settings_checker module or it cannot be imported."
+                    )
+        check_model_settings(state, extension_settings=extension_checker_settings)
 
     try:
         if state.settings.multiprocess: