Add subgraph and fix GraphNode uid mandatory

Author: FreeYourSoul

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelogs
 
+## Version 1.2.0
+(Not released yet)
+* Add sub_graph
+* Fix bug (forced to set an id on GraphNode constructor)
+
 ## Version 1.1.0
 (Released : April 16, 2021) : tag 1.1.0
 * Fix documentation
@@ -25,19 +30,23 @@
 
 ## TODO list for FreExGraph (next versions)
 
+## Feature todo
+
+* Implement sub_graph
+* ~~fix graph node enforcement of uid~~
+* ~~Delete node~~ 
+* ~~Partial graph traversal~~
+
 ## Documentation todo
 
 * ~~Add doc about node / graph creation~~
 * ~~Add documentation about graph nodes~~
 * ~~Add documentation about custom hook~~
 * ~~Add documentation Composed Visitor~~
-
-## Feature todo
-
-* ~~Delete node~~ 
-* ~~Partial graph traversal~~
+* Add documentation on sub_graph
 
 ## Testing todo
 
+* Test sub_graph
 * ~~Test Composed Visitor~~
 * ~~Custom hook~~

freexgraph/_version.py

@@ -21,4 +21,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = "1.1.0"
+__version__ = "1.2.0"

freexgraph/freexgraph.py

@@ -123,7 +123,9 @@ class GraphNode(FreExNode):
 
     _graph_ex: "FreExGraph"
 
-    def __init__(self, uid: str, *, graph: "FreExGraph", parents: Set[str] = None):
+    def __init__(
+        self, uid: str = None, *, graph: "FreExGraph", parents: Set[str] = None
+    ):
         super().__init__(uid=uid, parents=parents, graph_ref=graph._graph)
         self._graph_ex = graph
 
@@ -278,6 +280,46 @@ def get_node(self, node_id: str) -> Optional[AnyFreExNode]:
             return None
         return self._graph.nodes[node_id]["content"]
 
+    def sub_graph(
+        self, from_node_id: str, to_nodes_id: Optional[List[str]] = None
+    ) -> "FreExGraph":
+        """Utility method to retrieve a subgraph from a given node until the end of the graph or until one of the
+        provided node is encountered.
+
+        :param from_node_id: node from which the sub graph start
+        :param to_nodes_id: nodes on which the sub graph stop, if none encountered, subgraph go until the leaf nodes
+        :return: a sub graph delimited by the provided nodes id
+        """
+        from_node: FreExNode = self.get_node(from_node_id)
+        assert (
+            from_node is not None
+        ), f"Error sub graph from node {from_node_id}, node has to be in the execution graph"
+
+        nodes_in_subgraph: List[FreExNode] = []
+        nodes_in_subgraph_id: List[str] = []
+
+        def add_node_in_subgraph(current_node: FreExNode):
+            current_node.parents = {
+                p for p in current_node.parents if p in nodes_in_subgraph_id
+            }
+            nodes_in_subgraph.append(current_node)
+            if to_nodes_id is not None and current_node in to_nodes_id:
+                return
+            all_suc = list(self._graph.successors(current_node.id))
+            for successor in all_suc:
+                n = self.get_node(successor)
+                assert (
+                    n is not None
+                ), f"Error sub graph to node {n.id}, node has to be in the execution graph"
+                add_node_in_subgraph(n)
+                nodes_in_subgraph_id.append(n.id)
+
+        add_node_in_subgraph(from_node)
+
+        sub_graph = FreExGraph()
+        sub_graph.add_nodes(nodes_in_subgraph)
+        return sub_graph
+
     def fork_from_node(
         self, forked_node: FreExNode, *, join_id: Optional[str] = None
     ) -> None:

recipe.nix

@@ -3,7 +3,7 @@
 
 python38.pkgs.buildPythonPackage rec {
   pname = "freexgraph";
-  version = "1.1.0";
+  version = "1.2.0";
 
   src = if (builtins.isNull use_revision || use_revision == "") then
     nix-gitignore.gitignoreSource [ ".git" ] ./.

test/sub_graph_test.py

@@ -0,0 +1,80 @@
+# MIT License
+#
+# Copyright (c) 2021 Quentin Balland
+# Project : https://github.com/FreeYourSoul/FreExGraph
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import pytest
+
+from freexgraph import GraphNode, FreExNode, FreExGraph
+
+# Graph used in thoses tests are from valid_complex_graph fixture
+#
+#
+#            A                      B
+#         /     \                 /  |
+#        C       D              E    |
+#                 \              \   |
+#                  F .______,    G   |
+#               /  |  \     \   /    |
+#             H    I   J     `,K.    |
+#                     /,_____/   \   |
+#                    L             M
+#
+
+
+def test_sub_graph_without_to_node(valid_complex_graph, visitor_test):
+    # From F to end
+    #
+    #                  F .______,
+    #               /  |  \     \
+    #             H    I   J     `,K.
+    #                     /,_____/   \
+    #                    L             M
+
+    sub_graph: FreExGraph = valid_complex_graph.sub_graph(from_node_id="F")
+
+    visitor_test.visit(valid_complex_graph)
+    visitor_test.visit(sub_graph.root)
+    assert len(visitor_test.visited) == 7
+
+
+def test_sub_graph_of_one_element(valid_complex_graph):
+    ...
+
+
+def test_sub_graph_with_to_node_not_found(valid_complex_graph):
+    ...
+
+
+def test_sub_graph_with_to_node(valid_complex_graph):
+    ...
+
+
+def test_sub_graph_with_to_node_partial(valid_complex_graph):
+    ...
+
+
+def test_sub_graph_error_on_from_node(valid_complex_graph):
+    ...
+
+
+def test_sub_graph_error_on_to_node(valid_complex_graph):
+    ...