Skip to content

Commit 9bbcc02

Browse files
authored
chore(api): bump Python API version to 2.18 and tag new trash container methods (#14610)
# Overview It's time for Python API version 2.18! Trash container `top()` methods are the first features included in this version-in-progress. # Test Plan - [sandbox](http://sandbox.docs.opentrons.com/papi-2.18-in-edge-time/v2/new_protocol_api.html#opentrons.protocol_api.TrashBin) - automated tests # Changelog - bump max supported version - decorate trash container top methods - hide those methods from API reference, for now. they will be _shown_ in #14593 and the 2.18 docs feature branch. # Review requests sensible? correct? well-timed? # Risk assessment v low. this version bump was coming sooner or later and shouldn't affect anything up through 2.17.
1 parent a8d78a3 commit 9bbcc02

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

api/docs/v2/new_protocol_api.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ Labware
3535
signatures, since users should never construct these directly.
3636
3737
.. autoclass:: opentrons.protocol_api.TrashBin()
38-
:members:
3938

4039
.. autoclass:: opentrons.protocol_api.WasteChute()
41-
:members:
4240

4341
Wells and Liquids
4442
=================

api/src/opentrons/protocol_api/disposal_locations.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
from opentrons.types import DeckSlotName
77
from opentrons.protocols.api_support.types import APIVersion
8+
from opentrons.protocols.api_support.util import requires_version
89
from opentrons.protocol_engine.clients import SyncClient
910

1011

@@ -98,6 +99,7 @@ def __init__(
9899
else:
99100
self._cutout_fixture_name = _TRASH_BIN_CUTOUT_FIXTURE
100101

102+
@requires_version(2, 18)
101103
def top(self, x: float = 0, y: float = 0, z: float = 0) -> TrashBin:
102104
"""Add a location offset to a trash bin.
103105
@@ -174,6 +176,7 @@ def __init__(
174176
self._api_version = api_version
175177
self._offset = offset
176178

179+
@requires_version(2, 18)
177180
def top(self, x: float = 0, y: float = 0, z: float = 0) -> WasteChute:
178181
"""Add a location offset to a waste chute.
179182

api/src/opentrons/protocols/api_support/definitions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
from .types import APIVersion
22

3-
MAX_SUPPORTED_VERSION = APIVersion(2, 17)
3+
MAX_SUPPORTED_VERSION = APIVersion(2, 18)
44
"""The maximum supported protocol API version in this release."""
55

66
MIN_SUPPORTED_VERSION = APIVersion(2, 0)

0 commit comments

Comments
 (0)