Rename ComponentGraph.components() parameters to be plural

Marenz · Marenz · commit 3d06478c7be1 · 2023-11-27T18:43:57.000+01:00
Signed-off-by: Mathias L. Baumann &lt;mathias.baumann@frequenz.com&gt;
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -44,6 +44,8 @@
     grid_current_recv = grid.current.new_receiver()
     ```
 
+- The `ComponentGraph.components()` parameters `component_id` and `component_category` were renamed to `component_ids` and `component_categories`, respectively.
+
 ## New Features
 
 <!-- Here goes the main new features and examples or instructions on how to use them -->
diff --git a/benchmarks/power_distribution/power_distributor.py b/benchmarks/power_distribution/power_distributor.py
@@ -141,7 +141,7 @@ async def run() -> None:
     )
 
     all_batteries: set[Component] = connection_manager.get().component_graph.components(
-        component_category={ComponentCategory.BATTERY}
+        component_categories={ComponentCategory.BATTERY}
     )
     batteries_ids = {c.component_id for c in all_batteries}
     # Take some time to get data from components
diff --git a/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py b/src/frequenz/sdk/actor/power_distributing/_component_managers/_battery_manager.py
@@ -128,7 +128,7 @@ def __init__(
     ):
         """Initialize the battery data manager."""
         self._batteries = connection_manager.get().component_graph.components(
-            component_category={ComponentCategory.BATTERY}
+            component_categories={ComponentCategory.BATTERY}
         )
         self._battery_ids = {battery.component_id for battery in self._batteries}
 
diff --git a/src/frequenz/sdk/microgrid/_data_pipeline.py b/src/frequenz/sdk/microgrid/_data_pipeline.py
@@ -271,7 +271,7 @@ def _start_power_managing_actor(self) -> None:
         # constraint needs to be relaxed if the actor is extended to support other
         # components.
         if not component_graph.components(
-            component_category={ComponentCategory.BATTERY}
+            component_categories={ComponentCategory.BATTERY}
         ):
             _logger.warning(
                 "No batteries found in the component graph. "
@@ -306,7 +306,7 @@ def _start_power_distributing_actor(self) -> None:
 
         component_graph = connection_manager.get().component_graph
         if not component_graph.components(
-            component_category={ComponentCategory.BATTERY}
+            component_categories={ComponentCategory.BATTERY}
         ):
             _logger.warning(
                 "No batteries found in the component graph. "
diff --git a/src/frequenz/sdk/microgrid/component_graph.py b/src/frequenz/sdk/microgrid/component_graph.py
@@ -45,19 +45,19 @@ class ComponentGraph(ABC):
     @abstractmethod
     def components(
         self,
-        component_id: set[int] | None = None,
-        component_category: set[ComponentCategory] | None = None,
+        component_ids: set[int] | None = None,
+        component_categories: set[ComponentCategory] | None = None,
     ) -> set[Component]:
         """Fetch the components of the microgrid.
 
         Args:
-            component_id: filter out any components not matching one of the provided IDs
-            component_category: filter out any components not matching one of the
+            component_ids: filter out any components not matching one of the provided IDs
+            component_categories: filter out any components not matching one of the
                 provided types
 
         Returns:
             Set of the components currently connected to the microgrid, filtered by
-                the provided `component_id` and `component_category` values.
+                the provided `component_ids` and `component_categories` values.
         """
 
     @abstractmethod
@@ -331,31 +331,31 @@ def __init__(
 
     def components(
         self,
-        component_id: set[int] | None = None,
-        component_category: set[ComponentCategory] | None = None,
+        component_ids: set[int] | None = None,
+        component_categories: set[ComponentCategory] | None = None,
     ) -> set[Component]:
         """Fetch the components of the microgrid.
 
         Args:
-            component_id: filter out any components not matching one of the provided IDs
-            component_category: filter out any components not matching one of the
+            component_ids: filter out any components not matching one of the provided IDs
+            component_categories: filter out any components not matching one of the
                 provided types
 
         Returns:
             Set of the components currently connected to the microgrid, filtered by
-                the provided `component_id` and `component_category` values.
+                the provided `component_ids` and `component_categories` values.
         """
-        if component_id is None:
+        if component_ids is None:
             # If any node has not node[1], then it will not pass validations step.
             selection: Iterable[Component] = map(
                 lambda node: Component(**(node[1])), self._graph.nodes(data=True)
             )
         else:
-            valid_ids = filter(self._graph.has_node, component_id)
+            valid_ids = filter(self._graph.has_node, component_ids)
             selection = map(lambda idx: Component(**self._graph.nodes[idx]), valid_ids)
 
-        if component_category is not None:
-            types: set[ComponentCategory] = component_category
+        if component_categories is not None:
+            types: set[ComponentCategory] = component_categories
             selection = filter(lambda c: c.category in types, selection)
 
         return set(selection)
@@ -832,7 +832,7 @@ def _validate_grid_endpoint(self) -> None:
                 it has no successors in the graph (i.e. it is not connected to
                 anything)
         """
-        grid = list(self.components(component_category={ComponentCategory.GRID}))
+        grid = list(self.components(component_categories={ComponentCategory.GRID}))
 
         if len(grid) == 0:
             # it's OK to not have a grid endpoint as long as other properties
@@ -865,7 +865,7 @@ def _validate_intermediary_components(self) -> None:
                 or zero successors
         """
         intermediary_components = list(
-            self.components(component_category={ComponentCategory.INVERTER})
+            self.components(component_categories={ComponentCategory.INVERTER})
         )
 
         missing_predecessors = list(
@@ -893,7 +893,7 @@ def _validate_leaf_components(self) -> None:
         """
         leaf_components = list(
             self.components(
-                component_category={
+                component_categories={
                     ComponentCategory.BATTERY,
                     ComponentCategory.EV_CHARGER,
                 }
diff --git a/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py b/src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py
@@ -126,7 +126,7 @@ def _get_all_batteries(self) -> frozenset[int]:
             {
                 battery.component_id
                 for battery in graph.components(
-                    component_category={ComponentCategory.BATTERY}
+                    component_categories={ComponentCategory.BATTERY}
                 )
             }
         )
diff --git a/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py b/src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py
@@ -111,7 +111,7 @@ def __init__(
             self._component_ids = {
                 evc.component_id
                 for evc in graph.components(
-                    component_category={ComponentCategory.EV_CHARGER}
+                    component_categories={ComponentCategory.EV_CHARGER}
                 )
             }
         self._state_tracker: StateTracker | None = None
diff --git a/src/frequenz/sdk/timeseries/ev_charger_pool/_set_current_bounds.py b/src/frequenz/sdk/timeseries/ev_charger_pool/_set_current_bounds.py
@@ -87,7 +87,7 @@ async def _run(self) -> None:
         """
         api_client = connection_manager.get().api_client
         graph = connection_manager.get().component_graph
-        meters = graph.components(component_category={ComponentCategory.METER})
+        meters = graph.components(component_categories={ComponentCategory.METER})
         if not meters:
             err = "No meters found in the component graph."
             _logger.error(err)
diff --git a/src/frequenz/sdk/timeseries/formula_engine/_formula_generators/_formula_generator.py b/src/frequenz/sdk/timeseries/formula_engine/_formula_generators/_formula_generator.py
@@ -107,7 +107,7 @@ def _get_grid_component(self) -> component.Component:
         grid_component = next(
             iter(
                 component_graph.components(
-                    component_category={component.ComponentCategory.GRID}
+                    component_categories={component.ComponentCategory.GRID}
                 )
             ),
             None,
diff --git a/src/frequenz/sdk/timeseries/grid.py b/src/frequenz/sdk/timeseries/grid.py
@@ -145,7 +145,7 @@ def initialize(
 
     grid_connections = list(
         connection_manager.get().component_graph.components(
-            component_category={ComponentCategory.GRID},
+            component_categories={ComponentCategory.GRID},
         )
     )
 
diff --git a/tests/actor/power_distributing/test_power_distributing.py b/tests/actor/power_distributing/test_power_distributing.py
@@ -114,7 +114,9 @@ async def init_component_data(
     ) -> None:
         """Send initial component data, for power distributor to start."""
         graph = microgrid.connection_manager.get().component_graph
-        for battery in graph.components(component_category={ComponentCategory.BATTERY}):
+        for battery in graph.components(
+            component_categories={ComponentCategory.BATTERY}
+        ):
             await mockgrid.mock_client.send(
                 battery_msg(
                     battery.component_id,
@@ -124,7 +126,7 @@ async def init_component_data(
                 )
             )
 
-        inverters = graph.components(component_category={ComponentCategory.INVERTER})
+        inverters = graph.components(component_categories={ComponentCategory.INVERTER})
         for inverter in inverters:
             await mockgrid.mock_client.send(
                 inverter_msg(
diff --git a/tests/actor/test_battery_pool_status.py b/tests/actor/test_battery_pool_status.py
@@ -39,7 +39,7 @@ async def test_batteries_status(self, mocker: MockerFixture) -> None:
         batteries = {
             battery.component_id
             for battery in mock_microgrid.mock_client.component_graph.components(
-                component_category={ComponentCategory.BATTERY}
+                component_categories={ComponentCategory.BATTERY}
             )
         }
         battery_status_channel = Broadcast[ComponentPoolStatus]("battery_status")
diff --git a/tests/microgrid/test_graph.py b/tests/microgrid/test_graph.py
@@ -214,8 +214,8 @@ def test_filter_graph_components_by_id(
         """Test the graph component query with component ID filter."""
         # with component_id filter specified, we get back only components whose ID
         # matches one of the specified values
-        assert len(sample_graph.components(component_id=ids)) == len(expected)
-        assert sample_graph.components(component_id=ids) == expected
+        assert len(sample_graph.components(component_ids=ids)) == len(expected)
+        assert sample_graph.components(component_ids=ids) == expected
 
     @pytest.mark.parametrize(
         "types, expected",
@@ -265,8 +265,8 @@ def test_filter_graph_components_by_type(
         """Test the graph component query with component category filter."""
         # with component_id filter specified, we get back only components whose ID
         # matches one of the specified values
-        assert len(sample_graph.components(component_category=types)) == len(expected)
-        assert sample_graph.components(component_category=types) == expected
+        assert len(sample_graph.components(component_categories=types)) == len(expected)
+        assert sample_graph.components(component_categories=types) == expected
 
     @pytest.mark.parametrize(
         "ids, types, expected",
@@ -300,10 +300,10 @@ def test_filter_graph_components_with_composite_filter(
         # the component must have one of the specified IDs and be of one of
         # the specified types
         assert len(
-            sample_graph.components(component_id=ids, component_category=types)
+            sample_graph.components(component_ids=ids, component_categories=types)
         ) == len(expected)
         assert (
-            set(sample_graph.components(component_id=ids, component_category=types))
+            set(sample_graph.components(component_ids=ids, component_categories=types))
             == expected
         )
 
diff --git a/tests/timeseries/_battery_pool/test_battery_pool.py b/tests/timeseries/_battery_pool/test_battery_pool.py
@@ -82,7 +82,7 @@ def get_components(
     return {
         component.component_id
         for component in mock_microgrid.component_graph.components(
-            component_category={component_category}
+            component_categories={component_category}
         )
     }
 
diff --git a/tests/timeseries/mock_microgrid.py b/tests/timeseries/mock_microgrid.py
@@ -111,7 +111,7 @@ def filter_comp(category: ComponentCategory) -> list[int]:
             return list(
                 map(
                     lambda c: c.component_id,
-                    graph.components(component_category={category}),
+                    graph.components(component_categories={category}),
                 )
             )
 
@@ -122,7 +122,7 @@ def inverters(comp_type: InverterType) -> list[int]:
             return [
                 c.component_id
                 for c in graph.components(
-                    component_category={ComponentCategory.INVERTER}
+                    component_categories={ComponentCategory.INVERTER}
                 )
                 if c.type == comp_type
             ]
@@ -142,7 +142,7 @@ def inverters(comp_type: InverterType) -> list[int]:
                 # Hacky, ignores multiple batteries behind one inverter
                 list(graph.successors(c.component_id))[0].component_id: c.component_id
                 for c in graph.components(
-                    component_category={ComponentCategory.INVERTER}
+                    component_categories={ComponentCategory.INVERTER}
                 )
                 if c.type == InverterType.BATTERY
             }
diff --git a/tests/utils/graph_generator.py b/tests/utils/graph_generator.py
@@ -281,15 +281,17 @@ def test_graph_generator_simple() -> None:
         )
     )
 
-    meters = list(graph.components(component_category={ComponentCategory.METER}))
+    meters = list(graph.components(component_categories={ComponentCategory.METER}))
     meters.sort(key=lambda x: x.component_id)
     assert len(meters) == 4
     assert len(graph.successors(meters[0].component_id)) == 4
     assert graph.predecessors(meters[1].component_id) == {meters[0]}
     assert graph.predecessors(meters[2].component_id) == {meters[0]}
     assert graph.predecessors(meters[3].component_id) == {meters[0]}
 
-    inverters = list(graph.components(component_category={ComponentCategory.INVERTER}))
+    inverters = list(
+        graph.components(component_categories={ComponentCategory.INVERTER})
+    )
     inverters.sort(key=lambda x: x.component_id)
     assert len(inverters) == 3
 
@@ -302,8 +304,10 @@ def test_graph_generator_simple() -> None:
     assert len(graph.successors(inverters[2].component_id)) == 1
     assert inverters[2].type == InverterType.BATTERY
 
-    assert len(graph.components(component_category={ComponentCategory.BATTERY})) == 2
-    assert len(graph.components(component_category={ComponentCategory.EV_CHARGER})) == 1
+    assert len(graph.components(component_categories={ComponentCategory.BATTERY})) == 2
+    assert (
+        len(graph.components(component_categories={ComponentCategory.EV_CHARGER})) == 1
+    )
 
     graph.validate()
 
@@ -327,16 +331,18 @@ def test_graph_generator_no_grid_meter() -> None:
         ]
     )
 
-    meters = list(graph.components(component_category={ComponentCategory.METER}))
+    meters = list(graph.components(component_categories={ComponentCategory.METER}))
     assert len(meters) == 1
     assert len(graph.successors(meters[0].component_id)) == 1
 
-    inverters = list(graph.components(component_category={ComponentCategory.INVERTER}))
+    inverters = list(
+        graph.components(component_categories={ComponentCategory.INVERTER})
+    )
     assert len(inverters) == 2
 
     assert len(graph.successors(inverters[0].component_id)) == 1
     assert len(graph.successors(inverters[1].component_id)) == 1
 
-    assert len(graph.components(component_category={ComponentCategory.BATTERY})) == 2
+    assert len(graph.components(component_categories={ComponentCategory.BATTERY})) == 2
 
     graph.validate()
diff --git a/tests/utils/mock_microgrid_client.py b/tests/utils/mock_microgrid_client.py
@@ -172,7 +172,7 @@ def _create_battery_channels(self) -> dict[int, Broadcast[BatteryData]]:
         batteries = [
             c.component_id
             for c in self.component_graph.components(
-                component_category={ComponentCategory.BATTERY}
+                component_categories={ComponentCategory.BATTERY}
             )
         ]
 
@@ -190,7 +190,7 @@ def _create_meter_channels(self) -> dict[int, Broadcast[MeterData]]:
         meters = [
             c.component_id
             for c in self.component_graph.components(
-                component_category={ComponentCategory.METER}
+                component_categories={ComponentCategory.METER}
             )
         ]
 
@@ -206,7 +206,7 @@ def _create_inverter_channels(self) -> dict[int, Broadcast[InverterData]]:
         inverters = [
             c.component_id
             for c in self.component_graph.components(
-                component_category={ComponentCategory.INVERTER}
+                component_categories={ComponentCategory.INVERTER}
             )
         ]
 
@@ -225,7 +225,7 @@ def _create_ev_charger_channels(self) -> dict[int, Broadcast[EVChargerData]]:
         meters = [
             c.component_id
             for c in self.component_graph.components(
-                component_category={ComponentCategory.EV_CHARGER}
+                component_categories={ComponentCategory.EV_CHARGER}
             )
         ]
 

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ async def run() -> None:`
`141`	`141`	`)`
`142`	`142`
`143`	`143`	`all_batteries: set[Component] = connection_manager.get().component_graph.components(`
`144`		`- component_category={ComponentCategory.BATTERY}`
	`144`	`+ component_categories={ComponentCategory.BATTERY}`
`145`	`145`	`)`
`146`	`146`	`batteries_ids = {c.component_id for c in all_batteries}`
`147`	`147`	`# Take some time to get data from components`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ def __init__(`
`128`	`128`	`):`
`129`	`129`	`"""Initialize the battery data manager."""`
`130`	`130`	`self._batteries = connection_manager.get().component_graph.components(`
`131`		`- component_category={ComponentCategory.BATTERY}`
	`131`	`+ component_categories={ComponentCategory.BATTERY}`
`132`	`132`	`)`
`133`	`133`	`self._battery_ids = {battery.component_id for battery in self._batteries}`
`134`	`134`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ def _get_all_batteries(self) -> frozenset[int]:`
`126`	`126`	`{`
`127`	`127`	`battery.component_id`
`128`	`128`	`for battery in graph.components(`
`129`		`- component_category={ComponentCategory.BATTERY}`
	`129`	`+ component_categories={ComponentCategory.BATTERY}`
`130`	`130`	`)`
`131`	`131`	`}`
`132`	`132`	`)`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ def __init__(`
`111`	`111`	`self._component_ids = {`
`112`	`112`	`evc.component_id`
`113`	`113`	`for evc in graph.components(`
`114`		`- component_category={ComponentCategory.EV_CHARGER}`
	`114`	`+ component_categories={ComponentCategory.EV_CHARGER}`
`115`	`115`	`)`
`116`	`116`	`}`
`117`	`117`	`self._state_tracker: StateTracker \| None = None`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ def _get_grid_component(self) -> component.Component:`
`107`	`107`	`grid_component = next(`
`108`	`108`	`iter(`
`109`	`109`	`component_graph.components(`
`110`		`- component_category={component.ComponentCategory.GRID}`
	`110`	`+ component_categories={component.ComponentCategory.GRID}`
`111`	`111`	`)`
`112`	`112`	`),`
`113`	`113`	`None,`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ def initialize(`
`145`	`145`
`146`	`146`	`grid_connections = list(`
`147`	`147`	`connection_manager.get().component_graph.components(`
`148`		`- component_category={ComponentCategory.GRID},`
	`148`	`+ component_categories={ComponentCategory.GRID},`
`149`	`149`	`)`
`150`	`150`	`)`
`151`	`151`