v0.6.10 fix str_to_tree to support unicode characters

Author: kayjan

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.6.10] - 2023-01-23
+### Fixed
+- Tree Construct: `str_to_tree` to accept prefixes to support unicode characters in node names.
+
 ## [0.6.9] - 2023-01-22
 ### Added
 - Tree Construct: `str_to_tree` to construct tree from tree string.
@@ -177,6 +181,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Utility Iterator: Tree traversal methods.
 - Workflow To Do App: Tree use case with to-do list implementation.
 
+[0.6.10]: https://github.com/kayjan/bigtree/compare/v0.6.9...v0.6.10
 [0.6.9]: https://github.com/kayjan/bigtree/compare/v0.6.8...v0.6.9
 [0.6.8]: https://github.com/kayjan/bigtree/compare/v0.6.7...v0.6.8
 [0.6.7]: https://github.com/kayjan/bigtree/compare/v0.6.6...v0.6.7

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.6.9"
+__version__ = "0.6.10"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag

bigtree/tree/construct.py

@@ -1,3 +1,4 @@
+import re
 from collections import OrderedDict
 from typing import List, Tuple, Type
 
@@ -409,13 +410,14 @@ def add_dataframe_to_tree_by_name(
 
 def str_to_tree(
     tree_string: str,
+    tree_prefix_list: List[str] = [],
     node_type: Type[Node] = Node,
 ) -> Node:
     r"""Construct tree from tree string
 
     >>> from bigtree import str_to_tree, print_tree
     >>> tree_str = 'a\n├── b\n│   ├── d\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f'
-    >>> root = str_to_tree(tree_str)
+    >>> root = str_to_tree(tree_str, tree_prefix_list=["├──", "└──"])
     >>> print_tree(root)
     a
     ├── b
@@ -428,6 +430,8 @@ def str_to_tree(
 
     Args:
         tree_string (str): String to construct tree
+        tree_prefix_list (list): List of prefix to mark the end of tree branch/stem and start of node name, optional.
+            If not specified, it will infer unicode characters and whitespace as prefix.
         node_type (Type[Node]): node type of tree to be created, defaults to Node
 
     Returns:
@@ -443,21 +447,25 @@ def str_to_tree(
     prefix_length = None
     cur_parent = tree_root
     for node_str in tree_list[1:]:
-        node_name = node_str.encode("ascii", "ignore").decode("ascii").lstrip()
+        if len(tree_prefix_list):
+            node_name = re.split("|".join(tree_prefix_list), node_str)[-1].lstrip()
+        else:
+            node_name = node_str.encode("ascii", "ignore").decode("ascii").lstrip()
 
         # Find node parent
         if not prefix_length:
             prefix_length = node_str.index(node_name)
             if not prefix_length:
                 raise ValueError(
-                    f"Invalid prefix, prefix should be unicode character or whitespace, check: {node_str}"
+                    f"Invalid prefix, prefix should be unicode character or whitespace, "
+                    f"otherwise specify one or more prefixes in `tree_prefix_list`, check: {node_str}"
                 )
-        node_prefix = node_str.index(node_name)
-        if node_prefix % prefix_length:
+        node_prefix_length = node_str.index(node_name)
+        if node_prefix_length % prefix_length:
             raise ValueError(
                 f"Tree string have different prefix length, check branch: {node_str}"
             )
-        while cur_parent.depth > node_prefix / prefix_length:
+        while cur_parent.depth > node_prefix_length / prefix_length:
             cur_parent = cur_parent.parent
 
         # Link node

tests/tree/test_construct.py

@@ -865,6 +865,30 @@ def test_str_to_tree(self):
         assert_tree_structure_basenode_root_generic(root)
         assert_tree_structure_node_root_generic(root)
 
+    def test_str_to_tree_with_prefix(self):
+        root = str_to_tree(self.tree_str, tree_prefix_list=["─"])
+        assert_tree_structure_basenode_root_generic(root)
+        assert_tree_structure_node_root_generic(root)
+
+    def test_str_to_tree_with_multiple_prefix(self):
+        root = str_to_tree(self.tree_str, tree_prefix_list=["├──", "└──"])
+        assert_tree_structure_basenode_root_generic(root)
+        assert_tree_structure_node_root_generic(root)
+
+    def test_ascii_character_error(self):
+        tree_str = "a\n|-- b\n|   |-- d\n|   +-- e\n|       |-- g\n|       +-- h\n+-- c\n    +-- f"
+        with pytest.raises(ValueError) as exc_info:
+            str_to_tree(tree_str)
+        assert str(exc_info.value).startswith(
+            "Invalid prefix, prefix should be unicode character or whitespace, otherwise specify one or more prefixes"
+        )
+
+    def test_ascii_character_with_prefix(self):
+        tree_str = "a\n|-- b\n|   |-- d\n|   +-- e\n|       |-- g\n|       +-- h\n+-- c\n    +-- f"
+        root = str_to_tree(tree_str, tree_prefix_list=["-"])
+        assert_tree_structure_basenode_root_generic(root)
+        assert_tree_structure_node_root_generic(root)
+
     def test_empty_string(self):
         with pytest.raises(ValueError) as exc_info:
             str_to_tree("")
@@ -881,14 +905,6 @@ def test_empty_newline_string(self):
             == "Tree string does not contain any data, check `tree_string`"
         )
 
-    def test_invalid_prefix(self):
-        tree_str = "a\n|-- b\n|   |-- d\n|   +-- e\n|       |-- g\n|       +-- h\n+-- c\n    +-- f"
-        with pytest.raises(ValueError) as exc_info:
-            str_to_tree(tree_str)
-        assert str(exc_info.value).startswith(
-            "Invalid prefix, prefix should be unicode character or whitespace"
-        )
-
     def test_unequal_prefix_length(self):
         tree_str = "a\n├── b\n│  ├── d\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f"
         with pytest.raises(ValueError) as exc_info: