Rename the config to Globals (#418)

* docs: update horizontal line

Author: kayjan

CHANGELOG.md

@@ -6,10 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.2] - 2025-10-23
+## [1.0.3] - 2025-10-30
 ### Added:
-- Optional checks: Able to toggle for optional checks after importing bigtree. Previously, you can only set the
-environment variables before import.
+- Optional checks: Able to toggle for optional checks after importing bigtree. Previously, it is set at the start using
+environment variables before import and not able to toggle after. Implemented as a bigtree._globals.Globals class.
 
 ## [1.0.2] - 2025-10-23
 ### Added:
@@ -856,7 +856,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.2...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/1.0.3...HEAD
+[1.0.3]: https://github.com/kayjan/bigtree/compare/1.0.2...1.0.3
 [1.0.2]: https://github.com/kayjan/bigtree/compare/1.0.1...1.0.2
 [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

bigtree/__init__.py

@@ -1,12 +1,12 @@
-__version__ = "1.0.2"
+__version__ = "1.0.3"
 
+from bigtree._globals import Globals
 from bigtree.binarytree.binarytree import BinaryTree
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag
 from bigtree.dag.dag import DAG
 from bigtree.dag.export import dag_to_dataframe, dag_to_dict, dag_to_dot, dag_to_list
 from bigtree.dag.parsing import get_path_dag
-from bigtree.globals import ASSERTIONS
 from bigtree.node.basenode import BaseNode
 from bigtree.node.binarynode import BinaryNode
 from bigtree.node.dagnode import DAGNode

bigtree/_globals.py

@@ -0,0 +1,5 @@
+import os
+
+
+class Globals:
+ ASSERTIONS: bool = bool(os.environ.get("BIGTREE_CONF_ASSERTIONS", True))

bigtree/globals.py

@@ -4,7 +4,7 @@
 import heapq
 from typing import Any, Generator, Iterable, Mapping, TypeVar
 
-from bigtree.globals import ASSERTIONS
+from bigtree._globals import Globals
 from bigtree.utils import exceptions, iterators
 
 try:
@@ -192,7 +192,7 @@ def parent(self: T, new_parent: T) -> None:
  Args:
  new_parent: parent node
  """
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_parent_type(new_parent)
  self.__check_parent_loop(new_parent)
 
@@ -335,7 +335,7 @@ def children(self: T, new_children: list[T] | tuple[T] | set[T]) -> None:
  Args:
  new_children: child node
  """
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_children_type(new_children)
  self.__check_children_loop(new_children)
  new_children = list(new_children)

bigtree/node/basenode.py

@@ -2,7 +2,7 @@
 
 from typing import Any, TypeVar
 
-from bigtree.globals import ASSERTIONS
+from bigtree._globals import Globals
 from bigtree.node import node
 from bigtree.utils import exceptions
 
@@ -166,7 +166,7 @@ def parent(self: T, new_parent: T | None) -> None:
  Args:
  new_parent: parent node
  """
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_parent_type(new_parent)
  self._BaseNode__check_parent_loop(new_parent) # type: ignore
 
@@ -296,7 +296,7 @@ def children(self: T, _new_children: list[T | None]) -> None:
  """
  self._BaseNode__check_children_type(_new_children) # type: ignore
  new_children = self.__check_children_type(_new_children)
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_children_loop(new_children)
 
  current_new_children = {

bigtree/node/binarynode.py

@@ -3,7 +3,7 @@
 import copy
 from typing import Any, Generator, Iterable, Mapping, TypeVar
 
-from bigtree.globals import ASSERTIONS
+from bigtree._globals import Globals
 from bigtree.utils import exceptions, iterators
 
 
@@ -212,7 +212,7 @@ def parents(self: T, new_parents: list[T]) -> None:
  Args:
  new_parents: parent nodes
  """
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_parent_type(new_parents)
  self.__check_parent_loop(new_parents)
 
@@ -311,7 +311,7 @@ def children(self: T, new_children: Iterable[T]) -> None:
  Args:
  new_children: child node
  """
- if ASSERTIONS.FLAG:
+ if Globals.ASSERTIONS:
  self.__check_children_type(new_children)
  self.__check_children_loop(new_children)
 

bigtree/node/dagnode.py

@@ -3,7 +3,7 @@
 from collections import Counter
 from typing import Any, TypeVar
 
-from bigtree.globals import ASSERTIONS
+from bigtree._globals import Globals
 from bigtree.node import basenode
 from bigtree.utils import exceptions
 
@@ -84,7 +84,7 @@ def __init__(self, name: str, sep: str = "/", **kwargs: Any):
  self.name = name
  self._sep = sep
  super().__init__(**kwargs)
- if ASSERTIONS.FLAG and not self.node_name:
+ if Globals.ASSERTIONS and not self.node_name:
  raise exceptions.TreeError("Node must have a `name` attribute")
 
  @property
@@ -133,7 +133,7 @@ def _BaseNode__pre_assign_parent(self: T, new_parent: T) -> None:
  Args:
  new_parent: new parent to be added
  """
- if ASSERTIONS.FLAG and new_parent is not None:
+ if Globals.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
@@ -149,7 +149,7 @@ def _BaseNode__pre_assign_children(self: T, new_children: list[T]) -> None:
  Args:
  new_children: new children to be added
  """
- if ASSERTIONS.FLAG:
+ if Globals.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

bigtree/node/node.py

@@ -86,15 +86,6 @@ def register_plugins(
  for name, func in mapping.items():
  cls.register_plugin(name, func, method)
 
- def show(self, **kwargs: Any) -> None:
- self.node.show(**kwargs)
-
- def hshow(self, **kwargs: Any) -> None:
- self.node.hshow(**kwargs)
-
- def vshow(self, **kwargs: Any) -> None:
- self.node.vshow(**kwargs)
-
  @property
  def diameter(self) -> int:
  """Get diameter of tree, the length of longest path between any two nodes.
@@ -210,6 +201,12 @@ def __repr__(self) -> str:
  "add_dict_by_path": construct.add_dict_to_tree_by_path,
  "add_dict_by_name": construct.add_dict_to_tree_by_name,
  # Export methods
+ "show": export.print_tree,
+ "hshow": export.hprint_tree,
+ "vshow": export.vprint_tree,
+ "yield": export.yield_tree,
+ "hyield": export.hyield_tree,
+ "vyield": export.vyield_tree,
  "to_dataframe": export.tree_to_dataframe,
  "to_polars": export.tree_to_polars,
  "to_dict": export.tree_to_dict,

bigtree/tree/tree.py

@@ -6,7 +6,7 @@ title: Tree Construct
 
 ## Tree Construct Methods
 
-Construct Tree from list, dictionary, and pandas DataFrame.
+Construct Tree from list, dictionary, and pandas/polars DataFrame.
 
 To decide which method to use, consider your data type and data values.