Upgrade Python min version to >=3.10 (#403)

* feat: nested_key_dict to tree to support child_key=None * feat: tree to nested_key_dict to support child_key=None * feat: use ruff in precommit, remove black flake8 isort * fix: use | instead of Union * fix: use | instead of Optional * fix: use | instead of Optional * fix: redundant ruff * fix: add black * fix: add flake8 and isort * feat: upgrade type annotation to Python 3.10

Author: kayjan

.pre-commit-config.yaml

@@ -14,6 +14,11 @@ repos:
  rev: v3.18.3
  hooks:
  - id: commitizen
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.13.0
+ hooks:
+ - id: ruff
+ args: [--fix]
  - repo: https://github.com/pycqa/isort
  rev: 5.13.2
  hooks:

CHANGELOG.md

@@ -5,6 +5,7 @@ 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]
+- General: Switch to use Python 3.10 conventions.
 
 ## [0.31.0] - 2025-09-11
 ### Changed:

bigtree/binarytree/construct.py

@@ -1,4 +1,4 @@
-from typing import Sequence, Type, TypeVar
+from typing import Sequence, TypeVar
 
 from bigtree.node import binarynode
 from bigtree.utils import assertions
@@ -10,7 +10,7 @@
 
 def list_to_binarytree(
  heapq_list: Sequence[int],
- node_type: Type[T] = binarynode.BinaryNode, # type: ignore[assignment]
+ node_type: type[T] = binarynode.BinaryNode, # type: ignore[assignment]
 ) -> T:
  """Construct tree from a list of numbers (int or float) in heapq format.
 

bigtree/dag/construct.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Collection, Dict, List, Mapping, Optional, Tuple, Type, TypeVar
+from typing import Any, Collection, Mapping, TypeVar
 
 from bigtree.node import dagnode
 from bigtree.utils import assertions, common, exceptions
@@ -18,8 +18,8 @@
 
 
 def list_to_dag(
- relations: Collection[Tuple[str, str]],
- node_type: Type[T] = dagnode.DAGNode, # type: ignore[assignment]
+ relations: Collection[tuple[str, str]],
+ node_type: type[T] = dagnode.DAGNode, # type: ignore[assignment]
 ) -> T:
  """Construct DAG from list of tuples containing parent-child names. Note that node names must be unique.
 
@@ -39,7 +39,7 @@ def list_to_dag(
  """
  assertions.assert_length_not_empty(relations, "Input list", "relations")
 
- node_dict: Dict[str, T] = dict()
+ node_dict: dict[str, T] = dict()
  parent_name: str = ""
 
  for parent_name, child_name in relations:
@@ -53,7 +53,7 @@ def list_to_dag(
 def dict_to_dag(
  relation_attrs: Mapping[str, Any],
  parent_key: str = "parents",
- node_type: Type[T] = dagnode.DAGNode, # type: ignore[assignment]
+ node_type: type[T] = dagnode.DAGNode, # type: ignore[assignment]
 ) -> T:
  """Construct DAG from nested dictionary, ``key``: child name, ``value``: dictionary of parent names and attributes.
  Note that node names must be unique.
@@ -82,8 +82,8 @@ def dict_to_dag(
  """
  assertions.assert_length_not_empty(relation_attrs, "Dictionary", "relation_attrs")
 
- node_dict: Dict[str, T] = dict()
- _parent_name: Optional[str] = None
+ node_dict: dict[str, T] = dict()
+ _parent_name: str | None = None
 
  for child_name, node_attrs in relation_attrs.items():
  node_attrs = node_attrs.copy()
@@ -109,10 +109,10 @@ def dict_to_dag(
 @exceptions.optional_dependencies_pandas
 def dataframe_to_dag(
  data: pd.DataFrame,
- child_col: Optional[str] = None,
- parent_col: Optional[str] = None,
- attribute_cols: Optional[List[str]] = None,
- node_type: Type[T] = dagnode.DAGNode, # type: ignore[assignment]
+ child_col: str | None = None,
+ parent_col: str | None = None,
+ attribute_cols: list[str] | None = None,
+ node_type: type[T] = dagnode.DAGNode, # type: ignore[assignment]
 ) -> T:
  """Construct DAG from pandas DataFrame. Note that node names must be unique.
 
@@ -178,8 +178,8 @@ def dataframe_to_dag(
  if sum(data[child_col].isnull()):
  raise ValueError(f"Child name cannot be empty, check column: {child_col}")
 
- node_dict: Dict[str, T] = dict()
- _parent_name: Optional[str] = None
+ node_dict: dict[str, T] = dict()
+ _parent_name: str | None = None
 
  for row in data.reset_index(drop=True).to_dict(orient="index").values():
  child_name = row[child_col]

bigtree/dag/export.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Dict, List, Mapping, Optional, Tuple, TypeVar, Union
+from typing import Any, Mapping, TypeVar
 
 from bigtree.node import dagnode
 from bigtree.utils import assertions, common, exceptions, iterators
@@ -27,7 +27,7 @@
 
 def dag_to_list(
  dag: T,
-) -> List[Tuple[str, str]]:
+) -> list[tuple[str, str]]:
  """Export DAG to list of tuples containing parent-child names.
 
  Examples:
@@ -55,9 +55,9 @@ def dag_to_list(
 def dag_to_dict(
  dag: T,
  parent_key: str = "parents",
- attr_dict: Optional[Mapping[str, str]] = None,
+ attr_dict: Mapping[str, str] | None = None,
  all_attrs: bool = False,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
  """Export DAG to dictionary. Exported dictionary will have key as child name, and values as a dictionary of parent
  names and node attributes.
 
@@ -106,7 +106,7 @@ def dag_to_dataframe(
  dag: T,
  name_col: str = "name",
  parent_col: str = "parent",
- attr_dict: Optional[Mapping[str, str]] = None,
+ attr_dict: Mapping[str, str] | None = None,
  all_attrs: bool = False,
 ) -> pd.DataFrame:
  """Export DAG to pandas DataFrame.
@@ -139,7 +139,7 @@ def dag_to_dataframe(
  pandas DataFrame of DAG information
  """
  dag = dag.copy()
- data_list: List[Dict[str, Any]] = []
+ data_list: list[dict[str, Any]] = []
 
  for parent_node, child_node in iterators.dag_iterator(dag):
  if parent_node.is_root:
@@ -165,14 +165,14 @@ def dag_to_dataframe(
 
 @exceptions.optional_dependencies_image("pydot")
 def dag_to_dot(
- dag: Union[T, List[T]],
+ dag: T | list[T],
  rankdir: str = "TB",
- bg_colour: Optional[str] = None,
- node_colour: Optional[str] = None,
- node_shape: Optional[str] = None,
- edge_colour: Optional[str] = None,
- node_attr: Optional[str] = None,
- edge_attr: Optional[str] = None,
+ bg_colour: str | None = None,
+ node_colour: str | None = None,
+ node_shape: str | None = None,
+ edge_colour: str | None = None,
+ node_attr: str | None = None,
+ edge_attr: str | None = None,
 ) -> pydot.Dot:
  r"""Export DAG or list of DAGs to image. Note that node names must be unique. Possible node attributes include style,
  fillcolor, or shape.

bigtree/dag/parsing.py

@@ -1,4 +1,4 @@
-from typing import List, Optional, TypeVar
+from typing import TypeVar
 
 from bigtree.node import dagnode
 from bigtree.utils import exceptions
@@ -10,7 +10,7 @@
 T = TypeVar("T", bound=dagnode.DAGNode)
 
 
-def get_path_dag(from_node: T, to_node: T) -> List[List[T]]:
+def get_path_dag(from_node: T, to_node: T) -> list[list[T]]:
  """Get path from origin node to destination node. Path is inclusive of origin and destination nodes.
 
  Examples:
@@ -52,9 +52,9 @@ def get_path_dag(from_node: T, to_node: T) -> List[List[T]]:
  if to_node not in from_node.descendants:
  raise exceptions.TreeError(f"It is not possible to go to {to_node}")
 
- paths: List[List[T]] = []
+ paths: list[list[T]] = []
 
- def _recursive_path(_node: T, _path: List[T]) -> Optional[List[T]]:
+ def _recursive_path(_node: T, _path: list[T]) -> list[T] | None:
  """Get path to specified node.
 
  Args:

bigtree/node/basenode.py

@@ -2,17 +2,7 @@
 
 import copy
 import heapq
-from typing import (
- Any,
- Generator,
- Iterable,
- List,
- Mapping,
- Optional,
- Set,
- Tuple,
- TypeVar,
-)
+from typing import Any, Generator, Iterable, Mapping, TypeVar
 
 from bigtree.globals import ASSERTIONS
 from bigtree.utils import exceptions, iterators
@@ -126,7 +116,7 @@ class BaseNode:
  3. ``set_attrs(attrs: dict)``: Set node attribute name(s) and value(s)
  4. ``go_to(node: Self)``: Get a path from own node to another node from same tree
  5. ``append(node: Self)``: Add child to node
- 6. ``extend(nodes: List[Self])``: Add multiple children to node
+ 6. ``extend(nodes: list[Self])``: Add multiple children to node
  7. ``copy()``: Deep copy self
  8. ``sort()``: Sort child nodes
  9. ``plot()``: Plot tree in line form
@@ -138,12 +128,12 @@ class BaseNode:
 
  def __init__(
  self,
- parent: Optional[T] = None,
- children: Optional[List[T]] = None,
+ parent: T | None = None,
+ children: list[T] | None = None,
  **kwargs: Any,
  ):
- self.__parent: Optional[T] = None
- self.__children: List[T] = []
+ self.__parent: T | None = None
+ self.__children: list[T] = []
  if children is None:
  children = []
  self.parent = parent
@@ -187,7 +177,7 @@ def __check_parent_loop(self, new_parent: T) -> None:
  )
 
  @property
- def parent(self: T) -> Optional[T]:
+ def parent(self: T) -> T | None:
  """Get parent node.
 
  Returns:
@@ -330,7 +320,7 @@ def __check_children_loop(self: T, new_children: Iterable[T]) -> None:
  seen_children.append(id(new_child))
 
  @property
- def children(self: T) -> Tuple[T, ...]:
+ def children(self: T) -> tuple[T, ...]:
  """Get child nodes.
 
  Returns:
@@ -339,7 +329,7 @@ def children(self: T) -> Tuple[T, ...]:
  return tuple(self.__children)
 
  @children.setter
- def children(self: T, new_children: List[T] | Tuple[T] | Set[T]) -> None:
+ def children(self: T, new_children: list[T] | tuple[T] | set[T]) -> None:
  """Set child nodes.
 
  Args:
@@ -457,7 +447,7 @@ def siblings(self: T) -> Iterable[T]:
  return tuple(child for child in self.parent.children if child is not self)
 
  @property
- def left_sibling(self: T) -> Optional[T]:
+ def left_sibling(self: T) -> T | None:
  """Get sibling left of self.
 
  Returns:
@@ -470,7 +460,7 @@ def left_sibling(self: T) -> Optional[T]:
  return self.parent.children[child_idx - 1]
 
  @property
- def right_sibling(self: T) -> Optional[T]:
+ def right_sibling(self: T) -> T | None:
  """Get sibling right of self.
 
  Returns:
@@ -594,7 +584,7 @@ def from_dict(cls, input_dict: Mapping[str, Any]) -> BaseNode:
 
  def describe(
  self, exclude_attributes: Iterable[str] = (), exclude_prefix: str = ""
- ) -> List[Tuple[str, Any]]:
+ ) -> list[tuple[str, Any]]:
  """Get node information sorted by attribute name, returns list of tuples.
 
  Examples:
@@ -679,7 +669,7 @@ def append(self: T, other: T) -> T:
  other.parent = self
  return self
 
- def extend(self: T, others: List[T]) -> T:
+ def extend(self: T, others: list[T]) -> T:
  """Add others as children of self. Can be chained.
 
  Args:
@@ -743,7 +733,7 @@ def plot(self, *args: Any, **kwargs: Any) -> plt.Figure:
  reingold_tilford(self)
  return plot_tree(self, *args, **kwargs)
 
- def query(self, query: str, debug: bool = False) -> List[T]:
+ def query(self, query: str, debug: bool = False) -> list[T]:
  """Query tree using Tree Definition Language.
 
  Examples: