Add grid.rebuild_graphs() (#177)

* Add grid.rebuild_graphs()

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* Update test

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* remove internal .from_arrays usage

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* fix tests

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* ._from_grid -> .from_grid

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* update docstrings

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

* format

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

---------

Signed-off-by: Thijs Baaijen <13253091+Thijss@users.noreply.github.com>

Author: Thijss

src/power_grid_model_ds/_core/model/graphs/container.py

@@ -5,6 +5,7 @@
 """Stores the GraphContainer class"""
 
 import dataclasses
+import warnings
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Generator
 
@@ -36,7 +37,7 @@ def __repr__(self) -> str:
         return f"{self.__class__.__name__}({', '.join(graph_infos)})"
 
     @property
-    def graph_attributes(self) -> Generator:
+    def graph_attributes(self) -> Generator[dataclasses.Field, None, None]:
         """Get all graph attributes of the container.
 
         Yield:
@@ -119,13 +120,24 @@ def make_inactive(self, branch: BranchArray) -> None:
 
     @classmethod
     def from_arrays(cls, arrays: "Grid") -> "GraphContainer":
-        """Build from arrays"""
-        cls._validate_branches(arrays=arrays)
+        """Build from arrays. DEPRECATED: Use .from_grid instead."""
+        warnings.warn(
+            f"{cls.__name__}.from_arrays is deprecated and will be removed in a future release. "
+            f"Use grid.rebuild_graphs() or {cls.__name__}.from_grid(grid) instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return cls.from_grid(arrays)
+
+    @classmethod
+    def from_grid(cls, grid: "Grid") -> "GraphContainer":
+        """Build from grid"""
+        cls._validate_branches(arrays=grid)
 
         new_container = cls.empty()
         for graph_field in new_container.graph_attributes:
-            graph = getattr(new_container, graph_field.name)
-            new_graph = graph.from_arrays(arrays, active_only=graph.active_only)
+            graph: BaseGraphModel = getattr(new_container, graph_field.name)
+            new_graph = graph.from_grid(grid, active_only=graph.active_only)
             setattr(new_container, graph_field.name, new_graph)
 
         return new_container

src/power_grid_model_ds/_core/model/graphs/models/base.py

@@ -1,7 +1,7 @@
 # SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
 #
 # SPDX-License-Identifier: MPL-2.0
-
+import warnings
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
 from typing import TYPE_CHECKING, Counter, Generator
@@ -348,13 +348,22 @@ def find_fundamental_cycles(self) -> list[list[int]]:
 
     @classmethod
     def from_arrays(cls, arrays: "Grid", active_only=False) -> "BaseGraphModel":
-        """Build from arrays"""
-        new_graph = cls(active_only=active_only)
-
-        new_graph.add_node_array(node_array=arrays.node, raise_on_fail=False)
-        new_graph.add_branch_array(arrays.branches)
-        new_graph.add_branch3_array(arrays.three_winding_transformer)
+        """Build from arrays. DEPRECATED: Use .from_grid instead."""
+        warnings.warn(
+            f"{cls.__name__}.from_arrays is deprecated and will be removed in a future release. "
+            f"Use {cls.__name__}.from_grid instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return cls.from_grid(arrays, active_only=active_only)
 
+    @classmethod
+    def from_grid(cls, grid: "Grid", active_only=False) -> "BaseGraphModel":
+        """Build from grid."""
+        new_graph = cls(active_only=active_only)
+        new_graph.add_node_array(node_array=grid.node, raise_on_fail=False)
+        new_graph.add_branch_array(grid.branches)
+        new_graph.add_branch3_array(grid.three_winding_transformer)
         return new_graph
 
     def _internals_to_externals(self, internal_nodes: list[int]) -> list[int]:

src/power_grid_model_ds/_core/model/grids/base.py

@@ -461,6 +461,10 @@ def deserialize(cls: Type[Self], path: Path) -> Self:
         """Deserialize the grid."""
         return deserialize_from_json(path=path, target_grid_class=cls)
 
+    def rebuild_graphs(self) -> None:
+        """(Re)build the graphs in the grid."""
+        self.graphs = GraphContainer.from_grid(self)
+
     def diff(self, other_grid: Self) -> None:
         """Print the differences between two grids
 

src/power_grid_model_ds/_core/model/grids/serialization/json.py

@@ -76,8 +76,7 @@ def deserialize_from_json(path: Path, target_grid_class: type[G]) -> G:
 
     grid = target_grid_class.empty()
     _restore_grid_values(grid, json_data["data"])
-    graph_class = grid.graphs.__class__
-    grid.graphs = graph_class.from_arrays(grid)
+    grid.rebuild_graphs()
     return grid
 
 

src/power_grid_model_ds/_core/model/grids/serialization/pickle.py

@@ -6,7 +6,6 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from power_grid_model_ds._core.model.graphs.container import GraphContainer
 from power_grid_model_ds._core.utils.pickle import get_pickle_path, load_from_pickle, save_to_pickle
 from power_grid_model_ds._core.utils.zip import file2gzip
 
@@ -22,7 +21,7 @@ def load_grid_from_pickle(grid_class: type["Grid"], cache_path: Path, load_graph
         raise TypeError(f"{pickle_path.name} is not a valid {grid_class.__name__} cache.")
 
     if load_graphs:
-        grid.graphs = GraphContainer.from_arrays(grid)
+        grid.rebuild_graphs()
     return grid
 
 

tests/performance/graph_performance_tests.py

@@ -33,8 +33,8 @@ def perftest_delete_node():
     do_performance_test(code_to_test, GRAPH_SIZES, 100, setup_codes=GRAPH_SETUP_CODES)
 
 
-def perftest_from_arrays():
-    code_to_test = "grid.graphs.complete_graph.__class__.from_arrays(grid);"
+def perftest_rebuild_graphs():
+    code_to_test = "grid.rebuild_graphs()"
     do_performance_test(code_to_test, GRAPH_SIZES, 100, setup_codes=GRAPH_SETUP_CODES)
 
 
@@ -53,4 +53,4 @@ def perftest_add_node():
     perftest_get_components()
     perftest_delete_node()
     perftest_add_node()
-    perftest_from_arrays()
+    perftest_rebuild_graphs()

tests/unit/model/graphs/test_container.py

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
 #
 # SPDX-License-Identifier: MPL-2.0
+from copy import deepcopy
 
 import pytest
 
@@ -12,18 +13,13 @@
 # pylint: disable=missing-function-docstring
 
 
-def test_from_arrays(basic_grid: Grid):
-    graphs = GraphContainer.from_arrays(basic_grid)
+def test_rebuild_graphs(basic_grid: Grid):
+    orig_graphs = deepcopy(basic_grid.graphs)
 
-    assert isinstance(graphs, GraphContainer)
-    assert basic_grid.graphs.complete_graph.nr_nodes == graphs.complete_graph.nr_nodes
-    assert basic_grid.graphs.complete_graph.nr_branches == 6
-
-    assert basic_grid.graphs.active_graph.nr_nodes == graphs.active_graph.nr_nodes
-    assert basic_grid.graphs.active_graph.nr_branches == 5
-
-    assert set(basic_grid.node.id) == set(graphs.active_graph.external_ids)
-    assert set(basic_grid.node.id) == set(graphs.complete_graph.external_ids)
+    basic_grid.graphs = GraphContainer.empty()
+    assert basic_grid.graphs != orig_graphs
+    basic_grid.rebuild_graphs()
+    assert orig_graphs == basic_grid.graphs
 
 
 @pytest.fixture
@@ -81,7 +77,7 @@ def test_delete_branch3(
         assert not graph_container_with_5_nodes.complete_graph.has_branch(from_node, to_node)
 
 
-def test_from_arrays_active_three_winding(basic_grid: Grid):
+def test_rebuild_graphs_active_three_winding(basic_grid: Grid):
     nodes = NodeArray.zeros(3)
     nodes.id = [1000, 1001, 1002]
     basic_grid.append(nodes)
@@ -95,15 +91,16 @@ def test_from_arrays_active_three_winding(basic_grid: Grid):
     three_winding_transformer.status_3 = 1
     basic_grid.append(three_winding_transformer)
 
-    graphs = GraphContainer.from_arrays(basic_grid)
+    basic_grid.rebuild_graphs()
+    graphs = basic_grid.graphs
     assert basic_grid.graphs.complete_graph.nr_nodes == graphs.complete_graph.nr_nodes
     assert basic_grid.graphs.complete_graph.nr_branches == 6 + 3
 
     assert basic_grid.graphs.active_graph.nr_nodes == graphs.active_graph.nr_nodes
     assert basic_grid.graphs.active_graph.nr_branches == 5 + 3
 
 
-def test_from_arrays_partially_active_three_winding(basic_grid: Grid):
+def test_rebuild_graphs_partially_active_three_winding(basic_grid: Grid):
     nodes = NodeArray.zeros(3)
     nodes.id = [1000, 1001, 1002]
     basic_grid.append(nodes)
@@ -117,7 +114,8 @@ def test_from_arrays_partially_active_three_winding(basic_grid: Grid):
     three_winding_transformer.status_3 = 0
     basic_grid.append(three_winding_transformer)
 
-    graphs = GraphContainer.from_arrays(basic_grid)
+    basic_grid.rebuild_graphs()
+    graphs = basic_grid.graphs
     assert basic_grid.graphs.complete_graph.nr_nodes == graphs.complete_graph.nr_nodes
     assert basic_grid.graphs.complete_graph.nr_branches == 6 + 3
 
@@ -132,8 +130,8 @@ def test_from_arrays_partially_active_three_winding(basic_grid: Grid):
     assert not basic_grid.graphs.active_graph.has_branch(1001, 1002)
 
 
-def test_from_arrays_invalid_arrays(basic_grid: Grid):
+def test_rebuild_graphs_invalid_arrays(basic_grid: Grid):
     basic_grid.node = basic_grid.node.exclude(id=106)
 
     with pytest.raises(RecordDoesNotExist):
-        GraphContainer.from_arrays(basic_grid)
+        basic_grid.rebuild_graphs()

tests/unit/model/graphs/test_graph_model.py

@@ -9,11 +9,9 @@
 
 import numpy as np
 import pytest
-from numpy.testing import assert_array_equal
 
 from power_grid_model_ds._core.model.graphs.errors import GraphError
 from power_grid_model_ds._core.model.graphs.models.base import BaseGraphModel
-from power_grid_model_ds._core.model.grids.base import Grid
 from power_grid_model_ds.errors import MissingBranchError, MissingNodeError, NoPathBetweenNodes
 
 # pylint: disable=missing-function-docstring,missing-class-docstring
@@ -208,11 +206,6 @@ def test_get_components_with_tmp_removed_substation_nodes(graph_with_2_routes):
     assert set(components[2]) == {99}
 
 
-def test_from_arrays(basic_grid: Grid):
-    new_graph = basic_grid.graphs.complete_graph.__class__.from_arrays(basic_grid)
-    assert_array_equal(new_graph.external_ids, basic_grid.node.id)
-
-
 class TestPathMethods:
     def test_get_shortest_path(self, graph_with_2_routes: BaseGraphModel):
         graph = graph_with_2_routes