opentrons-shared-data 8.8.0a6__py3-none-any.whl → 9.0.0a2__py3-none-any.whl

opentrons_shared_data/pipette/scripts/build_json_script.py

@@ -1,31 +1,30 @@
 import argparse
 import csv
 import json
+import math
 from ast import literal_eval
-from typing import Optional, Dict, Union, Any, List
 from pathlib import Path
+from typing import Any, Dict, List, Optional, Union
+
 from pydantic import BaseModel
-import math
 
 from ... import get_shared_data_root
 from ..pipette_definition import (
+    AvailableSensorDefinition,
+    DropTipConfigurations,
+    MotorConfigurations,
+    PartialTipDefinition,
+    PickUpTipConfigurations,
     PipetteGeometryDefinition,
     PipetteLiquidPropertiesDefinition,
     PipettePhysicalPropertiesDefinition,
+    PlungerEjectDropTipConfiguration,
     PlungerPositions,
-    SupportedTipsDefinition,
-    MotorConfigurations,
-    PartialTipDefinition,
-    AvailableSensorDefinition,
-    PickUpTipConfigurations,
     PressFitPickUpTipConfiguration,
-    DropTipConfigurations,
-    PlungerEjectDropTipConfiguration,
+    SupportedTipsDefinition,
 )
-
 from ..types import PipetteModelSpec
 
-
 PIPETTE_DEFINITION_ROOT = Path("pipette") / "definitions" / "2"
 GEOMETRY_ROOT = get_shared_data_root() / PIPETTE_DEFINITION_ROOT / "geometry"
 GENERAL_ROOT = get_shared_data_root() / PIPETTE_DEFINITION_ROOT / "general"
@@ -136,7 +135,7 @@ def _build_partial_tip_configurations(channels: int) -> PartialTipDefinition:
 
 
 def build_geometry_model_v2(
-    input_dictionary: Dict[str, Any]
+    input_dictionary: Dict[str, Any],
 ) -> PipetteGeometryDefinition:
     return PipetteGeometryDefinition.model_validate(input_dictionary)
 
@@ -288,7 +287,6 @@ def migrate_new_blow_out_configs_v2() -> None:
 def fill_blowout_configs(
     pipette_gen: int, shaft_diameters: Dict[str, float], volumes: List[str]
 ) -> None:
-
     general_config_files = Path(GENERAL_ROOT).glob("*")
     for pipette_type in general_config_files:  # single, eight, 96-channel
         for volume in volumes:  # pipette max volume- p10, p20, p50, etc.

opentrons_shared_data/pipette/scripts/update_configuration_files.py

@@ -1,38 +1,36 @@
 """A script for updating pre-existing V2 Pipette configurations."""
 
-import os
-import json
 import argparse
-
+import json
+import os
+from enum import Enum
 from pathlib import Path
-from typing import List, Dict, Tuple, Any, Iterator, Type
+from typing import Any, Dict, Iterator, List, Tuple, Type
 
 from pydantic import BaseModel
 from pydantic.main import ModelMetaclass
-from enum import Enum
-
-from opentrons_shared_data import get_shared_data_root
 
+from ..load_data import _geometry, _liquid, _physical
 from ..pipette_definition import (
     PipetteConfigurations,
     PipetteGeometryDefinition,
-    PipettePhysicalPropertiesDefinition,
     PipetteLiquidPropertiesDefinition,
     PipetteModelVersionType,
+    PipettePhysicalPropertiesDefinition,
     SupportedTipsDefinition,
 )
+from ..pipette_load_name_conversions import convert_pipette_model
 from ..types import (
-    PipetteModelType,
+    LiquidClasses,
     PipetteChannelType,
-    PipetteVersionType,
-    PipetteTipType,
+    PipetteModel,
     PipetteModelMajorVersion,
     PipetteModelMinorVersion,
-    LiquidClasses,
+    PipetteModelType,
+    PipetteTipType,
+    PipetteVersionType,
 )
-from ..load_data import _geometry, _physical, _liquid
-from ..pipette_load_name_conversions import convert_pipette_model
-from ..types import PipetteModel
+from opentrons_shared_data import get_shared_data_root
 
 """
 Instructions:
@@ -166,7 +164,7 @@ def build_nozzle_map(
         return {"A1": nozzle_offset}
     elif channels == PipetteChannelType.EIGHT_CHANNEL:
         return {
-            f"{chr(ord('A') + 1*row)}1": [
+            f"{chr(ord('A') + 1 * row)}1": [
                 nozzle_offset[0],
                 nozzle_offset[1] + Y_OFFSET * row,
                 nozzle_offset[2],
@@ -175,7 +173,7 @@ def build_nozzle_map(
         }
     elif channels == PipetteChannelType.NINETY_SIX_CHANNEL:
         return {
-            f"{chr(ord('A') + 1*row)}{1 + 1*col}": [
+            f"{chr(ord('A') + 1 * row)}{1 + 1 * col}": [
                 nozzle_offset[0] + X_OFFSET * col,
                 nozzle_offset[1] + Y_OFFSET * row,
                 nozzle_offset[2],
@@ -210,7 +208,8 @@ def load_and_update_file_from_config(
                 value_to_update if value_to_update else geometry["nozzleOffset"]
             )
             geometry["nozzleMap"] = build_nozzle_map(
-                nozzle_to_use, model_to_update.pipette_channels
+                nozzle_to_use,  # type: ignore[arg-type]
+                model_to_update.pipette_channels,
             )
         elif config_to_update[0] == "nozzle_offset":
             geometry["nozzleMap"] = build_nozzle_map(

opentrons_shared_data/pipette/types.py

@@ -1,10 +1,9 @@
 import enum
 from dataclasses import dataclass
+from typing import Dict, List, Mapping, NewType, Tuple, Union, cast
 
 from pydantic import BaseModel
 from typing_extensions import Literal, TypedDict
-from typing import Dict, List, Mapping, NewType, Union, Tuple, cast
-
 
 # TODO(mc, 2022-06-16): remove type alias when able
 # and when certain removal will not break any pickling

opentrons_shared_data/pipette/ul_per_mm.py

@@ -1,4 +1,4 @@
-from typing import List, Tuple, Optional
+from typing import List, Optional, Tuple
 
 from opentrons_shared_data.pipette.pipette_definition import (
     PipetteFunctionKeyType,

opentrons_shared_data/protocol/__init__.py

@@ -1,8 +1,9 @@
 """
 opentrons_shared_data.protocol: types and bindings for json protocols
 """
+
 import json
-from typing import Any, NewType, Dict
+from typing import Any, Dict, NewType
 
 from .. import load_shared_data
 

opentrons_shared_data/protocol/constants.py

@@ -1,98 +1,41 @@
-from typing import TYPE_CHECKING
 from enum import Enum
 
 
-if TYPE_CHECKING:
-    from .types import (
-        DelayCommandId,
-        BlowoutCommandId,
-        PickUpTipCommandId,
-        DropTipCommandId,
-        AspirateCommandId,
-        DispenseCommandId,
-        TouchTipCommandId,
-        MoveToSlotCommandId,
-        AirGapCommandId,
-        MagneticModuleEngageCommandId,
-        MagneticModuleDisengageCommandId,
-        TemperatureModuleSetTargetCommandId,
-        TemperatureModuleAwaitCommandId,
-        TemperatureModuleDeactivateCommandId,
-        ThermocyclerSetTargetBlockCommandId,
-        ThermocyclerSetTargetLidCommandId,
-        ThermocyclerAwaitBlockTemperatureCommandId,
-        ThermocyclerAwaitLidTemperatureCommandId,
-        ThermocyclerOpenLidCommandId,
-        ThermocyclerCloseLidCommandId,
-        ThermocyclerDeactivateLidCommandId,
-        ThermocyclerDeactivateBlockCommandId,
-        ThermocyclerRunProfileCommandId,
-        ThermocyclerAwaitProfileCommandId,
-        MoveToWellCommandId,
-    )
-
-
 class JsonPipetteCommand(Enum):
-    airGap: "AirGapCommandId" = "airGap"
-    blowout: "BlowoutCommandId" = "blowout"
-    pickUpTip: "PickUpTipCommandId" = "pickUpTip"
-    dropTip: "DropTipCommandId" = "dropTip"
-    aspirate: "AspirateCommandId" = "aspirate"
-    dispense: "DispenseCommandId" = "dispense"
-    touchTip: "TouchTipCommandId" = "touchTip"
-    moveToSlot: "MoveToSlotCommandId" = "moveToSlot"
-    moveToWell: "MoveToWellCommandId" = "moveToWell"
+    airGap = "airGap"
+    blowout = "blowout"
+    pickUpTip = "pickUpTip"
+    dropTip = "dropTip"
+    aspirate = "aspirate"
+    dispense = "dispense"
+    touchTip = "touchTip"
+    moveToSlot = "moveToSlot"
+    moveToWell = "moveToWell"
 
 
 class JsonRobotCommand(Enum):
-    delay: "DelayCommandId" = "delay"
+    delay = "delay"
 
 
 class JsonMagneticModuleCommand(Enum):
-    magneticModuleEngageMagnet: "MagneticModuleEngageCommandId" = (
-        "magneticModule/engageMagnet"
-    )
-    magneticModuleDisengageMagnet: "MagneticModuleDisengageCommandId" = (
-        "magneticModule/disengageMagnet"
-    )
+    magneticModuleEngageMagnet = "magneticModule/engageMagnet"
+    magneticModuleDisengageMagnet = "magneticModule/disengageMagnet"
 
 
 class JsonTemperatureModuleCommand(Enum):
-    temperatureModuleSetTargetTemperature: "TemperatureModuleSetTargetCommandId" = (
-        "temperatureModule/setTargetTemperature"
-    )
-    temperatureModuleDeactivate: "TemperatureModuleDeactivateCommandId" = (
-        "temperatureModule/deactivate"
-    )
-    temperatureModuleAwaitTemperature: "TemperatureModuleAwaitCommandId" = (
-        "temperatureModule/awaitTemperature"
-    )
+    temperatureModuleSetTargetTemperature = "temperatureModule/setTargetTemperature"
+    temperatureModuleDeactivate = "temperatureModule/deactivate"
+    temperatureModuleAwaitTemperature = "temperatureModule/awaitTemperature"
 
 
 class JsonThermocyclerCommand(Enum):
-    thermocyclerSetTargetBlockTemperature: "ThermocyclerSetTargetBlockCommandId" = (
-        "thermocycler/setTargetBlockTemperature"
-    )
-    thermocyclerSetTargetLidTemperature: "ThermocyclerSetTargetLidCommandId" = (
-        "thermocycler/setTargetLidTemperature"
-    )
-    thermocyclerAwaitBlockTemperature: "ThermocyclerAwaitBlockTemperatureCommandId" = (
-        "thermocycler/awaitBlockTemperature"
-    )
-    thermocyclerAwaitLidTemperature: "ThermocyclerAwaitLidTemperatureCommandId" = (
-        "thermocycler/awaitLidTemperature"
-    )
-    thermocyclerOpenLid: "ThermocyclerOpenLidCommandId" = "thermocycler/openLid"
-    thermocyclerCloseLid: "ThermocyclerCloseLidCommandId" = "thermocycler/closeLid"
-    thermocyclerDeactivateBlock: "ThermocyclerDeactivateBlockCommandId" = (
-        "thermocycler/deactivateBlock"
-    )
-    thermocyclerDeactivateLid: "ThermocyclerDeactivateLidCommandId" = (
-        "thermocycler/deactivateLid"
-    )
-    thermocyclerRunProfile: "ThermocyclerRunProfileCommandId" = (
-        "thermocycler/runProfile"
-    )
-    thermocyclerAwaitProfileComplete: "ThermocyclerAwaitProfileCommandId" = (
-        "thermocycler/awaitProfileComplete"
-    )
+    thermocyclerSetTargetBlockTemperature = "thermocycler/setTargetBlockTemperature"
+    thermocyclerSetTargetLidTemperature = "thermocycler/setTargetLidTemperature"
+    thermocyclerAwaitBlockTemperature = "thermocycler/awaitBlockTemperature"
+    thermocyclerAwaitLidTemperature = "thermocycler/awaitLidTemperature"
+    thermocyclerOpenLid = "thermocycler/openLid"
+    thermocyclerCloseLid = "thermocycler/closeLid"
+    thermocyclerDeactivateBlock = "thermocycler/deactivateBlock"
+    thermocyclerDeactivateLid = "thermocycler/deactivateLid"
+    thermocyclerRunProfile = "thermocycler/runProfile"
+    thermocyclerAwaitProfileComplete = "thermocycler/awaitProfileComplete"

opentrons_shared_data/protocol/models/__init__.py

@@ -1,25 +1,26 @@
 """Protocol file reading interfaces."""
+
 from . import protocol_schema_v6, protocol_schema_v7, protocol_schema_v8
 from .protocol_schema_v6 import ProtocolSchemaV6
 from .protocol_schema_v7 import ProtocolSchemaV7
-from .protocol_schema_v8 import ProtocolSchemaV8, CommandSchemaId
+from .protocol_schema_v8 import CommandSchemaId, ProtocolSchemaV8
 from .shared_models import (
-    Liquid,
-    Labware,
     CommandAnnotation,
-    Location,
-    ProfileStep,
-    WellLocation,
-    OffsetVector,
+    DesignerApplication,
     Dimensions,
     GroupMetadata,
-    Shape,
-    WellDefinition,
+    Labware,
+    Liquid,
+    Location,
     Metadata,
     Module,
+    OffsetVector,
     Pipette,
+    ProfileStep,
     Robot,
-    DesignerApplication,
+    Shape,
+    WellDefinition,
+    WellLocation,
 )
 
 __all__ = [

opentrons_shared_data/protocol/models/protocol_schema_v6.py

@@ -1,27 +1,28 @@
+from typing import Any, Dict, List, Optional, Union
+
 from pydantic import (
-    ConfigDict,
     BaseModel,
+    ConfigDict,
     Field,
     model_validator,
 )
-from typing import Any, List, Optional, Dict, Union
 from typing_extensions import Literal
-from opentrons_shared_data.labware.labware_definition import LabwareDefinition2
 
 from .shared_models import (
-    Liquid,
-    Labware,
     CommandAnnotation,
+    DesignerApplication,
+    Labware,
+    Liquid,
     Location,
-    ProfileStep,
-    WellLocation,
-    OffsetVector,
     Metadata,
     Module,
+    OffsetVector,
     Pipette,
+    ProfileStep,
     Robot,
-    DesignerApplication,
+    WellLocation,
 )
+from opentrons_shared_data.labware.labware_definition import LabwareDefinition2
 
 
 # TODO (tamar 3/15/22): split apart all the command payloads when we tackle #9583

opentrons_shared_data/protocol/models/protocol_schema_v7.py

@@ -1,20 +1,20 @@
-from pydantic import ConfigDict, BaseModel, Field
-from typing import Any, List, Optional, Dict, Union
-from typing_extensions import Literal
+from typing import Any, Dict, List, Optional, Union
 
-from opentrons_shared_data.labware.labware_definition import LabwareDefinition2
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Literal
 
 from .shared_models import (
-    Liquid,
     CommandAnnotation,
+    DesignerApplication,
+    Liquid,
     Location,
-    ProfileStep,
-    WellLocation,
-    OffsetVector,
     Metadata,
+    OffsetVector,
+    ProfileStep,
     Robot,
-    DesignerApplication,
+    WellLocation,
 )
+from opentrons_shared_data.labware.labware_definition import LabwareDefinition2
 
 
 # TODO (tamar 3/15/22): split apart all the command payloads when we tackle #9583

opentrons_shared_data/protocol/models/protocol_schema_v8.py

@@ -1,18 +1,17 @@
 from enum import Enum
-from typing import Any, List, Optional, Dict
-from typing_extensions import Literal
-
-from pydantic import BaseModel, Field, ConfigDict
+from typing import Any, Dict, List, Optional, Union
 
-from opentrons_shared_data.labware.labware_definition import LabwareDefinition
-from opentrons_shared_data.command import known_schema_ids
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Literal
 
 from .shared_models import (
+    DesignerApplication,
     Liquid,
     Metadata,
-    DesignerApplication,
     Robot,
 )
+from opentrons_shared_data.command import known_schema_ids
+from opentrons_shared_data.labware.labware_definition import LabwareDefinition
 
 
 class Command(BaseModel):
@@ -50,7 +49,10 @@ class ProtocolSchemaV8(BaseModel):
     labwareDefinitions: Dict[str, LabwareDefinition]
     commandSchemaId: CommandSchemaId
     commands: List[Command]
-    commandAnnotationSchemaId: Literal["opentronsCommandAnnotationSchemaV1"]
+    commandAnnotationSchemaId: Union[
+        Literal["opentronsCommandAnnotationSchemaV1"],
+        Literal["opentronsCommandAnnotationSchemaV2"],
+    ]
     commandAnnotations: List[CommandAnnotation]
     designerApplication: Optional[DesignerApplication] = None
     model_config = ConfigDict(populate_by_name=True)

opentrons_shared_data/protocol/models/shared_models.py

@@ -1,5 +1,6 @@
-from typing import Optional, List, Dict, Any, Literal
 from enum import Enum
+from typing import Any, Dict, List, Literal, Optional
+
 from pydantic import BaseModel
 
 

opentrons_shared_data/protocol/types.py

@@ -2,13 +2,14 @@
 opentrons_shared_data.protocol.types: types for json protocols
 """
 
-from typing import Any, Dict, List, Optional, Union
 from enum import Enum
+from typing import Any, Dict, List, Optional, Union
+
+from typing_extensions import Literal, TypedDict
 
-from typing_extensions import TypedDict, Literal
-from ..pipette.types import PipetteName
 from ..labware.types import LabwareDefinition2
 from ..module.types import ModuleModel
+from ..pipette.types import PipetteName
 
 SlotSpan = Literal["span7_8_10_11"]
 

opentrons_shared_data/robot/__init__.py

@@ -1,12 +1,12 @@
 """opentrons_shared_data.robot: Submodule for handling robot definition data."""
+
+import json
 from pathlib import Path
 from typing import cast
-from typing_extensions import Final
 
-import json
+from typing_extensions import Final
 
 from .. import get_shared_data_root
-
 from .types import RobotDefinition, RobotType
 
 DEFAULT_ROBOT_DEFINITION_VERSION: Final = 1

opentrons_shared_data/robot/types.py

@@ -1,7 +1,9 @@
 """opentrons_shared_data.robot.types: types for robot def."""
+
 import enum
-from typing import NewType, List, Dict, Any
-from typing_extensions import Literal, TypedDict, NotRequired
+from typing import Any, Dict, List, NewType
+
+from typing_extensions import Literal, NotRequired, TypedDict
 
 RobotSchemaVersion1 = Literal[1]
 

opentrons_shared_data/util/__init__.py

@@ -0,0 +1,21 @@
+"""Cross-package utilities."""
+
+# Python 3.11 changed the string serialization of string based enums
+# to always include the enumerator name; it previously did not. This
+# is more consistent but also breaks our usage of string based enums.
+# The replacement class StrEnum has the old behavior, but it's not
+# available below 3.11. Here's a polyfill that makes it all better.
+try:
+    from enum import StrEnum
+except ImportError:
+    from enum import Enum
+
+    class StrEnum(str, Enum):  # type: ignore[no-redef]
+        """Replacement for 3.11 style StrEnum in <3.11."""
+
+        def __format__(self, spec: str) -> str:
+            """Build an fstring without the enumerator class name."""
+            return str.__format__(str(self.name), spec)
+
+
+__all__ = ["StrEnum"]

{opentrons_shared_data-8.8.0a6.dist-info → opentrons_shared_data-9.0.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentrons_shared_data
-Version: 8.8.0a6
+Version: 9.0.0a2
 Summary: A bundle of data and python binding that supports the Opentrons API.Does not need to be installed manually; only a dependency of the opentrons package
 Project-URL: Source Code, https://github.com/Opentrons/opentrons
 Author-email: Opentrons <engineering@opentrons.com>
@@ -17,5 +17,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.10
 Requires-Dist: jsonschema<5,>=4.0.0
+Requires-Dist: numpy~=1.26.4
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: typing-extensions<5,>=4.0.0