volume tracker also has a thing attribute

Author: rickwierenga

pylabrobot/resources/container.py

@@ -41,7 +41,7 @@ def __init__(
     )
     self._material_z_thickness = material_z_thickness
     self.max_volume = max_volume or (size_x * size_y * size_z)
-    self.tracker = VolumeTracker(max_volume=self.max_volume)
+    self.tracker = VolumeTracker(thing=f"{self.name}_volume_tracker", max_volume=self.max_volume)
     self._compute_volume_from_height = compute_volume_from_height
     self._compute_height_from_volume = compute_height_from_volume
 

pylabrobot/resources/tip.py

@@ -23,7 +23,9 @@ class Tip:
   fitting_depth: float
 
   def __post_init__(self):
-    self.tracker = VolumeTracker(max_volume=self.maximal_volume)
+    # TODO: use the name
+    # https://github.com/PyLabRobot/pylabrobot/issues/653
+    self.tracker = VolumeTracker(thing=f"tip_tracker", max_volume=self.maximal_volume)
 
   def serialize(self) -> dict:
     return {

pylabrobot/resources/volume_tracker.py

@@ -67,15 +67,17 @@ class VolumeTracker:
 
   def __init__(
     self,
+    thing: str,
     max_volume: float,
     liquids: Optional[List[Tuple[Optional[Liquid], float]]] = None,
     pending_liquids: Optional[List[Tuple[Optional[Liquid], float]]] = None,
     liquid_history: Optional[set] = None,
   ) -> None:
     self._is_disabled = False
     self._is_cross_contamination_tracking_disabled = False
-    self.max_volume = max_volume
 
+    self.thing = thing
+    self.max_volume = max_volume
     self.liquids: List[Tuple[Optional[Liquid], float]] = liquids or []
     self.pending_liquids: List[Tuple[Optional[Liquid], float]] = pending_liquids or []
 
@@ -123,7 +125,7 @@ def remove_liquid(self, volume: float) -> List[Tuple[Optional["Liquid"], float]]
 
     if volume > self.get_used_volume():
       raise TooLittleLiquidError(
-        f"Container has too little liquid: {volume}uL > {self.get_used_volume()}uL."
+        f"Container {self.thing} has too little liquid: {volume}uL > {self.get_used_volume()}uL."
       )
 
     removed_liquids = []
@@ -149,7 +151,7 @@ def add_liquid(self, liquid: Optional["Liquid"], volume: float) -> None:
 
     if volume > self.get_free_volume():
       raise TooLittleVolumeError(
-        f"Container has too little volume: {volume}uL > {self.get_free_volume()}uL."
+        f"Container {self.thing} has too little volume: {volume}uL > {self.get_free_volume()}uL."
       )
 
     # Update the liquid history tracker if needed
@@ -203,7 +205,7 @@ def get_liquids(self, top_volume: float) -> List[Tuple[Optional[Liquid], float]]
 
   def commit(self) -> None:
     """Commit the pending operations."""
-    assert not self.is_disabled, "Volume tracker is disabled. Call `enable()`."
+    assert not self.is_disabled, f"Volume tracker {self.thing} is disabled. Call `enable()`."
 
     self.liquids = copy.deepcopy(self.pending_liquids)