Typing tests/helpers.py (#612)

* fix typing

* add cl

* lint

* Update CHANGELOG.rst

Author: patricktnast

CHANGELOG.rst

@@ -1,3 +1,7 @@
+**3.3.16 - 04/21/25**
+
+  - Type-hinting: Fix mypy errors in tests/helpers.py
+
 **3.3.15 - 04/14/25**
 
   - Type-hinting: Fix mypy errors in src/vivarium/interface/cli.py

pyproject.toml

@@ -44,7 +44,6 @@ exclude = [
     'tests/framework/test_event.py',
     'tests/framework/test_lifecycle.py',
     'tests/framework/test_values.py',
-    'tests/helpers.py',
     'tests/interface/test_utilities.py',
 ]
 

tests/helpers.py

@@ -1,9 +1,9 @@
-# mypy: ignore-errors
 from __future__ import annotations
 
 from typing import Any
 
 import pandas as pd
+from layered_config_tree import ConfigurationError
 
 from vivarium import Component, Observer
 from vivarium.framework.engine import Builder
@@ -22,7 +22,7 @@ def name(self) -> str:
     def configuration_defaults(self) -> dict[str, Any]:
         return {}
 
-    def __init__(self, *args, name: str = "mock_component_a") -> None:
+    def __init__(self, *args: Any, name: str = "mock_component_a") -> None:
         super().__init__()
         self._name = name
         self.args = args
@@ -43,14 +43,13 @@ class MockComponentB(Observer):
     def name(self) -> str:
         return self._name
 
-    def __init__(self, *args, name: str = "mock_component_b") -> None:
+    def __init__(self, *args: Any, name: str = "mock_component_b") -> None:
         super().__init__()
         self._name = name
         self.args = args
-        self.builder_used_for_setup = None
+        self.builder_used_for_setup: Builder | None = None
         if len(self.args) > 1:
-            for arg in self.args:
-                self._sub_components.append(MockComponentB(arg, name=arg))
+            self._sub_components = [MockComponentB(arg, name=arg) for arg in self.args]
 
     def setup(self, builder: Builder) -> None:
         self.builder_used_for_setup = builder
@@ -91,7 +90,7 @@ def configuration_defaults(self) -> dict[str, Any]:
     def __init__(self, name: str):
         super().__init__()
         self._name = name
-        self.builder_used_for_setup = None
+        self.builder_used_for_setup: Builder | None = None
 
     def setup(self, builder: Builder) -> None:
         self.builder_used_for_setup = builder
@@ -102,7 +101,7 @@ def __eq__(self, other: Any) -> bool:
 
 
 class Listener(MockComponentB):
-    def __init__(self, *args, name: str = "test_listener"):
+    def __init__(self, *args: Any, name: str = "test_listener"):
         super().__init__(*args, name=name)
         self.post_setup_called = False
         self.time_step_prepare_called = False
@@ -111,7 +110,7 @@ def __init__(self, *args, name: str = "test_listener"):
         self.collect_metrics_called = False
         self.simulation_end_called = False
 
-        self.event_indexes = {
+        self.event_indexes: dict[str, pd.Index[int] | None] = {
             "time_step_prepare": None,
             "time_step": None,
             "time_step_cleanup": None,
@@ -177,6 +176,10 @@ class LookupCreator(ColumnCreator):
 
     def build_all_lookup_tables(self, builder: "Builder") -> None:
         super().build_all_lookup_tables(builder)
+        if not self.configuration:
+            raise ConfigurationError(
+                "Configuration not set. This may break tests using the lookup table creator helper."
+            )
         self.lookup_tables["favorite_list"] = self.build_lookup_table(
             builder,
             self.configuration["alternate_data_sources"]["favorite_list"],
@@ -273,7 +276,7 @@ def columns_required(self) -> list[str]:
 
 class FilteredPopulationView(ColumnRequirer):
     @property
-    def population_view_query(self) -> str | None:
+    def population_view_query(self) -> str:
         return "test_column_1 == 5"