Skip to content

Commit 2ece516

Browse files
authored
remove deprecated parameters from move_resource (#550)
1 parent b4a03e2 commit 2ece516

File tree

2 files changed

+10
-42
lines changed

2 files changed

+10
-42
lines changed

docs/resources/carrier/plate-carrier/plate_carrier.ipynb

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
},
2121
{
2222
"cell_type": "code",
23-
"execution_count": 3,
23+
"execution_count": 1,
2424
"metadata": {},
2525
"outputs": [],
2626
"source": [
@@ -98,7 +98,7 @@
9898
{
9999
"data": {
100100
"text/plain": [
101-
"PlateHolder(name=carrier-my_plate_carrier-spot-0, location=(004.000, 008.500, 086.150), size_x=127.0, size_y=86.0, size_z=0, category=plate_holder)"
101+
"PlateHolder(name=my_plate_carrier-0, location=Coordinate(004.000, 008.500, 086.150), size_x=127.0, size_y=86.0, size_z=0, category=plate_holder)"
102102
]
103103
},
104104
"execution_count": 5,
@@ -118,7 +118,7 @@
118118
{
119119
"data": {
120120
"text/plain": [
121-
"PlateHolder(name=carrier-my_plate_carrier-spot-0, location=(004.000, 008.500, 086.150), size_x=127.0, size_y=86.0, size_z=0, category=plate_holder)"
121+
"PlateHolder(name=my_plate_carrier-0, location=Coordinate(004.000, 008.500, 086.150), size_x=127.0, size_y=86.0, size_z=0, category=plate_holder)"
122122
]
123123
},
124124
"execution_count": 6,
@@ -145,7 +145,7 @@
145145
{
146146
"data": {
147147
"text/plain": [
148-
"Plate(name=my_plate, size_x=127.76, size_y=85.48, size_z=14.2, location=(000.000, 000.000, -03.030))"
148+
"Plate(name=my_plate, size_x=127.76, size_y=85.48, size_z=14.2, location=Coordinate(000.000, 000.000, -03.030))"
149149
]
150150
},
151151
"execution_count": 7,
@@ -202,6 +202,7 @@
202202
"Resource deck was assigned to the liquid handler.\n",
203203
"Resource trash was assigned to the liquid handler.\n",
204204
"Resource trash_core96 was assigned to the liquid handler.\n",
205+
"Resource teaching_carrier was assigned to the liquid handler.\n",
205206
"Resource my_plate_carrier was assigned to the liquid handler.\n"
206207
]
207208
}
@@ -223,7 +224,10 @@
223224
"name": "stdout",
224225
"output_type": "stream",
225226
"text": [
226-
"Moving Move(resource=Plate(name=my_plate, size_x=127.76, size_y=85.48, size_z=14.2, location=(000.000, 000.000, -03.030)), destination=PlateHolder(name=carrier-my_plate_carrier-spot-2, location=(004.000, 200.500, 086.150), size_x=127.0, size_y=86.0, size_z=0, category=plate_holder), intermediate_locations=[], resource_offset=Coordinate(x=0, y=0, z=0), destination_offset=Coordinate(x=0, y=0, z=0), pickup_distance_from_top=0, get_direction=<GripDirection.FRONT: 1>, put_direction=<GripDirection.FRONT: 1>).\n"
227+
"Picking up resource: ResourcePickup(resource=Plate(name=my_plate, size_x=127.76, size_y=85.48, size_z=14.2, location=Coordinate(000.000, 000.000, -03.030)), offset=Coordinate(x=0, y=0, z=0), pickup_distance_from_top=0, direction=<GripDirection.FRONT: 1>)\n",
228+
"Dropping resource: ResourceDrop(resource=Plate(name=my_plate, size_x=127.76, size_y=85.48, size_z=14.2, location=Coordinate(000.000, 000.000, -03.030)), destination=Coordinate(x=104.0, y=263.5, z=183.12), destination_absolute_rotation=Rotation(x=0, y=0, z=0), offset=Coordinate(x=0, y=0, z=0), pickup_distance_from_top=0, pickup_direction=<GripDirection.FRONT: 1>, drop_direction=<GripDirection.FRONT: 1>, rotation=0)\n",
229+
"Resource my_plate was unassigned from the liquid handler.\n",
230+
"Resource my_plate was assigned to the liquid handler.\n"
227231
]
228232
}
229233
],
@@ -269,7 +273,7 @@
269273
"name": "python",
270274
"nbconvert_exporter": "python",
271275
"pygments_lexer": "ipython3",
272-
"version": "3.13.0"
276+
"version": "3.10.15"
273277
}
274278
},
275279
"nbformat": 4,

pylabrobot/liquid_handling/liquid_handler.py

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1906,14 +1906,11 @@ async def move_resource(
19061906
resource: Resource,
19071907
to: Union[ResourceStack, ResourceHolder, Resource, Coordinate],
19081908
intermediate_locations: Optional[List[Coordinate]] = None,
1909-
resource_offset: Optional[Coordinate] = None,
19101909
pickup_offset: Coordinate = Coordinate.zero(),
19111910
destination_offset: Coordinate = Coordinate.zero(),
19121911
pickup_distance_from_top: float = 0,
19131912
pickup_direction: GripDirection = GripDirection.FRONT,
19141913
drop_direction: GripDirection = GripDirection.FRONT,
1915-
get_direction: Optional[GripDirection] = None,
1916-
put_direction: Optional[GripDirection] = None,
19171914
**backend_kwargs,
19181915
):
19191916
"""Move a resource to a new location.
@@ -1936,17 +1933,6 @@ async def move_resource(
19361933
drop_direction: The direction from which to put down the resource.
19371934
"""
19381935

1939-
# TODO: move conditional statements from move_plate into move_resource to enable
1940-
# movement to other types besides Coordinate
1941-
1942-
# https://github.com/PyLabRobot/pylabrobot/issues/329
1943-
if resource_offset is not None:
1944-
raise NotImplementedError("resource_offset is deprecated, use pickup_offset instead")
1945-
if get_direction is not None:
1946-
raise NotImplementedError("get_direction is deprecated, use pickup_direction instead")
1947-
if put_direction is not None:
1948-
raise NotImplementedError("put_direction is deprecated, use drop_direction instead")
1949-
19501936
extra = self._check_args(
19511937
self.backend.pick_up_resource,
19521938
backend_kwargs,
@@ -1986,13 +1972,10 @@ async def move_lid(
19861972
lid: Lid,
19871973
to: Union[Plate, ResourceStack, Coordinate],
19881974
intermediate_locations: Optional[List[Coordinate]] = None,
1989-
resource_offset: Optional[Coordinate] = None,
19901975
pickup_offset: Coordinate = Coordinate.zero(),
19911976
destination_offset: Coordinate = Coordinate.zero(),
19921977
pickup_direction: GripDirection = GripDirection.FRONT,
19931978
drop_direction: GripDirection = GripDirection.FRONT,
1994-
get_direction: Optional[GripDirection] = None,
1995-
put_direction: Optional[GripDirection] = None,
19961979
pickup_distance_from_top: float = 5.7 - 3.33,
19971980
**backend_kwargs,
19981981
):
@@ -2020,14 +2003,6 @@ async def move_lid(
20202003
ValueError: If the lid is not assigned to a resource.
20212004
"""
20222005

2023-
# https://github.com/PyLabRobot/pylabrobot/issues/329
2024-
if resource_offset is not None:
2025-
raise NotImplementedError("resource_offset is deprecated, use pickup_offset instead")
2026-
if get_direction is not None:
2027-
raise NotImplementedError("get_direction is deprecated, use pickup_direction instead")
2028-
if put_direction is not None:
2029-
raise NotImplementedError("put_direction is deprecated, use drop_direction instead")
2030-
20312006
await self.move_resource(
20322007
lid,
20332008
to=to,
@@ -2045,13 +2020,10 @@ async def move_plate(
20452020
plate: Plate,
20462021
to: Union[ResourceStack, ResourceHolder, Resource, Coordinate],
20472022
intermediate_locations: Optional[List[Coordinate]] = None,
2048-
resource_offset: Optional[Coordinate] = None,
20492023
pickup_offset: Coordinate = Coordinate.zero(),
20502024
destination_offset: Coordinate = Coordinate.zero(),
20512025
drop_direction: GripDirection = GripDirection.FRONT,
20522026
pickup_direction: GripDirection = GripDirection.FRONT,
2053-
get_direction: Optional[GripDirection] = None,
2054-
put_direction: Optional[GripDirection] = None,
20552027
pickup_distance_from_top: float = 13.2 - 3.33,
20562028
**backend_kwargs,
20572029
):
@@ -2087,14 +2059,6 @@ async def move_plate(
20872059
destination_offset: The offset from the location's origin, optional (rarely necessary).
20882060
"""
20892061

2090-
# https://github.com/PyLabRobot/pylabrobot/issues/329
2091-
if resource_offset is not None:
2092-
raise NotImplementedError("resource_offset is deprecated, use pickup_offset instead")
2093-
if get_direction is not None:
2094-
raise NotImplementedError("get_direction is deprecated, use pickup_direction instead")
2095-
if put_direction is not None:
2096-
raise NotImplementedError("put_direction is deprecated, use drop_direction instead")
2097-
20982062
await self.move_resource(
20992063
plate,
21002064
to=to,

0 commit comments

Comments
 (0)