plexus-python-common 1.1.83__tar.gz → 1.1.84__tar.gz

{plexus_python_common-1.1.83 → plexus_python_common-1.1.84}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.1.83
+Version: 1.1.84
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13

{plexus_python_common-1.1.83 → plexus_python_common-1.1.84}/src/plexus/common/utils/iterutils.py

@@ -557,9 +557,9 @@ 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.
+    :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:
@@ -573,9 +573,9 @@ def dicttree_subtree[K, V](tree: dicttree[K, V], path: list[K]) -> dicttree[K, V
     """
     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.
+    :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:
@@ -588,9 +588,9 @@ def dicttree_children[K, V](tree: dicttree[K, V], *, leaves_only: bool = False)
     """
     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.
+    :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):
@@ -602,9 +602,9 @@ def dicttree_lineage[K, V](tree: dicttree[K, V], path: list[K]) -> Generator[V,
     """
     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.
+    :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:
@@ -618,9 +618,9 @@ 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.
+    :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, {}))
@@ -640,12 +640,12 @@ def dicttree_add[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.
+    :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")
@@ -673,10 +673,10 @@ def dicttree_remove[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.
+    :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")
@@ -695,8 +695,8 @@ 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.
+    :param tree: The dicttree to purge.
+    :return: The purged dicttree.
     """
     for key in list(tree.keys()):
         value, subtree = tree[key]

{plexus_python_common-1.1.83 → plexus_python_common-1.1.84}/src/plexus_python_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.1.83
+Version: 1.1.84
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13