v0.7.3 misc fix for print_tree, add unit tests, modify contributing

kayjan · kayjan · commit dd03f3f1c1c0 · 2023-02-25T22:19:26.000+08:00
diff --git a/CHANGELOG.md b/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.7.3] - 2023-02-25
+### Added
+- Tree Export: Fixed `print_tree` checking attributes with `hasattr` to handle cases of null or 0 value attributes, add more test cases.
+- Contributing: Added more description.
 
 ## [0.7.2] - 2023-02-18
 ### Added
@@ -195,6 +199,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.7.3]: https://github.com/kayjan/bigtree/compare/v0.7.2...v0.7.3
 [0.7.2]: https://github.com/kayjan/bigtree/compare/v0.7.1...v0.7.2
 [0.7.1]: https://github.com/kayjan/bigtree/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/kayjan/bigtree/compare/v0.6.10...v0.7.0
diff --git a/bigtree/__init__.py b/bigtree/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.7.2"
+__version__ = "0.7.3"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag
diff --git a/bigtree/tree/export.py b/bigtree/tree/export.py
@@ -33,9 +33,9 @@ def print_tree(
     tree: Node,
     node_name_or_path: str = "",
     max_depth: int = None,
-    attr_list: List[str] = None,
     all_attrs: bool = False,
-    attr_omit_null: bool = True,
+    attr_list: List[str] = None,
+    attr_omit_null: bool = False,
     attr_bracket: List[str] = ["[", "]"],
     style: str = "const",
     custom_style: List[str] = [],
@@ -143,9 +143,9 @@ def print_tree(
         tree (Node): tree to print
         node_name_or_path (str): node to print from, becomes the root node of printing
         max_depth (int): maximum depth of tree to print, based on `depth` attribute, optional
+        all_attrs (bool): indicator to show all attributes, overrides `attr_list` and `attr_omit_null`
         attr_list (list): list of node attributes to print, optional
-        all_attrs (bool): indicator to show all attributes, overrides `attr_list`
-        attr_omit_null (bool): indicator whether to omit showing of null attributes, defaults to True
+        attr_omit_null (bool): indicator whether to omit showing of null attributes, defaults to False
         attr_bracket (List[str]): open and close bracket for `all_attrs` or `attr_list`
         style (str): style of print, defaults to abstract style
         custom_style (List[str]): style of stem, branch and final stem, used when `style` is set to 'custom'
@@ -179,6 +179,7 @@ def print_tree(
                     attr_str_list = [
                         f"{attr_name}={_node.get_attr(attr_name)}"
                         for attr_name in attr_list
+                        if hasattr(_node, attr_name)
                     ]
             attr_str = ", ".join(attr_str_list)
             if attr_str:
diff --git a/docs/source/others/contributing.rst b/docs/source/others/contributing.rst
@@ -40,7 +40,7 @@ Developing
 -----------------------------------
 
 After making your changes, create a new branch, add and commit your changed files.
-In this example, lets assume the changed file is `README.md`.
+In this example, lets assume the changed file is ``README.md``.
 If there are any pre-commit changes, do re-add and re-commit your files.
 
 .. code-block:: bash
@@ -70,17 +70,11 @@ Make sure your add/update the tests and documentations accordingly.
 Convention and Standards
 -----------------------------------
 
-When creating branches, it is recommended to create them in the format,
+When creating branches, it is recommended to create them in the format ``type/action``. For example,
 
 .. code-block:: bash
 
-    type/action
-
-For example,
-
-.. code-block:: bash
-
-    git checkout -b feat/add-this
+    $ git checkout -b feat/add-this
 
 When performing commits, it is also recommended to follow `conventional commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ when writing commit messages.
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -182,6 +182,38 @@ def tree_node_no_attr():
     return a
 
 
+@pytest.fixture
+def tree_node_negative_null_attr():
+    """
+    Tree should have structure
+    a
+    |-- b
+    |   |-- d
+    |   +-- e
+    |       |-- g
+    |       +-- h
+    +-- c
+        +-- f
+    """
+    a = Node("a")
+    b = Node("b", age=-1)
+    c = Node("c", age=0)
+    d = Node("d", age=1)
+    e = Node("e", age=None)
+    f = Node("f")
+    g = Node("g")
+    h = Node("h")
+
+    b.parent = a
+    c.parent = a
+    d.parent = b
+    e.parent = b
+    f.parent = c
+    g.parent = e
+    h.parent = e
+    return a
+
+
 @pytest.fixture
 def tree_node_style():
     """
diff --git a/tests/tree/test_export.py b/tests/tree/test_export.py
@@ -17,138 +17,178 @@
 )
 from tests.node.test_node import assert_tree_structure_node_root_generic
 
+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"""
+
 
 class TestPrintTree:
     @staticmethod
-    def test_print_tree_ansi(tree_node):
-        expected_str = """a\n|-- b\n|   |-- d\n|   `-- e\n|       |-- g\n|       `-- h\n`-- c\n    `-- f\n"""
-        assert_print_statement(print_tree, expected_str, tree=tree_node, style="ansi")
+    def test_print_tree_child_node_name(tree_node):
+        expected_str = """b\n├── d\n└── e\n    ├── g\n    └── h\n"""
+        assert_print_statement(
+            print_tree,
+            expected_str,
+            tree=tree_node,
+            node_name_or_path="b",
+        )
 
     @staticmethod
-    def test_print_tree_ascii(tree_node):
-        expected_str = """a\n|-- b\n|   |-- d\n|   +-- e\n|       |-- g\n|       +-- h\n+-- c\n    +-- f\n"""
-        assert_print_statement(print_tree, expected_str, tree=tree_node, style="ascii")
+    def test_print_tree_child_node_path(tree_node):
+        expected_str = """b\n├── d\n└── e\n    ├── g\n    └── h\n"""
+        assert_print_statement(
+            print_tree,
+            expected_str,
+            tree=tree_node,
+            node_name_or_path="a/b",
+        )
 
+    # all_attr
     @staticmethod
-    def test_print_tree_const(tree_node):
-        expected_str = """a\n├── b\n│   ├── d\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f\n"""
-        assert_print_statement(print_tree, expected_str, tree=tree_node, style="const")
+    def test_print_tree_all_attr(tree_node):
+        assert_print_statement(
+            print_tree, tree_node_str, tree=tree_node, all_attrs=True
+        )
 
     @staticmethod
-    def test_print_tree_const_bold(tree_node):
-        expected_str = """a\n┣━━ b\n┃   ┣━━ d\n┃   ┗━━ e\n┃       ┣━━ g\n┃       ┗━━ h\n┗━━ c\n    ┗━━ f\n"""
+    def test_print_tree_all_attr_empty(tree_node_no_attr):
         assert_print_statement(
-            print_tree, expected_str, tree=tree_node, style="const_bold"
+            print_tree,
+            tree_node_no_attr_str,
+            tree=tree_node_no_attr,
+            all_attrs=True,
         )
 
+    # attr_list
     @staticmethod
-    def test_print_tree_rounded(tree_node):
-        expected_str = """a\n├── b\n│   ├── d\n│   ╰── e\n│       ├── g\n│       ╰── h\n╰── c\n    ╰── f\n"""
+    def test_print_tree_attr_list(tree_node):
         assert_print_statement(
-            print_tree, expected_str, tree=tree_node, style="rounded"
+            print_tree, tree_node_str, tree=tree_node, attr_list=["age"]
         )
 
     @staticmethod
-    def test_print_tree_double(tree_node):
-        expected_str = """a\n╠══ b\n║   ╠══ d\n║   ╚══ e\n║       ╠══ g\n║       ╚══ h\n╚══ c\n    ╚══ f\n"""
-        assert_print_statement(print_tree, expected_str, tree=tree_node, style="double")
+    def test_print_tree_invalid_attr(tree_node):
+        assert_print_statement(
+            print_tree, tree_node_no_attr_str, tree=tree_node, attr_list=["random"]
+        )
 
+    # attr_list, attr_omit_null
     @staticmethod
-    def test_print_tree_custom(tree_node):
-        expected_str = """a\nb\nd\ne\ng\nh\nc\nf\n"""
+    def test_print_tree_attr_omit_null_false(tree_node_negative_null_attr):
+        expected_str = """a\n├── b [age=-1]\n│   ├── d [age=1]\n│   └── e [age=None]\n│       ├── g\n│       └── h\n└── c [age=0]\n    └── f\n"""
+        assert_print_statement(
+            print_tree,
+            expected_str,
+            tree=tree_node_negative_null_attr,
+            attr_list=["age"],
+            attr_omit_null=False,
+        )
+
+    @staticmethod
+    def test_print_tree_attr_omit_null_true(tree_node_negative_null_attr):
+        expected_str = """a\n├── b [age=-1]\n│   ├── d [age=1]\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f\n"""
         assert_print_statement(
             print_tree,
             expected_str,
+            tree=tree_node_negative_null_attr,
+            attr_list=["age"],
+            attr_omit_null=True,
+        )
+
+    # attr_bracket
+    @staticmethod
+    def test_print_tree_attr_bracket(tree_node):
+        assert_print_statement(
+            print_tree,
+            tree_node_str.replace("[", "(").replace("]", ")"),
             tree=tree_node,
-            style="custom",
-            custom_style=["", "", ""],
+            all_attrs=True,
+            attr_bracket=["(", ")"],
         )
 
     @staticmethod
-    def test_print_tree_unknown_style(tree_node):
-        with pytest.raises(ValueError):
-            print_tree(tree_node, style="something")
+    def test_print_tree_attr_bracket_missing_error(tree_node):
+        with pytest.raises(ValueError) as exc_info:
+            print_tree(tree_node, all_attrs=True, attr_bracket=[""])
+        assert str(exc_info.value).startswith(
+            "Expect open and close brackets in `attr_bracket`"
+        )
 
+    # style
     @staticmethod
-    def test_print_tree_no_attr(tree_node):
+    def test_print_tree_style_ansi(tree_node):
         expected_str = """a\n|-- b\n|   |-- d\n|   `-- e\n|       |-- g\n|       `-- h\n`-- c\n    `-- f\n"""
+        assert_print_statement(print_tree, expected_str, tree=tree_node, style="ansi")
+
+    @staticmethod
+    def test_print_tree_style_ascii(tree_node):
+        expected_str = """a\n|-- b\n|   |-- d\n|   +-- e\n|       |-- g\n|       +-- h\n+-- c\n    +-- f\n"""
+        assert_print_statement(print_tree, expected_str, tree=tree_node, style="ascii")
+
+    @staticmethod
+    def test_print_tree_style_const(tree_node):
+        expected_str = """a\n├── b\n│   ├── d\n│   └── e\n│       ├── g\n│       └── h\n└── c\n    └── f\n"""
+        assert_print_statement(print_tree, expected_str, tree=tree_node, style="const")
+
+    @staticmethod
+    def test_print_tree_style_const_bold(tree_node):
+        expected_str = """a\n┣━━ b\n┃   ┣━━ d\n┃   ┗━━ e\n┃       ┣━━ g\n┃       ┗━━ h\n┗━━ c\n    ┗━━ f\n"""
         assert_print_statement(
-            print_tree, expected_str, tree=tree_node, attr_list=["random"], style="ansi"
+            print_tree, expected_str, tree=tree_node, style="const_bold"
         )
 
     @staticmethod
-    def test_print_tree_child_node_name(tree_node):
-        expected_str = """b\n|-- d\n`-- e\n    |-- g\n    `-- h\n"""
+    def test_print_tree_style_rounded(tree_node):
+        expected_str = """a\n├── b\n│   ├── d\n│   ╰── e\n│       ├── g\n│       ╰── h\n╰── c\n    ╰── f\n"""
         assert_print_statement(
-            print_tree,
-            expected_str,
-            tree=tree_node,
-            node_name_or_path="b",
-            style="ansi",
+            print_tree, expected_str, tree=tree_node, style="rounded"
         )
 
     @staticmethod
-    def test_print_tree_child_node_path(tree_node):
-        expected_str = """b\n|-- d\n`-- e\n    |-- g\n    `-- h\n"""
+    def test_print_tree_style_double(tree_node):
+        expected_str = """a\n╠══ b\n║   ╠══ d\n║   ╚══ e\n║       ╠══ g\n║       ╚══ h\n╚══ c\n    ╚══ f\n"""
+        assert_print_statement(print_tree, expected_str, tree=tree_node, style="double")
+
+    @staticmethod
+    def test_print_tree_style_unknown_error(tree_node):
+        with pytest.raises(ValueError) as exc_info:
+            print_tree(tree_node, style="something")
+        assert str(exc_info.value).startswith("Choose one of")
+
+    # custom_style
+    @staticmethod
+    def test_print_tree_custom_style(tree_node):
+        expected_str = """a\nb\nd\ne\ng\nh\nc\nf\n"""
         assert_print_statement(
             print_tree,
             expected_str,
             tree=tree_node,
-            node_name_or_path="a/b",
-            style="ansi",
+            style="custom",
+            custom_style=["", "", ""],
         )
 
     @staticmethod
-    def test_print_tree_unequal_char(tree_node):
-        with pytest.raises(ValueError):
+    def test_print_tree_custom_style_unequal_char_error(tree_node):
+        with pytest.raises(ValueError) as exc_info:
             print_tree(
                 tree_node,
                 style="custom",
                 custom_style=["", " ", ""],
             )
+        assert str(exc_info.value).startswith(
+            "`style_stem`, `style_branch`, and `style_stem_final` are of different length"
+        )
 
     @staticmethod
-    def test_print_tree_missing_style(tree_node):
-        with pytest.raises(ValueError):
+    def test_print_tree_custom_style_missing_style_error(tree_node):
+        with pytest.raises(ValueError) as exc_info:
             print_tree(
                 tree_node,
                 style="custom",
                 custom_style=["", ""],
             )
-
-    @staticmethod
-    def test_print_tree_missing_bracket(tree_node):
-        with pytest.raises(ValueError):
-            print_tree(tree_node, all_attrs=True, attr_bracket=[""])
-
-    @staticmethod
-    def test_print_tree_attr(tree_node):
-        expected_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"""
-        assert_print_statement(
-            print_tree,
-            expected_str,
-            tree=tree_node,
-            attr_list=["age"],
-            attr_omit_null=False,
-            style="ansi",
-        )
-
-    @staticmethod
-    def test_print_tree_all_attr(tree_node):
-        expected_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"""
-        assert_print_statement(
-            print_tree, expected_str, tree=tree_node, all_attrs=True, style="ansi"
-        )
-
-    @staticmethod
-    def test_print_tree_all_attr_empty(tree_node_no_attr):
-        expected_str = """a\n|-- b\n|   |-- d\n|   `-- e\n|       |-- g\n|       `-- h\n`-- c\n    `-- f\n"""
-        assert_print_statement(
-            print_tree,
-            expected_str,
-            tree=tree_node_no_attr,
-            all_attrs=True,
-            style="ansi",
+        assert str(exc_info.value).startswith(
+            "Custom style selected, please specify the style of stem, branch, and final stem in `custom_style`"
         )
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = "0.7.2"`
	`1`	`+__version__ = "0.7.3"`
`2`	`2`
`3`	`3`	`from bigtree.binarytree.construct import list_to_binarytree`
`4`	`4`	`from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag`