zepben.ewb 1.0.0b2__py3-none-any.whl → 1.0.0b3__py3-none-any.whl

zepben/ewb/services/network/tracing/networktrace/actions/equipment_tree_builder.py

@@ -34,15 +34,40 @@ class EquipmentTreeBuilder(StepActionWithContextValue):
     >>>     .add_step_action(tree_builder)).run()
     """
 
-    _roots: dict[ConductingEquipment, EquipmentTreeNode] = {}
-
-    def __init__(self):
+    def __init__(self, calculate_leaves: bool = False):
         super().__init__(key=str(uuid.uuid4()))
 
+        self._roots: dict[ConductingEquipment, EquipmentTreeNode] = {}
+        self._leaves: set[EquipmentTreeNode] = set()
+
+        self._calculate_leaves = calculate_leaves
+
     @property
     def roots(self) -> Generator[TreeNode[ConductingEquipment], None, None]:
         return (r for r in self._roots.values())
 
+    def recurse_nodes(self) -> Generator[TreeNode[ConductingEquipment], None, None]:
+        """
+        Returns a generator that will yield every node in the tree structure.
+        """
+        def recurse(node: TreeNode[ConductingEquipment]):
+            yield node
+            for child in node.children:
+                yield from recurse(child)
+
+        for root in self._roots.values():
+            yield from recurse(root)
+
+    @property
+    def leaves(self) -> set[EquipmentTreeNode]:
+        """
+        Return the leaves of the tree structure.
+        Depending on how the backing trace is configured, there may be extra unexpected leaves in loops.
+        """
+        if not self._calculate_leaves:
+            raise AttributeError('leaves were not calculated, you must pass calculate_leaves=True to the EquipmentTreeBuilder when creating.')
+        return set(self._leaves)
+
     def compute_initial_value(self, item: NetworkTraceStep[Any]) -> EquipmentTreeNode:
         node = self._roots.get(item.path.to_equipment)
         if node is None:
@@ -62,10 +87,18 @@ class EquipmentTreeBuilder(StepActionWithContextValue):
         else:
             return TreeNode(next_item.path.to_equipment, current_value)
 
-    def _apply(self, item: NetworkTraceStep[Any], context: StepContext):
+    def _apply(self, _: NetworkTraceStep[Any], context: StepContext):
         current_node: TreeNode = self.get_context_value(context)
         if current_node.parent:
             current_node.parent.add_child(current_node)
 
+        if self._calculate_leaves:
+            self._process_leaf(current_node)
+
+    def _process_leaf(self, current_node: TreeNode[ConductingEquipment]):
+        self._leaves.add(current_node) # add this node to _leaves as it has no children
+        if current_node.parent:
+            self._leaves.discard(current_node.parent) # this nodes parent now has a child, it's not a leaf anymore
+
     def clear(self):
         self._roots.clear()

zepben/ewb/services/network/tracing/networktrace/actions/tree_node.py

@@ -5,33 +5,31 @@
 
 __all__ = ['TreeNode']
 
-from typing import List, TypeVar, Generic
-
-from zepben.ewb import IdentifiedObject
+from typing import TypeVar, Generic, Set
 
 T = TypeVar('T')
 
 
 class TreeNode(Generic[T]):
     """
-    represents a node in the NetworkTrace tree
+    Represents a node in the NetworkTrace tree
     """
 
-    def __init__(self, identified_object: IdentifiedObject, parent=None):
+    def __init__(self, identified_object: T, parent=None):
         self.identified_object = identified_object
         self._parent: TreeNode = parent
-        self._children: List[TreeNode] = []
+        self._children: Set[TreeNode] = set()
 
     @property
     def parent(self) -> 'TreeNode[T]':
         return self._parent
 
     @property
-    def children(self):
-        return list(self._children)
+    def children(self) -> Set['TreeNode[T]']:
+        return set(self._children)
 
-    def add_child(self, child: 'TreeNode'):
-        self._children.append(child)
+    def add_child(self, child: 'TreeNode[T]'):
+        self._children.add(child)
 
     def __str__(self):
         return f"{{object: {self.identified_object}, parent: {self.parent or ''}, num children: {len(self.children)}}}"

{zepben_ewb-1.0.0b2.dist-info → zepben_ewb-1.0.0b3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zepben.ewb
-Version: 1.0.0b2
+Version: 1.0.0b3
 Summary: Python SDK for interacting with the Energy Workbench platform
 Home-page: https://github.com/zepben/evolve-sdk-python
 Author: Kurt Greaves

{zepben_ewb-1.0.0b2.dist-info → zepben_ewb-1.0.0b3.dist-info}/RECORD

@@ -568,8 +568,8 @@ zepben/ewb/services/network/tracing/networktrace/network_trace_step_path_provide
 zepben/ewb/services/network/tracing/networktrace/network_trace_tracker.py,sha256=EZAwZ9aSuKrykxKCHmNQHhDE-1LjvhwT-pGy6EScv0s,1521
 zepben/ewb/services/network/tracing/networktrace/tracing.py,sha256=gsgR_wWOqcZNGbHBYg7h8aqzi2BlSF6AqBPHIYxSN-I,6836
 zepben/ewb/services/network/tracing/networktrace/actions/__init__.py,sha256=8-znO960twGtcAGArLGl_ijbCB9BBv0_hUNYf1eF0Lk,243
-zepben/ewb/services/network/tracing/networktrace/actions/equipment_tree_builder.py,sha256=h8DjbUhbi1gpC1sjRgMJ3HW2l7AzmykUzYr19v5oqqs,2780
-zepben/ewb/services/network/tracing/networktrace/actions/tree_node.py,sha256=6TrwWQGRxl_0gTjqx1S5MgZvp9YrIOG76wYXpizPWHQ,1055
+zepben/ewb/services/network/tracing/networktrace/actions/equipment_tree_builder.py,sha256=SHfcB-J28NmewfUO54-CbejCHIeGkojhw11ymxZjXAQ,4200
+zepben/ewb/services/network/tracing/networktrace/actions/tree_node.py,sha256=89sW584s6l2Slb3sBsA5MeD_n1YQPhn5-AMUConQjw8,1021
 zepben/ewb/services/network/tracing/networktrace/conditions/__init__.py,sha256=8-znO960twGtcAGArLGl_ijbCB9BBv0_hUNYf1eF0Lk,243
 zepben/ewb/services/network/tracing/networktrace/conditions/conditions.py,sha256=OkG8at-9nIqgN0cOki7kZ7EXQr1YnQEB5-FGTt7xfFk,3503
 zepben/ewb/services/network/tracing/networktrace/conditions/direction_condition.py,sha256=6OCkd3m94UJYaV-c8Bym1PnWIbB6Od7BRaWTEg9QlH8,3390
@@ -632,8 +632,8 @@ zepben/ewb/streaming/mutations/update_network_state_client.py,sha256=e0Oma5PRT8m
 zepben/ewb/streaming/mutations/update_network_state_service.py,sha256=irR-TO67QXRyBmK8PU8SzM31NKSSefZt_nQGHi5IhT8,3260
 zepben/ewb/testing/__init__.py,sha256=waADXEvfUG9wAN4STx5uIUHOv0UnpZLH2qU1LXgaDBc,243
 zepben/ewb/testing/test_network_builder.py,sha256=KG0o2ZHUswx3xClu-JnLs_pYIYbQ5jjtvtyZ7LI6IZ8,38092
-zepben_ewb-1.0.0b2.dist-info/licenses/LICENSE,sha256=aAHD66h6PQIETpkJDvg5yEObyFvXUED8u7S8dlh6K0Y,16725
-zepben_ewb-1.0.0b2.dist-info/METADATA,sha256=YuzqyRlwgQbn4imuk6DDlwx6IiFD9Ua3z0xwzxsGG_A,3451
-zepben_ewb-1.0.0b2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-zepben_ewb-1.0.0b2.dist-info/top_level.txt,sha256=eVLDJiO6FGjL_Z7KdmFE-R8uf1Q07aaVLGe9Ee4kmBw,7
-zepben_ewb-1.0.0b2.dist-info/RECORD,,
+zepben_ewb-1.0.0b3.dist-info/licenses/LICENSE,sha256=aAHD66h6PQIETpkJDvg5yEObyFvXUED8u7S8dlh6K0Y,16725
+zepben_ewb-1.0.0b3.dist-info/METADATA,sha256=aCg3N2fotPlZL3ZAAjuP4RJzBx3q27296CAYYJIWifQ,3451
+zepben_ewb-1.0.0b3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+zepben_ewb-1.0.0b3.dist-info/top_level.txt,sha256=eVLDJiO6FGjL_Z7KdmFE-R8uf1Q07aaVLGe9Ee4kmBw,7
+zepben_ewb-1.0.0b3.dist-info/RECORD,,