Remove optional checks, add benchmark timings (#411)

* feat: nested_key_dict to tree to support child_key=None

* feat: tree to nested_key_dict to support child_key=None

* docs: update CHANGELOG

* docs: add benchmark timing ipynb

* style: shift method

Author: kayjan

CHANGELOG.md

@@ -5,6 +5,12 @@ 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]
+
+## [1.0.1] - 2025-10-18
+### Added:
+- Documentation: Benchmark timings against other libraries.
+### Changed:
+- Optimisation: Empty node name and duplicated path as optional checks if ASSERTIONS=false. Default does not change.
 ### Fixed:
 - Tree Export: Print tree to display correctly for subtrees / non-root nodes.
 
@@ -839,7 +845,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/1.0.0...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/1.0.1...HEAD
+[1.0.1]: https://github.com/kayjan/bigtree/compare/1.0.0...1.0.1
 [1.0.0]: https://github.com/kayjan/bigtree/compare/0.31.2...1.0.0
 [0.31.2]: https://github.com/kayjan/bigtree/compare/0.31.1...0.31.2
 [0.31.1]: https://github.com/kayjan/bigtree/compare/0.31.0...0.31.1

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 
 from bigtree.binarytree.binarytree import BinaryTree
 from bigtree.binarytree.construct import list_to_binarytree

bigtree/node/node.py

@@ -3,6 +3,7 @@
 from collections import Counter
 from typing import Any, TypeVar
 
+from bigtree.globals import ASSERTIONS
 from bigtree.node import basenode
 from bigtree.utils import exceptions
 
@@ -83,7 +84,7 @@ def __init__(self, name: str, sep: str = "/", **kwargs: Any):
         self.name = name
         self._sep = sep
         super().__init__(**kwargs)
-        if not self.node_name:
+        if ASSERTIONS and not self.node_name:
             raise exceptions.TreeError("Node must have a `name` attribute")
 
     @property
@@ -126,47 +127,13 @@ def path_name(self) -> str:
         sep = ancestors[-1].sep
         return sep + sep.join([str(node.node_name) for node in reversed(ancestors)])
 
-    def __pre_assign_children(self: T, new_children: list[T]) -> None:
-        """Custom method to check before attaching children
-        Can be overridden with `_Node__pre_assign_children()`
-
-        Args:
-            new_children (list[Self]): new children to be added
-        """
-        pass
-
-    def __post_assign_children(self: T, new_children: list[T]) -> None:
-        """Custom method to check after attaching children. Can be overridden with `_Node__post_assign_children()`.
-
-        Args:
-            new_children: new children to be added
-        """
-        pass
-
-    def __pre_assign_parent(self: T, new_parent: T) -> None:
-        """Custom method to check before attaching parent. Can be overridden with `_Node__pre_assign_parent()`.
-
-        Args:
-            new_parent: new parent to be added
-        """
-        pass
-
-    def __post_assign_parent(self: T, new_parent: T) -> None:
-        """Custom method to check after attaching parent. Can be overridden with `_Node__post_assign_parent()`.
-
-        Args:
-            new_parent: new parent to be added
-        """
-        pass
-
     def _BaseNode__pre_assign_parent(self: T, new_parent: T) -> None:
         """Do not allow duplicate nodes of same path.
 
         Args:
             new_parent: new parent to be added
         """
-        self.__pre_assign_parent(new_parent)
-        if new_parent is not None:
+        if ASSERTIONS and new_parent is not None:
             if any(
                 child.node_name == self.node_name and child is not self
                 for child in new_parent.children
@@ -176,41 +143,25 @@ def _BaseNode__pre_assign_parent(self: T, new_parent: T) -> None:
                     f"There exist a node with same path {new_parent.path_name}{new_parent.sep}{self.node_name}"
                 )
 
-    def _BaseNode__post_assign_parent(self: T, new_parent: T) -> None:
-        """No rules.
-
-        Args:
-            new_parent: new parent to be added
-        """
-        self.__post_assign_parent(new_parent)
-
     def _BaseNode__pre_assign_children(self: T, new_children: list[T]) -> None:
         """Do not allow duplicate nodes of same path.
 
         Args:
             new_children: new children to be added
         """
-        self.__pre_assign_children(new_children)
-        children_names = [node.node_name for node in new_children]
-        duplicate_names = [
-            item[0] for item in Counter(children_names).items() if item[1] > 1
-        ]
-        if len(duplicate_names):
-            duplicate_names_str = " and ".join(
-                [f"{self.path_name}{self.sep}{name}" for name in duplicate_names]
-            )
-            raise exceptions.TreeError(
-                f"Duplicate node with same path\n"
-                f"Attempting to add nodes with same path {duplicate_names_str}"
-            )
-
-    def _BaseNode__post_assign_children(self: T, new_children: list[T]) -> None:
-        """No rules.
-
-        Args:
-            new_children: new children to be added
-        """
-        self.__post_assign_children(new_children)
+        if ASSERTIONS:
+            children_names = [node.node_name for node in new_children]
+            duplicate_names = [
+                item[0] for item in Counter(children_names).items() if item[1] > 1
+            ]
+            if len(duplicate_names):
+                duplicate_names_str = " and ".join(
+                    [f"{self.path_name}{self.sep}{name}" for name in duplicate_names]
+                )
+                raise exceptions.TreeError(
+                    f"Duplicate node with same path\n"
+                    f"Attempting to add nodes with same path {duplicate_names_str}"
+                )
 
     def show(self, **kwargs: Any) -> None:
         """Print tree to console, takes in same keyword arguments as `print_tree` function."""