Add test on compose visitor

Author: FreeYourSoul

CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelogs
+
+
+## Version 1.0.0
+* First implementation: 
+    * Execution graph implementation
+    * Visitor implementation
+    * Composed visitor implementation
+    * Documentation
+    
+
+---
+
+## TODO list for FreExGraph (next versions)
+
+## Documentation todo
+
+* Add doc about node / graph creation
+* Add documentation about graph nodes
+* Add documentation about custom hook
+
+## Feature todo
+
+* Delete node 
+
+## Testing todo
+
+* ~~Test Composed Visitor~~
+* Custom hook

README.md

@@ -130,7 +130,7 @@ It is possible to embed a graph into another thanks to a graph node. Any visitat
 
 ### Fork
 
-FreExGraph provide a fork mechanism. It provides an easy way to duplicate a graph from a given node until the end of the graph (or to a specific node that would be used as a join: useful to implement).
+FreExGraph provide a fork mechanism. It provides an easy way to duplicate a graph from a given node until the end of the graph (or to a specific node that would be used as a join).
 
 Here is an example:   
 _Given the following graph in `execution_graph`:_
@@ -179,11 +179,11 @@ Join is do-able by adding the
 ### Abstract Visitor hooks
 
 Abstract visitor provide some default hooks that can be overridden from custom visitors in order to implement more complex logic depending on the graph visit.
-* `hook_start()` : This hook is called when the visitation of the graph start
-* `hook_end()` : This hook is called when the visitation of the graph end
-* `hook_fork_started(n: FreExNode, fork_id: str)` : This hook is called when a fork has been entered (when visiting the first node of a fork)
-* `hook_start_graph_node(gn: GraphNode)` : This hook is called when a graphnode recursion start (graph node given as parameter of the hook)
-* `hook_end_graph_node(gn: GraphNode)` : This hook is called when a graphnode visitation end (graph node given as parameter of the hook)
+* `hook_start()` : This hook is called when the visitation of the graph start (an interesting way to use this hook could be to reinitialize your visitor in case of re-use).
+* `hook_end()` : This hook is called when the visitation of the graph end.
+* `hook_fork_started(n: FreExNode, fork_id: str)` : This hook is called when a fork has been entered (when visiting the first node of a fork).
+* `hook_start_graph_node(gn: GraphNode)` : This hook is called when a graphnode recursion start (graph node given as parameter of the hook).
+* `hook_end_graph_node(gn: GraphNode)` : This hook is called when a graphnode visitation end (graph node given as parameter of the hook).
 
 Custom hooks can be implemented if you must trigger a specific action that depend on the business data stored in your node.   
 To do so, in the `__init__` of your custom visitor, use the method `register_custom_hook(predicate: Callable, hook: Callable)` : This method will trigger the provided hook if the given predicate return true for a node.   
@@ -243,6 +243,25 @@ v = ValidateGraphIntegrity()
 # visitation does assertion to verify if the graph is correct
 v.visit(graph_above.root())
 ```
+Those visitor implement the start hook that reinitialize their state as if they were new freshly created visitor. Which is why an instance of a standard visitor can be re-used. To implement this kind of behaviour in your own visitors, check out [visitor hooks](#abstract-visitor-hooks).
+
+### Reverse visit
+It is possible to revert the order of visitation of your visitor by setting its attribute `is_reversed` of your visitor (works with any kind of visitor), example :
+```python
+# we assume a graph called `execution_graph` that represent the following graph:
+# id_1 ---> id_2 ---> id_3 ---> id4 ---> id3bis ---> id5
+
+v = FindFirstVisitor(lambda node: node.id.startswith("id3"))
+
+v.visit(execution_graph.root)
+assert v.found()
+assert v.result.id == "id3"
+
+v.is_reversed = True
+v.visit(execution_graph.root)
+assert v.found()
+assert v.result.id == "id3bis"
+```
 
 ## Installation
 

freexgraph/__init__.py

@@ -25,7 +25,9 @@
 Module to manipulate an execution graph
 """
 
+from freexgraph._version import __version__
+
 from freexgraph.freexgraph import FreExGraph, FreExNode, AnyVisitor
-from freexgraph.visitor import AbstractVisitor
+from freexgraph.visitor import AbstractVisitor, VisitorComposer
 
 import freexgraph.standard_visitor

freexgraph/_version.py

@@ -0,0 +1,24 @@
+# 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.
+
+__version__ = "0.1.0"

freexgraph/visitor.py

@@ -28,7 +28,7 @@
 
 from tqdm import tqdm
 
-from freexgraph.freexgraph import FreExNode, GraphNode
+from freexgraph.freexgraph import FreExNode, GraphNode, AnyVisitor
 
 
 @contextmanager
@@ -168,18 +168,18 @@ def register_custom_hook(self, predicate: Callable, hook: Callable):
 class VisitorComposer:
     """Class to compose visitor together"""
 
-    _sequential_before: List[AbstractVisitor]
-    _action_composed: List[AbstractVisitor]
-    _sequential_after: List[AbstractVisitor]
+    _sequential_before: List[AnyVisitor]
+    _action_composed: List[AnyVisitor]
+    _sequential_after: List[AnyVisitor]
     _is_reversed: bool
     _with_progress_bar: bool
 
     def __init__(
         self,
-        actions: List[AbstractVisitor],
+        actions: List[AnyVisitor],
         *,
-        before: List[AbstractVisitor],
-        after: List[AbstractVisitor],
+        before: List[AnyVisitor] = None,
+        after: List[AnyVisitor] = None,
         progress_bar_on_actions: bool = False,
     ):
         """
@@ -189,7 +189,6 @@ def __init__(
         :param after:
         :param progress_bar_on_actions:
         """
-        assert len(actions) > 1, "Composition of not at least 2 visitors is useless"
         reversed_action: List[bool] = [rev.is_reversed for rev in actions]
         assert all(reversed_action) or not any(
             reversed_action
@@ -198,8 +197,8 @@ def __init__(
         self._is_reversed = reversed_action[0]
         self._with_progress_bar = progress_bar_on_actions
         self._action_composed = actions
-        self._sequential_before = before
-        self._sequential_after = after
+        self._sequential_before = before or []
+        self._sequential_after = after or []
 
     def visit(self, root: FreExNode) -> bool:
         to_continue = True
@@ -233,7 +232,7 @@ def _composed_visit(self, root: FreExNode) -> bool:
             for node_id in sorted_node_list:
                 # do the visitation for the node on each action visitor
                 for action_visitor in self._action_composed:
-                    if not root.graph_ref.nodes[node_id].apply_accept_(action_visitor):
+                    if not root.graph_ref.nodes[node_id]["content"].apply_accept_(action_visitor):
                         return False
 
                 pbar.set_postfix({"node": node_id})

setup.py

@@ -22,10 +22,20 @@
 # SOFTWARE.
 
 import setuptools
+import re
+
+VERSIONFILE="freexgraph/_version.py"
+verstrline = open(VERSIONFILE, "rt").read()
+VSRE = r"^__version__ = ['\"]([^'\"]*)['\"]"
+mo = re.search(VSRE, verstrline, re.M)
+if mo:
+    verstr = mo.group(1)
+else:
+    raise RuntimeError("Unable to find version string in %s." % (VERSIONFILE,))
 
 setuptools.setup(
     name="freexgraph",
-    version="0.1.0",
+    version=verstr,
     author="Quentin Balland",
     author_email="ballandFyS@protonmail.com",
     description="An execution graph library",

test/basic_freexgraph_test.py

@@ -24,7 +24,7 @@
 import pytest
 import uuid
 
-from typing import List, Optional
+from typing import Optional
 
 from freexgraph.freexgraph import GraphNode
 from freexgraph import FreExNode, FreExGraph