Merge pull request #176 from kayjan/fix-hprint

Fixed: hprint and hyield (and hshow) to support binary node

Author: kayjan

.pre-commit-config.yaml

@@ -11,12 +11,12 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 24.1.0
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/flake8

CHANGELOG.md

@@ -5,11 +5,16 @@ 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).
 
 ## [Unreleased]
+
+## [0.15.7] - 2023-01-26
 ### Added
 - Misc: Sphinx documentation to support mermaid markdown images, reflect CHANGELOG section, add more emojis.
 ### Changed
 - Misc: Update SEO image.
 - Misc: Fix Sphinx documentation font size difference between web and mobile, include last updated date.
+- Misc: Upgrade package versions in pre-commit hook.
+### Fixed
+- Tree Exporter: `hprint_tree` and `hyield_tree` to be compatible with `BinaryNode` where child nodes can be None type.
 
 ## [0.15.6] - 2023-01-20
 ### Added
@@ -468,7 +473,8 @@ 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.
 
-[Unreleased]: https://github.com/kayjan/bigtree/compare/0.15.6...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/0.15.7...HEAD
+[0.15.7]: https://github.com/kayjan/bigtree/compare/0.15.6...0.15.7
 [0.15.6]: https://github.com/kayjan/bigtree/compare/0.15.5...0.15.6
 [0.15.5]: https://github.com/kayjan/bigtree/compare/0.15.4...0.15.5
 [0.15.4]: https://github.com/kayjan/bigtree/compare/0.15.3...0.15.4

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.15.6"
+__version__ = "0.15.7"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag
@@ -75,4 +75,4 @@
 from bigtree.workflows.app_calendar import Calendar
 from bigtree.workflows.app_todo import AppToDo
 
-sphinx_versions = ["latest", "0.15.6", "0.14.8"]
+sphinx_versions = ["latest", "0.15.7", "0.14.8"]

bigtree/tree/construct.py

@@ -1068,9 +1068,11 @@ def _create_node(
         elif _cumulative_string:
             _new_node.set_attrs(
                 {
-                    length_attr: int(_cumulative_string)
-                    if _cumulative_string.isdigit()
-                    else float(_cumulative_string)
+                    length_attr: (
+                        int(_cumulative_string)
+                        if _cumulative_string.isdigit()
+                        else float(_cumulative_string)
+                    )
                 }
             )
 

bigtree/tree/export.py

@@ -619,19 +619,22 @@ def hyield_tree(
         for _idx, _children in enumerate(levelordergroup_iter(tree)):
             padding_depths[_idx + 1] = max([len(node.node_name) for node in _children])
 
-    def _hprint_branch(_node: T) -> Tuple[List[str], int]:
+    def _hprint_branch(_node: Union[T, Node], _cur_depth: int) -> Tuple[List[str], int]:
         """Get string for tree horizontally.
         Recursively iterate the nodes in post-order traversal manner.
 
         Args:
             _node (Node): node to get string
+            _cur_depth (int): current depth of node
 
         Returns:
             (Tuple[List[str], int]): Intermediate/final result for node, index of branch
         """
-        node_name_centered = _node.node_name.center(padding_depths[_node.depth])
+        if not _node:
+            _node = Node("  ")
+        node_name_centered = _node.node_name.center(padding_depths[_cur_depth])
 
-        children = list(_node.children)
+        children = list(_node.children) if any(list(_node.children)) else []
         if not len(children):
             node_str = f"{style_branch} {node_name_centered.rstrip()}"
             return [node_str], 0
@@ -643,7 +646,7 @@ def _hprint_branch(_node: T) -> Tuple[List[str], int]:
             node_str = f"""{style_branch}{style_branch}{style_branch}"""
         padding = space * len(node_str)
         for idx, child in enumerate(children):
-            result_child, result_branch_idx = _hprint_branch(child)
+            result_child, result_branch_idx = _hprint_branch(child, _cur_depth + 1)
             result.extend(result_child)
             result_nrow.append(len(result_child))
             result_idx.append(result_branch_idx)
@@ -712,7 +715,7 @@ def _hprint_branch(_node: T) -> Tuple[List[str], int]:
         result = [prefix + stem for prefix, stem in zip(result_prefix, result)]
         return result, mid
 
-    result, _ = _hprint_branch(tree)
+    result, _ = _hprint_branch(tree, 1)
     return result
 
 

tests/node/test_binarynode.py

@@ -5,6 +5,7 @@
 from bigtree.node.basenode import BaseNode
 from bigtree.node.binarynode import BinaryNode
 from bigtree.node.node import Node
+from bigtree.tree.export import hprint_tree
 from bigtree.tree.helper import clone_tree
 from bigtree.utils.exceptions import LoopError, TreeError
 from tests.conftest import assert_print_statement
@@ -970,6 +971,21 @@ def assert_binarytree_structure_root2(root):
     f, g = c.children
     h, _ = d.children
 
+    expected_str = (
+        "                 ┌─ 8\n"
+        "           ┌─ 4 ─┤\n"
+        "     ┌─ 2 ─┤     └─ \n"
+        "─ 1 ─┤     └─ 5\n"
+        "     │     ┌─ 6\n"
+        "     └─ 3 ─┤\n"
+        "           └─ 7\n"
+    )
+    assert_print_statement(
+        hprint_tree,
+        expected_str,
+        tree=root,
+    )
+
     class Sample:
         pass