Fix documentation, Change version and Changelog

Author: FreeYourSoul

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelogs
 
 ## Version 1.2.2
-(Released : April 30, 2021) : tag 1.2.2
+(Released : May 06, 2021) : tag 1.2.2
 * Improve forking mechanism to match with sub_graph
 * Improve fork/sub_graph documentation
 * Forward kwargs on standard visitor to be able to use BaseVisitor constructor

README.md

@@ -228,7 +228,6 @@ This feature may be used as a fork mechanism (as seen above). It is easier to ma
 
 Usage Example:
 
-```python
 ```python
 #            id0
 #             |

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.2.1"
+__version__ = "1.2.2"

freexgraph/freexgraph.py

@@ -154,19 +154,6 @@ def accept(self, visitor: AnyVisitor) -> bool:
 """Utility to simplify code"""
 
 
-def _remove_duplicated_node(nodes: List[FreExNode]) -> List[FreExNode]:
-    """return a copy of provided the list without duplicates, a duplicate is defined by its id"""
-    filtered_list = []
-    for n in nodes:
-        found = False
-        for in_list in filtered_list:
-            if n.id == in_list.id:
-                found = True
-        if not found:
-            filtered_list.append(n)
-    return filtered_list
-
-
 class FreExGraph:
     """Execution Graph main class"""
 
@@ -182,8 +169,6 @@ def __init__(self):
     @staticmethod
     def _make_node_id_with_fork(node_id: str, fork_id: str) -> str:
         """make a unique id for the new fork"""
-        if node_id == root_node:
-            return node_id
         return f"{node_id}::{fork_id}"
 
     def add_nodes(self, nodes: List[AnyFreExNode]) -> None:
@@ -339,21 +324,25 @@ def fork_from_node(
         id will be appended with the fork_id set on the forked_node. For this reason it is required to have a fork_id
         set on the forked_node.
 
-        > It is the user responsibility to ensure that those id doesn't collide.
-
         If the provided join_node doesn't exist, an exception is thrown.
         If a join node is provided, all node from the provided one until the join node is encountered are duplicated. if
         the join node is not encountered, duplicate node until leaf
 
+        warning:
+            It is the user responsibility to ensure that those id doesn't collide.
+
         side_note:
             ':' is used as a separator for the id and the fork_id to ensure a unique name. This is the reason why '::'
             is reserved and cannot be used.
 
+        raise Assertion failure:
+            * if the node defined by forked_node.id doesn't exist in the graph.
+            * if the forked_node doesn't contains a fork_id.
+            * if a join_node is provided but does not exist.
+
         :param forked_node: node to replace the fork one, its fork_id field has to be set
-        :param join_id: node to stop duplication (used for map_reduce)
-        :exception: Assertion failure in case that the node defined by forked_node.id doesn't exist in the graph or is a
-         GraphNode, or if the forked_node doesn't contains a fork_id. Assertion failure if a join_node is provided but
-         does not exist or that the join_node is not linking all last node to be forked.
+        :param join_id: node to stop duplication (used for map_reduce) if encountered
+
         """
         assert self._graph.has_node(
             forked_node.id
@@ -365,10 +354,9 @@ def fork_from_node(
             join_id
         ), f"Error fork of node {forked_node.id} with join_id {join_id}: join_id node doesn't exist in graph "
 
-        join_node_list = [join_id] if join_id else []
         sub_graph, removed_parents = self.sub_graph(
             from_node_id=forked_node.id,
-            to_nodes_id=join_node_list,
+            to_nodes_id=[join_id] if join_id else [],
             return_removed_parents=True,
         )
         sub_graph._graph.remove_node(root_node)

recipe.nix

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

test/fork_test.py

@@ -191,3 +191,46 @@ def test_fork_with_join_unlinked_with_join_2(node_test_class, visitor_test):
 
     visitor_test.visit(execution_graph.root)
     assert len(visitor_test.visited) == 18
+
+
+def test_fork_without_fork_id(node_test_class, visitor_test):
+    execution_graph = make_fork_graph(node_test_class)
+    visitor_test.visit(execution_graph.root)
+
+    with pytest.raises(AssertionError) as e:
+        execution_graph.fork_from_node(
+            node_test_class(id1, fork_id=None), join_id=id_join
+        )
+        assert f"Error fork of node {id1}: doesn't have fork_id" == e
+
+
+def test_fork_with_inexistant_join_id(node_test_class, visitor_test):
+    execution_graph = make_fork_graph(node_test_class)
+    visitor_test.visit(execution_graph.root)
+
+    join_not_exist = "ThisDoesntExistAtAll"
+
+    with pytest.raises(AssertionError) as e:
+        execution_graph.fork_from_node(
+            node_test_class(id1, fork_id="chocobo"), join_id=join_not_exist
+        )
+        assert (
+            f"Error fork of node {id1} with join_id {join_not_exist}: join_id node doesn't exist in graph "
+            == e
+        )
+
+
+def test_fork_with_inexistant_node(node_test_class, visitor_test):
+    execution_graph = make_fork_graph(node_test_class)
+    visitor_test.visit(execution_graph.root)
+
+    id_not_exist = "ThisDoesntExistAtAll"
+
+    with pytest.raises(AssertionError) as e:
+        execution_graph.fork_from_node(
+            node_test_class(id_not_exist, fork_id="chocobo"), join_id=id_join
+        )
+        assert (
+            f"Error fork of node {id_not_exist}, node to fork has to be in the execution graph"
+            == e
+        )