iker-python-common 1.0.63__py3-none-any.whl → 1.0.64__py3-none-any.whl

iker/common/utils/{sequtils.py → iterutils.py}

@@ -27,6 +27,15 @@ __all__ = [
     "chunk_between",
     "chunk_with_key",
     "merge_chunks",
+    "dicttree",
+    "dicttree_value",
+    "dicttree_subtree",
+    "dicttree_children",
+    "dicttree_lineage",
+    "dicttree_make",
+    "dicttree_add",
+    "dicttree_remove",
+    "dicttree_purge",
     "Seq",
     "seq",
 ]
@@ -539,6 +548,165 @@ def merge_chunks[T](
                    chunk_between(chunks, lambda a, b: not merge_func(a, b)))
 
 
+# Dicttree, a tree structure implemented using nested dictionaries,
+# where each node can have an optional value and child nodes.
+type dicttree[K, V] = dict[K, tuple[V | None, dicttree[K, V]]]
+
+
+def dicttree_value[K, V](tree: dicttree[K, V], path: list[K]) -> V | None:
+    """
+    Gets the value stored at the specified path in the dicttree.
+
+    :param tree: the dicttree to retrieve the value from.
+    :param path: the list of keys representing the path to the desired value.
+    :return: the value at the specified path, or ``None`` if the path does not exist.
+    """
+    value = None
+    for key in path:
+        if key not in tree:
+            return None
+        value, tree = tree[key]
+    return value
+
+
+def dicttree_subtree[K, V](tree: dicttree[K, V], path: list[K]) -> dicttree[K, V] | None:
+    """
+    Gets the subtree located at the specified path in the dicttree.
+
+    :param tree: the dicttree to retrieve the subtree from.
+    :param path: the list of keys representing the path to the desired subtree.
+    :return: the subtree at the specified path, or ``None`` if the path does not exist.
+    """
+    for key in path:
+        if key not in tree:
+            return None
+        _, tree = tree[key]
+    return tree
+
+
+def dicttree_children[K, V](tree: dicttree[K, V], *, leaves_only: bool = False) -> Generator[V, None, None]:
+    """
+    Yields all values in the dicttree. If ``leaves_only`` is ``True``, only yields values at leaf nodes.
+
+    :param tree: the dicttree to traverse.
+    :param leaves_only: whether to yield only values at leaf nodes.
+    :return: a generator yielding all values in the dicttree.
+    """
+    for value, subtree in tree.values():
+        if value is not None and (not leaves_only or not subtree):
+            yield value
+        yield from dicttree_children(subtree, leaves_only=leaves_only)
+
+
+def dicttree_lineage[K, V](tree: dicttree[K, V], path: list[K]) -> Generator[V, None, None]:
+    """
+    Yields all values along the specified path in the dicttree.
+
+    :param tree: the dicttree to traverse.
+    :param path: the list of keys representing the path to follow.
+    :return: a generator yielding all values along the specified path.
+    """
+    for key in path:
+        if key not in tree:
+            return
+        value, tree = tree[key]
+        if value is not None:
+            yield value
+
+
+def dicttree_make[K, V](tree: dicttree[K, V], path: list[K]) -> dicttree[K, V]:
+    """
+    Ensures that the specified path exists in the dicttree, creating any missing nodes along the way.
+
+    :param tree: the dicttree to modify.
+    :param path: the list of keys representing the path to create.
+    :return: the subtree at the end of the created path.
+    """
+    for key in path:
+        tree.setdefault(key, (None, {}))
+        _, tree = tree[key]
+    return tree
+
+
+def dicttree_add[K, V](
+    tree: dicttree[K, V],
+    path: list[K],
+    value: V,
+    *,
+    create_prefix: bool = True,
+    overwrite: bool = False,
+) -> dicttree[K, V]:
+    """
+    Adds a value at the specified path in the dicttree. If ``create_prefix`` is ``True``, any missing nodes along the
+    path are created. If ``overwrite`` is ``False``, raises an error if the path already exists.
+
+    :param tree: the dicttree to modify.
+    :param path: the list of keys representing the path to add the value to.
+    :param value: the value to add at the specified path.
+    :param create_prefix: whether to create missing nodes along the path.
+    :param overwrite: whether to overwrite an existing value at the path.
+    :return: the modified dicttree.
+    """
+    if len(path) == 0:
+        raise ValueError("path cannot be empty")
+    *prefix, key = path
+    if create_prefix:
+        subtree = dicttree_make(tree, prefix)
+    else:
+        subtree = dicttree_subtree(tree, prefix)
+        if subtree is None:
+            raise ValueError("prefix path does not exist in dicttree")
+    if not overwrite and dicttree_value(subtree, [key]) is not None:
+        raise ValueError("path already exists in dicttree")
+    else:
+        subtree[key] = (value, dicttree_subtree(subtree, [key]) or {})
+    return tree
+
+
+def dicttree_remove[K, V](
+    tree: dicttree[K, V],
+    path: list[K],
+    *,
+    recursive: bool = False,
+) -> dicttree[K, V]:
+    """
+    Removes the value at the specified path in the dicttree. If ``recursive`` is ``True``, removes the entire subtree
+    at that path; otherwise, only removes the value, leaving any child nodes intact.
+
+    :param tree: the dicttree to modify.
+    :param path: the list of keys representing the path to remove the value from.
+    :param recursive: whether to remove the entire subtree at the path.
+    :return: the modified dicttree.
+    """
+    if len(path) == 0:
+        raise ValueError("path cannot be empty")
+    *prefix, key = path
+    subtree = dicttree_subtree(tree, prefix)
+    if subtree is None:
+        raise ValueError("prefix path does not exist in dicttree")
+    if dicttree_value(subtree, [key]) is None:
+        raise ValueError("path does not exist in dicttree")
+    else:
+        subtree[key] = (None, {} if recursive else dicttree_subtree(subtree, [key]) or {})
+    return tree
+
+
+def dicttree_purge[K, V](tree: dicttree[K, V]) -> dicttree[K, V]:
+    """
+    Recursively removes all nodes in the dicttree that have no value and no children.
+
+    :param tree: the dicttree to purge.
+    :return: the purged dicttree.
+    """
+    for key in list(tree.keys()):
+        value, subtree = tree[key]
+        dicttree_purge(subtree)
+        if subtree or value is not None:
+            continue
+        del tree[key]
+    return tree
+
+
 class Seq[T](Sequence[T], Sized):
     def __init__(self, data: Iterable[T]):
         if isinstance(data, Seq):

iker/common/utils/randutils.py

@@ -8,8 +8,8 @@ from typing import overload
 
 from iker.common.utils.dtutils import dt_utc_max, dt_utc_min
 from iker.common.utils.funcutils import memorized, singleton
+from iker.common.utils.iterutils import head_or_none
 from iker.common.utils.jsonutils import JsonType
-from iker.common.utils.sequtils import head_or_none
 
 __all__ = [
     "max_int",

iker/common/utils/shutils.py

@@ -4,7 +4,7 @@ import shutil
 from typing import Protocol
 
 from iker.common.utils import logger
-from iker.common.utils.sequtils import last, last_or_none, tail_iter
+from iker.common.utils.iterutils import last, last_or_none, tail_iter
 from iker.common.utils.strutils import is_empty
 
 __all__ = [

{iker_python_common-1.0.63.dist-info → iker_python_common-1.0.64.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iker-python-common
-Version: 1.0.63
+Version: 1.0.64
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13

{iker_python_common-1.0.63.dist-info → iker_python_common-1.0.64.dist-info}/RECORD

@@ -6,18 +6,18 @@ iker/common/utils/csv.py,sha256=_V9OUrKcojec2L-hWagEIVnL2uvGjyJAFTrD7tHNr48,7573
 iker/common/utils/dbutils.py,sha256=09DgvfPVDCPXwOAO_FTynLXhSq--ZzRz2fCQ6vJ5qqk,16151
 iker/common/utils/dtutils.py,sha256=86vbaa4pgcBWERZvTfJ92PKB3IimxP6tf0O11ho2Ffk,12554
 iker/common/utils/funcutils.py,sha256=4AkkvK9_Z2tgk1-Sp6-vLLVhI15cIgN9xW58QqL5QL4,7780
+iker/common/utils/iterutils.py,sha256=l-FqaVUiL7WVkei7hYqWJqO5Ptcwe1T5CZ6nuIVNi4w,30884
 iker/common/utils/jsonutils.py,sha256=AkziMAYVQDODHRqZC-c1x7VqI2hHY3Kxrw7gmoss8mU,18527
 iker/common/utils/logger.py,sha256=FJaai6Sbchy4wKHcUMUCrrkBcXvIxq4qByERZ_TJBps,3881
 iker/common/utils/numutils.py,sha256=p6Rz1qyCcUru3v1zDy2PM-nds2NWJdL5A_vLmG-kswk,4294
-iker/common/utils/randutils.py,sha256=Sxf852B18CJ-MfrEDsv1ROO_brmz79dRZ4jpJiH65v4,12843
+iker/common/utils/randutils.py,sha256=D9bVAeHnLNkG8aZ2piWJgixTjXe0jl-GCVe4QgeFmsk,12844
 iker/common/utils/retry.py,sha256=H9lR6pp_jzgOwKTM-dOWIddjTlQbK-ijcwuDmVvurZM,8938
-iker/common/utils/sequtils.py,sha256=Wc8RcbNjVYSJYZv_07SOKWfYjhmGWz9_RXWbG2-tE1o,25060
-iker/common/utils/shutils.py,sha256=dUm1Y7m8u1Ri_R5598oQJsxwgQaBnVzhtpcsL7_Vzp0,7916
+iker/common/utils/shutils.py,sha256=DFwWdnGdAZEuwx6GDjFzPkMtNCFURjslOFUNs9FhrpA,7917
 iker/common/utils/span.py,sha256=u_KuWi2U7QDMUotl4AeW2_57ItL3YhVDSeCwaOiFDvs,5963
 iker/common/utils/strutils.py,sha256=Tu_qFeH3K-SfwvMxdrZAc9iLPV8ZmtX4ntyyFGNslf8,5094
 iker/common/utils/testutils.py,sha256=2VieV5yeCDntSKQSpIeyqRT8BZmZYE_ArMeQz3g7fXY,5568
 iker/common/utils/typeutils.py,sha256=RVkYkFRgDrx77OHFH7PavMV0AIB0S8ly40rs4g7JWE4,8220
-iker_python_common-1.0.63.dist-info/METADATA,sha256=QUw6lKzGDZRY3Aul1qTE4B_dxtO96Tw0Mvo_acp9Ilw,867
-iker_python_common-1.0.63.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-iker_python_common-1.0.63.dist-info/top_level.txt,sha256=4_B8Prfc_lxFafFYTQThIU1ZqOYQ4pHHHnJ_fQ_oHs8,5
-iker_python_common-1.0.63.dist-info/RECORD,,
+iker_python_common-1.0.64.dist-info/METADATA,sha256=mNIZFNquL8xwu6PutfTV3WRrxBzx4-crFq6Lz7r-Kx8,867
+iker_python_common-1.0.64.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+iker_python_common-1.0.64.dist-info/top_level.txt,sha256=4_B8Prfc_lxFafFYTQThIU1ZqOYQ4pHHHnJ_fQ_oHs8,5
+iker_python_common-1.0.64.dist-info/RECORD,,