Refactor EventHandler import: move from model_system_event_listener to event_handler

Author: samakinen

Scripts/assignment/assignment_period.py

@@ -3,7 +3,7 @@
 import pandas
 
 from typing import TYPE_CHECKING, Any, Dict, Optional, Union
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 import utils.log as log
 import parameters.assignment as param
 import parameters.zone as zone_param

Scripts/assignment/emme_assignment.py

@@ -10,7 +10,7 @@
 import parameters.zone as zone_param
 from assignment.abstract_assignment import AssignmentModel
 from assignment.assignment_period import AssignmentPeriod
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 if TYPE_CHECKING:
     from assignment.emme_bindings.emme_project import EmmeProject
     from assignment.datatypes.transit_fare import TransitFareZoneSpecification

Scripts/events/event_handler.py

@@ -0,0 +1,68 @@
+from sys import gettrace
+import importlib.util
+from utils import log
+from pathlib import Path
+from events.model_system_event_listener import ModelSystemEventListener
+
+
+class EventHandler(ModelSystemEventListener):
+    """Event handler that calls all equivalent methods in all other ModelSystemEventListener classes."""
+    def __init__(self):
+        """Initialize the EventHandler.
+
+        Args:
+            model_system (ModelSystem): ModelSystem instance.
+        """
+        super().__init__()
+        self.listeners = []
+        self._create_methods()
+
+    def register_listener(self, listener: ModelSystemEventListener):
+        self.listeners.append(listener)
+
+    def load_listeners(self, listener_path: Path):
+        """Load all listeners from a given path.
+
+        Args:
+            listener_path (str): The path to the listeners.
+        """
+        for file_path in listener_path.glob("*.py"):
+            if file_path.name != "__init__.py":
+                try:
+                    module_name = file_path.stem
+                    spec = importlib.util.spec_from_file_location(module_name, file_path)
+                    module = importlib.util.module_from_spec(spec)
+                    spec.loader.exec_module(module)
+                    for attr_name in dir(module):
+                        attr = getattr(module, attr_name)
+                        if isinstance(attr, type) and issubclass(attr, ModelSystemEventListener) and attr is not ModelSystemEventListener:
+                            self.register_listener(attr())
+                            log.info(f"Loaded listener {attr.__name__} from {file_path}")
+                except Exception as e:
+                    log.error(f"Error loading listener from {file_path}: {e}")
+
+
+    def _create_methods(self):
+        """Create methods that call all equivalent methods in all other ModelSystemEventListener classes.
+        Methods area automatically created for all methods that start with "on_" in all ModelSystemEventListener classes.
+        """
+        for method_name in dir(ModelSystemEventListener):
+            if method_name.startswith("on_") and callable(getattr(ModelSystemEventListener, method_name)):
+                setattr(self, method_name, self._create_method(method_name))
+                
+    def _create_method(self, method_name):
+        """Create a method that calls all equivalent methods in all other ModelSystemEventListener classes.
+
+        Args:
+            method_name (str): name of the method to create.
+        """
+        def method(*args, **kwargs):
+            for listener in self.listeners:
+                try:
+                    getattr(listener, method_name)(*args, **kwargs)
+                except Exception as e:
+                    if gettrace() is not None:
+                        # Re-raise exception if debugger is attached
+                        raise e
+                    log.error(f"Error in {listener.__class__.__name__}.{method_name}: {e}")
+        return method

Scripts/events/model_system_event_listener.py

@@ -1,9 +1,6 @@
 from abc import ABC
 from typing import TYPE_CHECKING, Dict, Union
-from sys import gettrace
-from utils import log
 from pathlib import Path
-import importlib.util
 
 if TYPE_CHECKING:
     import pandas as pd
@@ -308,61 +305,3 @@ def on_daily_results_aggregated(self, assignment_model: 'EmmeAssignmentModel', d
         pass
 
 
-class EventHandler(ModelSystemEventListener):
-    """Event handler that calls all equivalent methods in all other ModelSystemEventListener classes."""
-    def __init__(self):
-        """Initialize the EventHandler.
-
-        Args:
-            model_system (ModelSystem): ModelSystem instance.
-        """
-        super().__init__()
-        self.listeners = []
-        self._create_methods()
-
-    def register_listener(self, listener: ModelSystemEventListener):
-        self.listeners.append(listener)
-
-    def load_listeners(self, listener_path: Path):
-        """Load all listeners from a given path.
-
-        Args:
-            listener_path (str): The path to the listeners.
-        """
-        for file_path in listener_path.glob("*.py"):
-            if file_path.name != "__init__.py":
-                module_name = file_path.stem
-                spec = importlib.util.spec_from_file_location(module_name, file_path)
-                module = importlib.util.module_from_spec(spec)
-                spec.loader.exec_module(module)
-                for attr_name in dir(module):
-                    attr = getattr(module, attr_name)
-                    if isinstance(attr, type) and issubclass(attr, ModelSystemEventListener) and attr is not ModelSystemEventListener:
-                        self.register_listener(attr())
-                        log.info(f"Loaded listener {attr.__name__} from {file_path}")
-
-
-    def _create_methods(self):
-        """Create methods that call all equivalent methods in all other ModelSystemEventListener classes.
-        Methods area automatically created for all methods that start with "on_" in all ModelSystemEventListener classes.
-        """
-        for method_name in dir(ModelSystemEventListener):
-            if method_name.startswith("on_") and callable(getattr(ModelSystemEventListener, method_name)):
-                setattr(self, method_name, self._create_method(method_name))
-                
-    def _create_method(self, method_name):
-        """Create a method that calls all equivalent methods in all other ModelSystemEventListener classes.
-
-        Args:
-            method_name (str): name of the method to create.
-        """
-        def method(*args, **kwargs):
-            for listener in self.listeners:
-                try:
-                    getattr(listener, method_name)(*args, **kwargs)
-                except Exception as e:
-                    if gettrace() is not None:
-                        # Re-raise exception if debugger is attached
-                        raise e
-                    log.error(f"Error in {listener.__class__.__name__}.{method_name}: {e}")
-        return method

Scripts/helmet.py

@@ -8,7 +8,7 @@
 import utils.log as log
 from assignment.emme_assignment import EmmeAssignmentModel
 from assignment.mock_assignment import MockAssignmentModel
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 from modelsystem import ModelSystem, AgentModelSystem
 from datahandling.matrixdata import MatrixData
 from utils.validation import Validation

Scripts/modelsystem.py

@@ -26,7 +26,7 @@
 from datatypes.tour import Tour
 from transform.impedance_transformer import ImpedanceTransformer
 from models.linear import CarDensityModel
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 import parameters.assignment as param
 import parameters.zone as zone_param
 import parameters.tour_generation as gen_param

Scripts/tests/emme_only/test_assignment.py

@@ -3,7 +3,7 @@
 
 import os
 import logging
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 import utils.log as log
 import numpy
 

Scripts/tests/integration/test_models.py

@@ -3,7 +3,7 @@
 import numpy
 
 from datahandling.zonedata import ZoneData
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 import utils.log as log
 from modelsystem import ModelSystem, AgentModelSystem
 from assignment.mock_assignment import MockAssignmentModel

Scripts/tests/unit/test_assignment.py

@@ -5,7 +5,7 @@
 import pandas
 import os
 
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 from utils.validate_network import validate
 from assignment.emme_bindings.mock_project import MockProject
 from assignment.emme_assignment import EmmeAssignmentModel

Scripts/transform/impedance_transformer.py

@@ -8,7 +8,7 @@
 
 if TYPE_CHECKING:
     from datatypes.purpose import Purpose
-from events.model_system_event_listener import EventHandler
+from events.event_handler import EventHandler
 import parameters.impedance_transformation as param
 from parameters.assignment import assignment_classes
 try: