Merge pull request #287 from kayjan/feature/clean-print-kwargs

Clean print kwargs

Author: kayjan

CHANGELOG.md

@@ -5,6 +5,13 @@ 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.20.0] - 2024-08-24
+### Added:
+- [#285] Tree Exporter: `print_tree` and `hprint_tree` to accept keyword arguments for printing.
+- Misc: Template for release notes.
+### Changed:
+- Misc: Enhanced template for issues (bugfix/feature release).
 ### Fixed:
 - Tree Exporter: `tree_to_mermaid` fix for root node to have node attribute.
 
@@ -627,7 +634,8 @@ ignore null attribute columns.
 - 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.19.4...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/0.20.0...HEAD
+[0.20.0]: https://github.com/kayjan/bigtree/compare/0.19.4...0.20.0
 [0.19.4]: https://github.com/kayjan/bigtree/compare/0.19.3...0.19.4
 [0.19.3]: https://github.com/kayjan/bigtree/compare/0.19.2...0.19.3
 [0.19.2]: https://github.com/kayjan/bigtree/compare/0.19.1...0.19.2

bigtree/__init__.py

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

bigtree/tree/export.py

@@ -73,7 +73,7 @@ def print_tree(
     attr_omit_null: bool = False,
     attr_bracket: List[str] = ["[", "]"],
     style: Union[str, Iterable[str], BasePrintStyle] = "const",
-    **print_kwargs,
+    **print_kwargs: Any,
 ) -> None:
     """Print tree to console, starting from `tree`.
 
@@ -196,13 +196,14 @@ def print_tree(
         >>> import io
         >>> output = io.StringIO()
         >>> print_tree(root, file=output)
-        >>> string = output.getvalue()
-        >>> print(string)
+        >>> tree_string = output.getvalue()
+        >>> print(tree_string)
         a
         ├── b
         │   ├── d
         │   └── e
         └── c
+        <BLANKLINE>
 
     Args:
         tree (Node): tree to print
@@ -432,7 +433,7 @@ def hprint_tree(
     max_depth: int = 0,
     intermediate_node_name: bool = True,
     style: Union[str, Iterable[str], BaseHPrintStyle] = "const",
-    **print_kwargs,
+    **print_kwargs: Any,
 ) -> None:
     """Print tree in horizontal orientation to console, starting from `tree`.
 
@@ -527,8 +528,8 @@ def hprint_tree(
         >>> import io
         >>> output = io.StringIO()
         >>> hprint_tree(root, file=output)
-        >>> string = output.getvalue()
-        >>> print(string)
+        >>> tree_string = output.getvalue()
+        >>> print(tree_string)
                    ┌─ d
              ┌─ b ─┤
         ─ a ─┤     └─ e

tests/tree/test_export.py

@@ -1,3 +1,5 @@
+import io
+
 import pandas as pd
 import polars as pl
 import pydot
@@ -23,17 +25,56 @@
 from tests.node.test_node import assert_tree_structure_node_root
 from tests.test_constants import Constants
 
-tree_node_str = """a [age=90]\n├── b [age=65]\n│   ├── d [age=40]\n│   └── e [age=35]\n│       ├── g [age=10]
-│       └── h [age=6]\n└── c [age=60]\n    └── f [age=38]\n"""
-tree_node_no_attr_str = """a\n├── b\n│   ├── d\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f\n"""
-
+tree_node_str = (
+    "a [age=90]\n"
+    "├── b [age=65]\n"
+    "│   ├── d [age=40]\n"
+    "│   └── e [age=35]\n"
+    "│       ├── g [age=10]\n"
+    "│       └── h [age=6]\n"
+    "└── c [age=60]\n"
+    "    └── f [age=38]\n"
+)
+tree_node_no_attr_str = (
+    "a\n"
+    "├── b\n"
+    "│   ├── d\n"
+    "│   └── e\n"
+    "│       ├── g\n"
+    "│       └── h\n"
+    "└── c\n"
+    "    └── f\n"
+)
+tree_node_hstr = (
+    "           ┌─ d\n"
+    "     ┌─ b ─┤     ┌─ g\n"
+    "─ a ─┤     └─ e ─┤\n"
+    "     │           └─ h\n"
+    "     └─ c ─── f\n"
+)
+# fmt: off
+tree_node_branch_hstr = (
+    "     ┌─ d\n"
+    "─ b ─┤     ┌─ g\n"
+    "     └─ e ─┤\n"
+    "           └─ h\n"
+)
+# fmt: on
 LOCAL = Constants.LOCAL
 
 
 class TestPrintTree:
     @staticmethod
     def test_print_tree_child_node_name(tree_node):
-        expected_str = "b\n" "├── d\n" "└── e\n" "    ├── g\n" "    └── h\n"
+        # fmt: off
+        expected_str = (
+            "b\n"
+            "├── d\n"
+            "└── e\n"
+            "    ├── g\n"
+            "    └── h\n"
+        )
+        # fmt: on
         assert_print_statement(
             print_tree,
             expected_str,
@@ -54,7 +95,15 @@ def test_print_tree_child_node_name_error(tree_node):
 
     @staticmethod
     def test_print_tree_child_node_path(tree_node):
-        expected_str = "b\n" "├── d\n" "└── e\n" "    ├── g\n" "    └── h\n"
+        # fmt: off
+        expected_str = (
+            "b\n"
+            "├── d\n"
+            "└── e\n"
+            "    ├── g\n"
+            "    └── h\n"
+        )
+        # fmt: on
         assert_print_statement(
             print_tree,
             expected_str,
@@ -352,20 +401,19 @@ def test_print_tree_custom_style_missing_style_error(tree_node):
             )
         assert str(exc_info.value) == Constants.ERROR_NODE_EXPORT_PRINT_STYLE_SELECT
 
+    @staticmethod
+    def test_print_tree_print_kwargs(tree_node):
+        output = io.StringIO()
+        print_tree(tree_node, file=output)
+        assert output.getvalue() == tree_node_no_attr_str
+
 
 class TestHPrintTree:
     @staticmethod
     def test_hprint_tree(tree_node):
-        expected_str = (
-            "           ┌─ d\n"
-            "     ┌─ b ─┤     ┌─ g\n"
-            "─ a ─┤     └─ e ─┤\n"
-            "     │           └─ h\n"
-            "     └─ c ─── f\n"
-        )
         assert_print_statement(
             hprint_tree,
-            expected_str,
+            tree_node_hstr,
             tree=tree_node,
         )
 
@@ -473,12 +521,9 @@ def test_hprint_tree_diff_node_name_length(tree_node):
 
     @staticmethod
     def test_hprint_tree_child_node_name(tree_node):
-        expected_str = (
-            "     ┌─ d\n" "─ b ─┤     ┌─ g\n" "     └─ e ─┤\n" "           └─ h\n"
-        )
         assert_print_statement(
             hprint_tree,
-            expected_str,
+            tree_node_branch_hstr,
             tree=tree_node,
             node_name_or_path="b",
         )
@@ -496,12 +541,9 @@ def test_hprint_tree_child_node_name_error(tree_node):
 
     @staticmethod
     def test_hprint_tree_child_node_path(tree_node):
-        expected_str = (
-            "     ┌─ d\n" "─ b ─┤     ┌─ g\n" "     └─ e ─┤\n" "           └─ h\n"
-        )
         assert_print_statement(
             hprint_tree,
-            expected_str,
+            tree_node_branch_hstr,
             tree=tree_node,
             node_name_or_path="a/b",
         )
@@ -749,6 +791,12 @@ def test_hprint_tree_custom_style_missing_style_error(tree_node):
             hprint_tree(tree_node, style=["-", "+", "+", "|", "-", "="])
         assert str(exc_info.value) == Constants.ERROR_NODE_EXPORT_HPRINT_STYLE_SELECT
 
+    @staticmethod
+    def test_hprint_tree_print_kwargs(tree_node):
+        output = io.StringIO()
+        hprint_tree(tree_node, file=output)
+        assert output.getvalue() == tree_node_hstr
+
 
 class TestTreeToDataFrame:
     @staticmethod