location of child resources is optional (#336)

Author: rickwierenga

CHANGELOG.md

@@ -57,6 +57,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
   - resource_offset -> pickup_offset
   - get_direction -> pickup_direction
   - put_direction -> drop_direction
+- `location` parameter of `assign_child_resource` is not optional (https://github.com/PyLabRobot/pylabrobot/pull/336)
 
 ### Added
 

pylabrobot/liquid_handling/liquid_handler.py

@@ -2172,7 +2172,7 @@ async def move_channel_z(self, channel: int, z: float):
   def assign_child_resource(
     self,
     resource: Resource,
-    location: Coordinate,
+    location: Optional[Coordinate],
     reassign: bool = True,
   ):
     """Not implement on LiquidHandler, since the deck is managed by the :attr:`deck` attribute."""

pylabrobot/resources/carrier.py

@@ -55,7 +55,7 @@ def capacity(self):
   def assign_child_resource(
     self,
     resource: Resource,
-    location: Coordinate,
+    location: Optional[Coordinate],
     reassign: bool = True,
     spot: Optional[int] = None,
   ):

pylabrobot/resources/opentrons/deck.py

@@ -75,7 +75,7 @@ def _assign_trash(self):
   def assign_child_resource(
     self,
     resource: Resource,
-    location: Coordinate,
+    location: Optional[Coordinate],
     reassign: bool = True,
   ):
     """Assign a resource to a slot.
@@ -84,6 +84,9 @@ def assign_child_resource(
     :meth:`assign_child_at_slot` instead.
     """
 
+    if location is None:
+      raise ValueError("location must be provided for resources on the deck")
+
     if location not in self.slot_locations:
       super().assign_child_resource(resource, location=location)
     else:

pylabrobot/resources/petri_dish.py

@@ -71,7 +71,7 @@ def __init__(
   def assign_child_resource(
     self,
     resource: Resource,
-    location: Coordinate,
+    location: Optional[Coordinate],
     reassign: bool = True,
   ):
     """Can only assign a single PetriDish"""

pylabrobot/resources/resource.py

@@ -268,7 +268,7 @@ def get_absolute_size_z(self) -> float:
   def assign_child_resource(
     self,
     resource: Resource,
-    location: Coordinate,
+    location: Optional[Coordinate],
     reassign: bool = True,
   ):
     """Assign a child resource to this resource.
@@ -282,7 +282,7 @@ def assign_child_resource(
 
     Args:
       resource: The resource to assign.
-      location: The location of the resource, relative to this resource.
+      location: The location of the resource, relative to this resource. None if undefined.
       reassign: If `False`, an error will be raised if the resource to be assigned is already
         assigned to this resource. Defaults to `True`.
     """