opentrons 8.0.0a2__py2.py3-none-any.whl → 8.0.0a3__py2.py3-none-any.whl

opentrons/protocol_api/instrument_context.py

@@ -2064,6 +2064,8 @@ class InstrumentContext(publisher.CommandPublisher):
             NozzleLayout.QUADRANT,
         ]
         if style in disabled_layouts:
+            # todo(mm, 2024-08-20): UnsupportedAPIError boils down to an API_REMOVED
+            # error code, which is not correct here.
             raise UnsupportedAPIError(
                 message=f"Nozzle layout configuration of style {style.value} is currently unsupported."
             )
@@ -2074,7 +2076,11 @@ class InstrumentContext(publisher.CommandPublisher):
             < _PARTIAL_NOZZLE_CONFIGURATION_SINGLE_ROW_PARTIAL_COLUMN_ADDED_IN
         ) and (style not in original_enabled_layouts):
             raise APIVersionError(
-                f"Nozzle layout configuration of style {style.value} is unsupported in API Versions lower than {_PARTIAL_NOZZLE_CONFIGURATION_SINGLE_ROW_PARTIAL_COLUMN_ADDED_IN}."
+                api_element=f"Nozzle layout configuration of style {style.value}",
+                until_version=str(
+                    _PARTIAL_NOZZLE_CONFIGURATION_SINGLE_ROW_PARTIAL_COLUMN_ADDED_IN
+                ),
+                current_version=str(self._api_version),
             )
 
         front_right_resolved = front_right

opentrons/protocol_api/labware.py

@@ -581,7 +581,7 @@ class Labware:
                 api_element="Labware.set_calibration()",
                 since_version=f"{ENGINE_CORE_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" Try using the Opentrons App's Labware Position Check.",
+                extra_message="Try using the Opentrons App's Labware Position Check.",
             )
         self._core.set_calibration(delta)
 
@@ -632,7 +632,7 @@ class Labware:
                 api_element="Labware.set_offset()",
                 until_version=f"{SET_OFFSET_RESTORED_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" This feature not available in versions 2.14 thorugh 2.17. You can also use the Opentrons App's Labware Position Check.",
+                extra_message="This feature not available in versions 2.14 thorugh 2.17. You can also use the Opentrons App's Labware Position Check.",
             )
         else:
             self._core.set_calibration(Point(x=x, y=y, z=z))
@@ -974,7 +974,7 @@ class Labware:
                 api_element="Labware.use_tips",
                 since_version=f"{ENGINE_CORE_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" To modify tip state, use Labware.reset.",
+                extra_message="To modify tip state, use Labware.reset.",
             )
 
         assert num_channels > 0, "Bad call to use_tips: num_channels<=0"
@@ -1064,7 +1064,7 @@ class Labware:
                 api_element="Labware.return_tips()",
                 since_version=f"{ENGINE_CORE_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" Use Labware.reset() instead.",
+                extra_message="Use Labware.reset() instead.",
             )
 
         # This logic is the inverse of :py:meth:`use_tips`

opentrons/protocol_api/module_contexts.py

@@ -103,7 +103,7 @@ class ModuleContext(CommandPublisher):
             raise UnsupportedAPIError(
                 api_element="`ModuleContext.load_labware_object`",
                 since_version="2.14",
-                message=" Use `ModuleContext.load_labware` or `load_labware_by_definition` instead.",
+                extra_message="Use `ModuleContext.load_labware` or `load_labware_by_definition` instead.",
             )
 
         _log.warning(
@@ -305,7 +305,7 @@ class ModuleContext(CommandPublisher):
         raise UnsupportedAPIError(
             api_element="`ModuleContext.geometry`",
             since_version="2.14",
-            message=" Use properties of the `ModuleContext` itself.",
+            extra_message="Use properties of the `ModuleContext` itself.",
         )
 
     def __repr__(self) -> str:
@@ -482,7 +482,7 @@ class MagneticModuleContext(ModuleContext):
                     api_element="The height parameter of MagneticModuleContext.engage()",
                     since_version=f"{_MAGNETIC_MODULE_HEIGHT_PARAM_REMOVED_IN}",
                     current_version=f"{self._api_version}",
-                    message=" Use offset or height_from_base.",
+                    extra_message="Use offset or height_from_base.",
                 )
             self._core.engage(height_from_home=height)
 

opentrons/protocol_api/protocol_context.py

@@ -279,7 +279,7 @@ class ProtocolContext(CommandPublisher):
                 api_element="ProtocolContext.max_speeds",
                 since_version=f"{ENGINE_CORE_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" Set speeds using InstrumentContext.default_speed or the per-method 'speed' argument.",
+                extra_message="Set speeds using InstrumentContext.default_speed or the per-method 'speed' argument.",
             )
 
         return self._core.get_max_speeds()
@@ -1048,7 +1048,7 @@ class ProtocolContext(CommandPublisher):
                 api_element="A Python Protocol safely resuming itself after a pause",
                 since_version=f"{ENGINE_CORE_API_VERSION}",
                 current_version=f"{self._api_version}",
-                message=" To wait automatically for a period of time, use ProtocolContext.delay().",
+                extra_message="To wait automatically for a period of time, use ProtocolContext.delay().",
             )
 
         # TODO(mc, 2023-02-13): this assert should be enough for mypy
@@ -1169,7 +1169,7 @@ class ProtocolContext(CommandPublisher):
                     api_element="Fixed Trash",
                     since_version="2.16",
                     current_version=f"{self._api_version}",
-                    message=" Fixed trash is no longer supported on Flex protocols.",
+                    extra_message="Fixed trash is no longer supported on Flex protocols.",
                 )
             disposal_locations = self._core.get_disposal_locations()
             if len(disposal_locations) == 0:
@@ -1242,7 +1242,7 @@ class ProtocolContext(CommandPublisher):
                     api_element="Calling `define_liquid()` without a `description`",
                     current_version=str(self._api_version),
                     until_version=str(desc_and_display_color_omittable_since),
-                    message="Use a newer API version or explicitly supply `description=None`.",
+                    extra_message="Use a newer API version or explicitly supply `description=None`.",
                 )
             else:
                 description = None
@@ -1252,7 +1252,7 @@ class ProtocolContext(CommandPublisher):
                     api_element="Calling `define_liquid()` without a `display_color`",
                     current_version=str(self._api_version),
                     until_version=str(desc_and_display_color_omittable_since),
-                    message="Use a newer API version or explicitly supply `display_color=None`.",
+                    extra_message="Use a newer API version or explicitly supply `display_color=None`.",
                 )
             else:
                 display_color = None

opentrons/protocol_api/validation.py

@@ -208,7 +208,7 @@ def ensure_and_convert_deck_slot(
                 api_element=f"Specifying a deck slot like '{deck_slot}'",
                 until_version=f"{_COORDINATE_DECK_LABEL_VERSION_GATE}",
                 current_version=f"{api_version}",
-                message=f"Increase your protocol's apiLevel, or use slot '{alternative}' instead.",
+                extra_message=f"Increase your protocol's apiLevel, or use slot '{alternative}' instead.",
             )
 
         return parsed_slot.to_equivalent_for_robot_type(robot_type)

opentrons/protocols/parameters/csv_parameter_interface.py

@@ -16,7 +16,10 @@ class CSVParameter:
 
     @property
     def file(self) -> TextIO:
-        """Returns the file handler for the CSV file."""
+        """Returns the file handler for the CSV file.
+
+        The file is treated as read-only, UTF-8-encoded text.
+        """
         if self._file is None:
             text = self.contents
             temporary_file = NamedTemporaryFile("r+")
@@ -30,7 +33,7 @@ class CSVParameter:
 
     @property
     def file_opened(self) -> bool:
-        """Return if a file handler has been opened for the CSV parameter."""
+        """Returns ``True`` if a file handler is open for the CSV parameter."""
         return self._file is not None
 
     @property
@@ -45,10 +48,22 @@ class CSVParameter:
     def parse_as_csv(
         self, detect_dialect: bool = True, **kwargs: Any
     ) -> List[List[str]]:
-        """Returns a list of rows with each row represented as a list of column elements.
+        """Parses the CSV data and returns a list of lists.
+
+        Each item in the parent list corresponds to a row in the CSV file.
+        If the CSV has a header, that will be the first row in the list: ``.parse_as_csv()[0]``.
+
+        Each item in the child lists corresponds to a single cell within its row.
+        The data for each cell is represented as a string. You may need to trim whitespace
+        or otherwise validate string contents before passing them as inputs to other API methods.
+        For numeric data, cast these strings to integers or floating point numbers,
+        as appropriate.
 
-        If there is a header for the CSV that will be the first row in the list (i.e. `.rows()[0]`).
-        All elements will be represented as strings, even if they are numeric in nature.
+        :param detect_dialect: If ``True``, examine the file and try to assign it a
+            :py:class:`csv.Dialect` to improve parsing behavior.
+        :param kwargs: For advanced CSV handling, you can pass any of the
+            `formatting parameters <https://docs.python.org/3/library/csv.html#csv-fmt-params>`_
+            accepted by :py:func:`csv.reader` from the Python standard library.
         """
         rows: List[List[str]] = []
         if detect_dialect:

{opentrons-8.0.0a2.dist-info → opentrons-8.0.0a3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentrons
-Version: 8.0.0a2
+Version: 8.0.0a3
 Summary: The Opentrons API is a simple framework designed to make writing automated biology lab protocols easy.
 Author: Opentrons
 Author-email: engineering@opentrons.com
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.10
 License-File: ../LICENSE
-Requires-Dist: opentrons-shared-data ==8.0.0a2
+Requires-Dist: opentrons-shared-data ==8.0.0a3
 Requires-Dist: aionotify ==0.3.1
 Requires-Dist: anyio <4.0.0,>=3.6.1
 Requires-Dist: jsonschema <4.18.0,>=3.0.1
@@ -33,9 +33,9 @@ Requires-Dist: click <9,>=8.0.0
 Requires-Dist: packaging >=21.0
 Requires-Dist: importlib-metadata >=1.0 ; python_version < "3.8"
 Provides-Extra: flex-hardware
-Requires-Dist: opentrons-hardware[flex] ==8.0.0a2 ; extra == 'flex-hardware'
+Requires-Dist: opentrons-hardware[flex] ==8.0.0a3 ; extra == 'flex-hardware'
 Provides-Extra: ot2-hardware
-Requires-Dist: opentrons-hardware ==8.0.0a2 ; extra == 'ot2-hardware'
+Requires-Dist: opentrons-hardware ==8.0.0a3 ; extra == 'ot2-hardware'
 
 .. _Full API Documentation: http://docs.opentrons.com
 

{opentrons-8.0.0a2.dist-info → opentrons-8.0.0a3.dist-info}/RECORD

@@ -219,13 +219,13 @@ opentrons/protocol_api/config.py,sha256=r9lyvXjagTX_g3q5FGURPpcz2IA9sSF7Oa_1mKx-
 opentrons/protocol_api/create_protocol_context.py,sha256=wwsZje0L__oDnu1Yrihau320_f-ASloR9eL1QCtkOh8,7612
 opentrons/protocol_api/deck.py,sha256=94vFceg1SC1bAGd7TvC1ZpYwnJR-VlzurEZ6jkacYeg,8910
 opentrons/protocol_api/disposal_locations.py,sha256=NRiSGmDR0LnbyEkWSOM-o64uR2fUoB1NWJG7Y7SsJSs,7920
-opentrons/protocol_api/instrument_context.py,sha256=5xlOZ_3nuONDir7CpkDE3NoT_Hhnqw-rVd73Orc_NUk,95613
-opentrons/protocol_api/labware.py,sha256=AIapWimuZMOjeX-9PeOCskD99W-oPbFHSvI7yjZSxks,47703
-opentrons/protocol_api/module_contexts.py,sha256=NJTDW0Jj9bZnCwyGPkNvhJsi-DPJKGYBMFeW92eagqI,37310
+opentrons/protocol_api/instrument_context.py,sha256=Viq1EpJ67IiOXXNKigx4iTW1xtDfx3yQ5PHdy3StzcQ,95849
+opentrons/protocol_api/labware.py,sha256=cxJp5wWMv-OKLmryEXwPgFL6T6pu8T7SXYlGWaVmB-g,47723
+opentrons/protocol_api/module_contexts.py,sha256=4uXWnO-w4Znbz27Y8m0uMJ_CR0U3Qy1r1ODntFbYMd0,37325
 opentrons/protocol_api/module_validation_and_errors.py,sha256=XL_m72P8rcvGO2fynY7UzXLcpGuI6X4s0V6Xf735Iyc,1464
-opentrons/protocol_api/protocol_context.py,sha256=1IsrVBsPAwif1BnMBjqucq7D_9m0nnXv8zVkaECXLAM,53575
+opentrons/protocol_api/protocol_context.py,sha256=SxqZ_vRTPxmceJdYXpI_e2VfWJm_atoCjM1I1UPBMB0,53602
 opentrons/protocol_api/robot_context.py,sha256=vph_ZqfdmREOwLwpjSkXiSZSpI1HO0HuilhqjhgT7Rw,2660
-opentrons/protocol_api/validation.py,sha256=tjxNkrvm-1mzGZoiduZEsT99xb_Nkfhd4YMVjehUPGg,18367
+opentrons/protocol_api/validation.py,sha256=p9kwYn340lIGHJ88q7L3RsfEgr25Nv1uTMuw4yly7T0,18373
 opentrons/protocol_api/core/__init__.py,sha256=-g74o8OtBB0LmmOvwkRvPgrHt7fF7T8FRHDj-x_-Onk,736
 opentrons/protocol_api/core/common.py,sha256=sXWlP8F4ZAEGcDh1WuavrVxkoi-FultBbpY6JW0_9ZY,1029
 opentrons/protocol_api/core/core_map.py,sha256=gq3CIYPxuPvozf8yj8FprqBfs3e4ZJGQ6s0ViPbwV08,1757
@@ -472,7 +472,7 @@ opentrons/protocols/models/__init__.py,sha256=KePRAkkKzFoc0lAz8y89cWnxru8ofe3mow
 opentrons/protocols/models/json_protocol.py,sha256=lteWlIBXgRM86k-wO1dKsx02G2_4kustSDeSoyc5N5U,20128
 opentrons/protocols/parameters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opentrons/protocols/parameters/csv_parameter_definition.py,sha256=xZhGtdfH2vXSWFK-aGET07_L0LODvHWkfNxf7pQoOmo,2762
-opentrons/protocols/parameters/csv_parameter_interface.py,sha256=Lyul1x93_MDcxloZubC60QVbsG_DI62j3zfO92h6zbc,2877
+opentrons/protocols/parameters/csv_parameter_interface.py,sha256=XxQCcNgrtpvZR451nbnlCaQnlgZj_uNkwGIxnK9rk9Q,3684
 opentrons/protocols/parameters/exceptions.py,sha256=vQUeyy8Yk_fzP4bvT0r_zu3s7Aty3LM7PzTV6k2iXu0,1092
 opentrons/protocols/parameters/parameter_definition.py,sha256=OMtUCPKyFx5ZH3Jfcw05aF8pptWQ7XYzYttGMuSPu9k,9529
 opentrons/protocols/parameters/types.py,sha256=h7vaNmKbDHc1q_FzbZoIgoSVo0mvS64FeiLZDnv7xnQ,489
@@ -499,9 +499,9 @@ opentrons/util/helpers.py,sha256=3hr801bWGbxEcOFAS7f-iOhmnUhoK5qahbB8SIvaCfY,165
 opentrons/util/linal.py,sha256=IlKAP9HkNBBgULeSf4YVwSKHdx9jnCjSr7nvDvlRALg,5753
 opentrons/util/logging_config.py,sha256=g3TdzDKa1pL_N3eKhRYCdqPaZYe_hpLV-e8llObTcT4,5657
 opentrons/util/performance_helpers.py,sha256=ew7H8XD20iS6-2TJAzbQeyzStZkkE6PzHt_Adx3wbZQ,5172
-opentrons-8.0.0a2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-opentrons-8.0.0a2.dist-info/METADATA,sha256=8wPRIDTW_pRuroKtVwOpcrbZxYyac3qMDdYWqW6H8Kk,4990
-opentrons-8.0.0a2.dist-info/WHEEL,sha256=_4XEmVmaBFWtekSGrbfOGNjC2I5lUr0lZSRblBllIFA,109
-opentrons-8.0.0a2.dist-info/entry_points.txt,sha256=fTa6eGCYkvOtv0ov-KVE8LLGetgb35LQLF9x85OWPVw,106
-opentrons-8.0.0a2.dist-info/top_level.txt,sha256=wk6whpbMZdBQpcK0Fg0YVfUGrAgVOFON7oQAhOMGMW8,10
-opentrons-8.0.0a2.dist-info/RECORD,,
+opentrons-8.0.0a3.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+opentrons-8.0.0a3.dist-info/METADATA,sha256=VCwClY3mFwancF9yu2AwyRWSS9pET6Wk42H8mMVPPZA,4990
+opentrons-8.0.0a3.dist-info/WHEEL,sha256=_4XEmVmaBFWtekSGrbfOGNjC2I5lUr0lZSRblBllIFA,109
+opentrons-8.0.0a3.dist-info/entry_points.txt,sha256=fTa6eGCYkvOtv0ov-KVE8LLGetgb35LQLF9x85OWPVw,106
+opentrons-8.0.0a3.dist-info/top_level.txt,sha256=wk6whpbMZdBQpcK0Fg0YVfUGrAgVOFON7oQAhOMGMW8,10
+opentrons-8.0.0a3.dist-info/RECORD,,