Add partial visitation

Author: FreeYourSoul

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelogs
 
+## Version 1.1.0
+(Released : April 16, 2021) : tag 1.1.0
+* Fix documentation
+* Add utility method at node level (get_predecessors/get_successors)
+* Add possibility to visitation of the graph from anywhere (starting provided node) as it would have been expected seeing the API
+
 ## Version 1.0.0 
 (Released : April 2, 2021) : tag 1.0.0
 * Complete documentation
@@ -29,6 +35,7 @@
 ## Feature todo
 
 * ~~Delete node~~ 
+* ~~Partial graph traversal~~
 
 ## Testing todo
 

freexgraph/__init__.py

@@ -32,6 +32,6 @@
 
 
 def version() -> str:
+    """Retrieve used version of FreExGraph library"""
     from freexgraph._version import __version__
-
     return __version__

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.0.0"
+__version__ = "1.1.0"

freexgraph/visitor.py

@@ -35,6 +35,22 @@ def _get_len(sorted_node_list: List[Tuple], with_progress_bar: bool) -> int:
     return len([n for n in sorted_node_list])
 
 
+def _filter_graph_root_for_visitation(root: FreExNode, is_reversed: bool):
+    depth: int = root.depth
+    sorted_node_list = list(nx.lexicographical_topological_sort(root.graph_ref))
+    if is_reversed:
+        sorted_node_list = list(reversed(sorted_node_list))
+
+    if depth == 0:
+        return sorted_node_list
+    node_content = [
+        root.graph_ref.nodes[node_id]["content"] for node_id in sorted_node_list
+    ]
+    if is_reversed:
+        return [n.id for n in node_content if n.depth <= depth and n.id != root.id]
+    return [n.id for n in node_content if n.depth >= depth and n.id != root.id]
+
+
 class AbstractVisitor:
     """Base class for Visitor.
 
@@ -74,10 +90,7 @@ def visit(self, root: FreExNode) -> bool:
     def apply_visitation_(self, root: FreExNode) -> bool:
         """do not override / directly use. Internal visitation method, use visit(root) instead"""
 
-        sorted_node_list = list(nx.lexicographical_topological_sort(root.graph_ref))
-
-        if self.is_reversed:
-            sorted_node_list = list(reversed(sorted_node_list))
+        sorted_node_list = _filter_graph_root_for_visitation(root, self.is_reversed)
 
         with tqdm(
             total=_get_len(sorted_node_list, self.with_progress_bar),
@@ -185,10 +198,7 @@ def visit(self, root: FreExNode) -> bool:
         return to_continue
 
     def _composed_visit(self, root: FreExNode) -> bool:
-        sorted_node_list = list(nx.lexicographical_topological_sort(root.graph_ref))
-
-        if self._is_reversed:
-            sorted_node_list = list(reversed(sorted_node_list))
+        sorted_node_list = _filter_graph_root_for_visitation(root, self._is_reversed)
 
         with tqdm(
             total=_get_len(sorted_node_list, self._with_progress_bar),

recipe.nix

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

test/basic_freexgraph_test.py

@@ -26,6 +26,7 @@
 
 from typing import Optional
 
+from freexgraph.standard_visitor import FindFirstVisitor
 from freexgraph import GraphNode, FreExNode, FreExGraph
 
 
@@ -348,7 +349,6 @@ def test_delete_node_with_childs(visitor_test):
 
 
 def test_predecessors_successors(valid_basic_execution_graph):
-    from freexgraph.standard_visitor import FindFirstVisitor
     v = FindFirstVisitor(lambda node: node.id.startswith("id3"))
     v.visit(valid_basic_execution_graph.root)
 
@@ -367,3 +367,28 @@ def test_predecessors_successors(valid_basic_execution_graph):
     assert node_predecessors[0].id.startswith("id5")
 
 
+def test_middle_visitation_start(valid_complex_graph):
+    v = FindFirstVisitor(lambda node: node.id == "F")
+    v.visit(valid_complex_graph.root)
+
+    f_node = v.result
+    assert v.found()
+    assert f_node.id == "F"
+
+    # G and F are at the same level and thus are always executed on partial visitation
+    find_g = FindFirstVisitor(lambda node: node.id == "G")
+
+    # start visitation from F node [A, B, C, D, E] should not be visited
+    v = FindFirstVisitor(lambda node: node.id in ["A", "B", "C", "D", "E"])
+    v.visit(f_node)
+    assert not v.found()
+    find_g.visit(f_node)
+    assert find_g.found()
+
+    # start reverse visitation node [H, I, J, K, L, M] should not be visited
+    v = FindFirstVisitor(lambda node: node.id in ["H", "I", "J", "K", "L", "M"])
+    v.is_reversed = True
+    v.visit(f_node)
+    assert not v.found()
+    find_g.visit(f_node)
+    assert find_g.found()