zaber-motion 8.0.3__tar.gz → 8.0.4__tar.gz

{zaber_motion-8.0.3/zaber_motion.egg-info → zaber_motion-8.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 8.0.3
+Version: 8.0.4
 Summary: An official library for communicating with Zaber devices.
 Author-email: "Zaber Technologies Inc." <contact@zaber.com>
 License: The MIT License (MIT)

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zaber_motion"
-version = "8.0.3"
+version = "8.0.4"
 description = "An official library for communicating with Zaber devices."
 authors = [{ name = "Zaber Technologies Inc.", email = "contact@zaber.com" }]
 license = { file = "LICENSE.txt" }

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/zaber_motion/__init__.py

@@ -7,6 +7,7 @@ from .async_utils import wait_all as wait_all
 from .library import Library as Library
 from .tools import Tools as Tools
 from .unit_table import UnitTable as UnitTable
+from .variant_test_api import VariantTestApi as VariantTestApi
 from .dto.axis_address import AxisAddress as AxisAddress
 from .dto.channel_address import ChannelAddress as ChannelAddress
 from .dto.device_db_source import DeviceDbSource as DeviceDbSource

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/zaber_motion/dto/requests/__init__.py

@@ -209,11 +209,13 @@ from .stream_wait_request import StreamWaitRequest as StreamWaitRequest
 from .stream_wait_until_idle_request import StreamWaitUntilIdleRequest as StreamWaitUntilIdleRequest
 from .string_array_response import StringArrayResponse as StringArrayResponse
 from .string_response import StringResponse as StringResponse
+from .test_dto_with_variants import TestDtoWithVariants as TestDtoWithVariants
 from .test_event import TestEvent as TestEvent
 from .test_request import TestRequest as TestRequest
 from .test_request_complex import TestRequestComplex as TestRequestComplex
 from .test_response import TestResponse as TestResponse
 from .test_response_long import TestResponseLong as TestResponseLong
+from .test_variant import TestVariant as TestVariant
 from .toggle_device_db_store_request import ToggleDeviceDbStoreRequest as ToggleDeviceDbStoreRequest
 from .tools_list_serial_ports_response import ToolsListSerialPortsResponse as ToolsListSerialPortsResponse
 from .translator_create_from_device_request import TranslatorCreateFromDeviceRequest as TranslatorCreateFromDeviceRequest

zaber_motion-8.0.4/zaber_motion/dto/requests/test_dto_with_variants.py

@@ -0,0 +1,69 @@
+# This file is generated. Do not modify by hand.
+# pylint: disable=line-too-long, unused-argument, f-string-without-interpolation, too-many-branches, too-many-statements, unnecessary-pass
+from dataclasses import dataclass, field
+from typing import Any, Dict, List, Optional
+from collections.abc import Iterable
+import zaber_bson
+from .test_variant import TestVariant, TestVariantWireFormat
+
+
+@dataclass
+class TestDtoWithVariants:
+    """
+    A test DTO that includes variant types.
+    This is used to verify the correct handling of variant types as members of other DTO types.
+    """
+
+    variant_array: List[TestVariant] = field(default_factory=list)
+    """
+    Array of variants.
+    """
+
+    the_variant: Optional[TestVariant] = None
+    """
+    Single variant instance.
+    """
+
+    @staticmethod
+    def zero_values() -> 'TestDtoWithVariants':
+        return TestDtoWithVariants(
+            the_variant=None,
+            variant_array=[],
+        )
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'TestDtoWithVariants':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return TestDtoWithVariants.from_dict(data)
+
+    def to_binary(self) -> bytes:
+        """" Serialize this class to a binary representation. """
+        self.validate()
+        return zaber_bson.dumps(self.to_dict())  # type: ignore
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            'theVariant': TestVariantWireFormat(self.the_variant).to_dict() if self.the_variant is not None else None,
+            'variantArray': [TestVariantWireFormat(item).to_dict() for item in self.variant_array] if self.variant_array is not None else [],
+        }
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'TestDtoWithVariants':
+        return TestDtoWithVariants(
+            the_variant=TestVariantWireFormat.from_dict(data.get('theVariant')).convert_back() if data.get('theVariant') is not None else None,  # type: ignore
+            variant_array=[TestVariantWireFormat.from_dict(item).convert_back() for item in data.get('variantArray')],  # type: ignore
+        )
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.the_variant is not None:
+            TestVariantWireFormat(self.the_variant).validate()
+
+        if self.variant_array is not None:
+            if not isinstance(self.variant_array, Iterable):
+                raise ValueError('Property "VariantArray" of "TestDtoWithVariants" is not iterable.')
+
+            for _, variant_array_item in enumerate(self.variant_array):
+                if variant_array_item is not None:
+                    TestVariantWireFormat(variant_array_item).validate()

zaber_motion-8.0.4/zaber_motion/dto/requests/test_variant.py

@@ -0,0 +1,160 @@
+# This file is generated. Do not modify by hand.
+# pylint: disable=line-too-long, unused-argument, f-string-without-interpolation, too-many-branches, too-many-statements, unnecessary-pass
+from dataclasses import dataclass, field
+from typing import Any, Dict, Union, List, Optional
+import decimal
+from collections.abc import Iterable
+import zaber_bson
+from ..ascii.axis_type import AxisType
+from ..ascii.io_port_label import IoPortLabel
+
+
+TestVariant = Union[AxisType, IoPortLabel, int, Optional[float], List[str]]
+"""
+Test case for variant support. Not part of the public API. Do not use.
+"""
+
+
+@dataclass
+class TestVariantWireFormat:
+    """
+    Serialization wrapper for TestVariant variant. Not part of the public API; do not use.
+    """
+
+    variantValueType: str = ""
+
+    axisTypeValue: AxisType = next(first for first in AxisType)
+
+    ioPortLabelValue: IoPortLabel = field(default_factory=IoPortLabel.zero_values)
+
+    int32Value: int = 0
+
+    stringArrayValue: List[str] = field(default_factory=list)
+
+    optionalDoubleValue: Optional[float] = None
+
+    def __init__(self, value: TestVariant) -> None:
+        if value is None:
+            self.optionalDoubleValue = value
+            self.variantValueType = 'optionalDouble'
+        elif isinstance(value, Iterable):
+            self.stringArrayValue = value
+            self.variantValueType = 'stringArray'
+        elif isinstance(value, int):
+            self.int32Value = value
+            self.variantValueType = 'int32'
+        elif isinstance(value, (float, decimal.Decimal)):
+            self.optionalDoubleValue = value
+            self.variantValueType = 'optionalDouble'
+        elif isinstance(value, AxisType):
+            self.axisTypeValue = value
+            self.variantValueType = 'AxisType'
+        elif isinstance(value, IoPortLabel):
+            self.ioPortLabelValue = value
+            self.variantValueType = 'IoPortLabel'
+        else:
+            raise TypeError(f"Cannot initialize TestVariant with value of type {type(value)}")
+
+    def convert_back(self) -> TestVariant:
+        if self.variantValueType == 'AxisType':
+            return self.axisTypeValue
+        if self.variantValueType == 'IoPortLabel':
+            return self.ioPortLabelValue
+        if self.variantValueType == 'int32':
+            return self.int32Value
+        if self.variantValueType == 'optionalDouble':
+            return self.optionalDoubleValue
+        if self.variantValueType == 'stringArray':
+            return self.stringArrayValue
+
+        raise ValueError(f"Invalid variant type tag value: {self.variantValueType}")
+
+    @staticmethod
+    def from_binary(data_bytes: bytes) -> 'TestVariantWireFormat':
+        """" Deserialize a binary representation of this class. """
+        data = zaber_bson.loads(data_bytes)  # type: Dict[str, Any]
+        return TestVariantWireFormat.from_dict(data)
+
+    def to_binary(self) -> bytes:
+        """" Serialize this class to a binary representation. """
+        self.validate()
+        return zaber_bson.dumps(self.to_dict())  # type: ignore
+
+    def to_dict(self) -> Dict[str, Any]:
+        d: Dict[str, Any] = {
+            'variantValueType': self.variantValueType,
+        }
+
+        if self.variantValueType == 'AxisType':
+            d['axisTypeValue'] = self.axisTypeValue.value
+        elif self.variantValueType == 'IoPortLabel':
+            d['ioPortLabelValue'] = self.ioPortLabelValue.to_dict()
+        elif self.variantValueType == 'int32':
+            d['int32Value'] = int(self.int32Value)
+        elif self.variantValueType == 'optionalDouble':
+            d['optionalDoubleValue'] = float(self.optionalDoubleValue) if self.optionalDoubleValue is not None else None
+        elif self.variantValueType == 'stringArray':
+            d['stringArrayValue'] = [str(item or '') for item in self.stringArrayValue] if self.stringArrayValue is not None else []
+        else:
+            raise ValueError(f"Invalid variant type tag {self.variantValueType} value")
+
+        return d
+
+    @staticmethod
+    def from_dict(data: Dict[str, Any]) -> 'TestVariantWireFormat':
+        tag = data.get('variantValueType')
+        if tag == 'AxisType':
+            return TestVariantWireFormat(AxisType(data.get('axisTypeValue')))  # type: ignore
+        if tag == 'IoPortLabel':
+            return TestVariantWireFormat(IoPortLabel.from_dict(data.get('ioPortLabelValue')))  # type: ignore
+        if tag == 'int32':
+            return TestVariantWireFormat(data.get('int32Value'))  # type: ignore
+        if tag == 'optionalDouble':
+            return TestVariantWireFormat(data.get('optionalDoubleValue'))  # type: ignore
+        if tag == 'stringArray':
+            return TestVariantWireFormat(data.get('stringArrayValue'))  # type: ignore
+
+        raise ValueError(f"Invalid variant type tag {tag} in response data")
+
+    def validate(self) -> None:
+        """" Validates the properties of the instance. """
+        if self.variantValueType == 'AxisType':
+            if self.axisTypeValue is None:
+                raise ValueError(f'Property "AxisType" of "TestVariant" is None.')
+
+            if not isinstance(self.axisTypeValue, AxisType):
+                raise ValueError(f'Property "AxisType" of "TestVariant" is not an instance of "AxisType".')
+
+        elif self.variantValueType == 'IoPortLabel':
+            if self.ioPortLabelValue is None:
+                raise ValueError(f'Property "IoPortLabel" of "TestVariant" is None.')
+
+            if not isinstance(self.ioPortLabelValue, IoPortLabel):
+                raise ValueError(f'Property "IoPortLabel" of "TestVariant" is not an instance of "IoPortLabel".')
+
+            self.ioPortLabelValue.validate()
+
+        elif self.variantValueType == 'int32':
+            if self.int32Value is None:
+                raise ValueError(f'Property "int32" of "TestVariant" is None.')
+
+            if not isinstance(self.int32Value, (int, float, decimal.Decimal)):
+                raise ValueError(f'Property "int32" of "TestVariant" is not a number.')
+
+            if int(self.int32Value) != self.int32Value:
+                raise ValueError(f'Property "int32" of "TestVariant" is not integer value.')
+
+        elif self.variantValueType == 'optionalDouble':
+            if self.optionalDoubleValue is not None:
+                if not isinstance(self.optionalDoubleValue, (int, float, decimal.Decimal)):
+                    raise ValueError(f'Property "optionalDouble" of "TestVariant" is not a number.')
+
+        elif self.variantValueType == 'stringArray':
+            if self.stringArrayValue is not None:
+                if not isinstance(self.stringArrayValue, Iterable):
+                    raise ValueError('Property "stringArray" of "TestVariant" is not iterable.')
+
+                for i, stringArrayValue_item in enumerate(self.stringArrayValue):
+                    if stringArrayValue_item is not None:
+                        if not isinstance(stringArrayValue_item, str):
+                            raise ValueError(f'Item {i} in property "stringArray" of "TestVariant" is not a string.')

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/zaber_motion/library.py

@@ -173,7 +173,7 @@ class Library:
         """
         request = dto.CheckVersionRequest(
             host="py",
-            version="8.0.3",
+            version="8.0.4",
         )
         call_sync("library/check_version", request)
 

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/zaber_motion/units.py

@@ -130,10 +130,10 @@ class Units(Enum):
     FREQUENCY_NANOHERTZ = 'Frequency:nanohertz'
 
 
-UnitsAndLiterals = Union[Units, Literal["m", "cm", "mm", "µm", "um", "μm", "nm", "in", "m/s", "cm/s", "mm/s", "µm/s", "um/s", "μm/s", "nm/s", "in/s", "m/s²", "m/s^2", "cm/s²", "cm/s^2", "mm/s²", "mm/s^2", "µm/s²", "um/s^2", "μm/s²", "nm/s²", "nm/s^2", "in/s²", "in/s^2", "°", "deg", "rad", "°/s", "deg/s", "rad/s", "°/s²", "deg/s^2", "rad/s²", "rad/s^2", "%", "s", "ms", "µs", "us", "μs", "GHz", "MHz", "kHz", "Hz", "mHz", "µHz", "uHz", "μHz", "nHz"]]
+UnitsAndLiterals = Union[Units, Literal["m", "cm", "mm", "µm", "um", "μm", "nm", "in", "m/s", "cm/s", "mm/s", "µm/s", "um/s", "μm/s", "nm/s", "in/s", "m/s²", "m/s^2", "cm/s²", "cm/s^2", "mm/s²", "mm/s^2", "µm/s²", "um/s^2", "μm/s²", "nm/s²", "nm/s^2", "in/s²", "in/s^2", "°", "deg", "rad", "°/s", "deg/s", "rad/s", "°/s²", "deg/s^2", "r/s²", "r/s^2", "rad/s²", "rad/s^2", "%", "s", "ms", "µs", "us", "μs", "GHz", "MHz", "kHz", "Hz", "mHz", "µHz", "uHz", "μHz", "nHz"]]
 LengthUnits = Union[Units, Literal["m", "cm", "mm", "µm", "um", "μm", "nm", "in", "°", "deg", "rad"]]
 VelocityUnits = Union[Units, Literal["m/s", "cm/s", "mm/s", "µm/s", "um/s", "μm/s", "nm/s", "in/s", "°/s", "deg/s", "rad/s"]]
-AccelerationUnits = Union[Units, Literal["m/s²", "m/s^2", "cm/s²", "cm/s^2", "mm/s²", "mm/s^2", "µm/s²", "um/s^2", "μm/s²", "nm/s²", "nm/s^2", "in/s²", "in/s^2", "°/s²", "deg/s^2", "rad/s²", "rad/s^2"]]
+AccelerationUnits = Union[Units, Literal["m/s²", "m/s^2", "cm/s²", "cm/s^2", "mm/s²", "mm/s^2", "µm/s²", "um/s^2", "μm/s²", "nm/s²", "nm/s^2", "in/s²", "in/s^2", "°/s²", "deg/s^2", "r/s²", "r/s^2", "rad/s²", "rad/s^2"]]
 TimeUnits = Union[Units, Literal["s", "ms", "µs", "us", "μs"]]
 FrequencyUnits = Union[Units, Literal["GHz", "MHz", "kHz", "Hz", "mHz", "µHz", "uHz", "μHz", "nHz"]]
 
@@ -175,6 +175,8 @@ LITERALS_TO_UNITS = {
     "rad/s": Units.ANGULAR_VELOCITY_RADIANS_PER_SECOND,
     "°/s²": Units.ANGULAR_ACCELERATION_DEGREES_PER_SECOND_SQUARED,
     "deg/s^2": Units.ANGULAR_ACCELERATION_DEGREES_PER_SECOND_SQUARED,
+    "r/s²": Units.ANGULAR_ACCELERATION_RADIANS_PER_SECOND_SQUARED,
+    "r/s^2": Units.ANGULAR_ACCELERATION_RADIANS_PER_SECOND_SQUARED,
     "rad/s²": Units.ANGULAR_ACCELERATION_RADIANS_PER_SECOND_SQUARED,
     "rad/s^2": Units.ANGULAR_ACCELERATION_RADIANS_PER_SECOND_SQUARED,
     "%": Units.PERCENT_PERCENT,

zaber_motion-8.0.4/zaber_motion/variant_test_api.py

@@ -0,0 +1,101 @@
+# ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== #
+# ============== DO NOT EDIT DIRECTLY ============== #
+
+from typing import List, Optional
+from .call import call, call_async
+from .dto import requests as dto
+from .dto.requests import TestVariant
+
+
+class VariantTestApi:
+    """
+    Test case for certain library features. Not public API; do not use.
+    """
+
+    @staticmethod
+    def mutate_variant(
+            the_variant: TestVariant
+    ) -> Optional[TestVariant]:
+        """
+        Tests serialization of variants.
+
+        Args:
+            the_variant: Test value to modify and return.
+
+        Returns:
+            Mutated input value.
+        """
+        request = dto.TestDtoWithVariants(
+            the_variant=the_variant,
+        )
+        response = call(
+            "test/mutate_variant",
+            request,
+            dto.TestDtoWithVariants.from_binary)
+        return response.the_variant
+
+    @staticmethod
+    async def mutate_variant_async(
+            the_variant: TestVariant
+    ) -> Optional[TestVariant]:
+        """
+        Tests serialization of variants.
+
+        Args:
+            the_variant: Test value to modify and return.
+
+        Returns:
+            Mutated input value.
+        """
+        request = dto.TestDtoWithVariants(
+            the_variant=the_variant,
+        )
+        response = await call_async(
+            "test/mutate_variant",
+            request,
+            dto.TestDtoWithVariants.from_binary)
+        return response.the_variant
+
+    @staticmethod
+    def mutate_variant_array(
+            variant_array: List[TestVariant]
+    ) -> List[TestVariant]:
+        """
+        Tests serialization of arrays of variants.
+
+        Args:
+            variant_array: Test values to modify and return.
+
+        Returns:
+            Mutated input values.
+        """
+        request = dto.TestDtoWithVariants(
+            variant_array=variant_array,
+        )
+        response = call(
+            "test/mutate_variant",
+            request,
+            dto.TestDtoWithVariants.from_binary)
+        return response.variant_array
+
+    @staticmethod
+    async def mutate_variant_array_async(
+            variant_array: List[TestVariant]
+    ) -> List[TestVariant]:
+        """
+        Tests serialization of arrays of variants.
+
+        Args:
+            variant_array: Test values to modify and return.
+
+        Returns:
+            Mutated input values.
+        """
+        request = dto.TestDtoWithVariants(
+            variant_array=variant_array,
+        )
+        response = await call_async(
+            "test/mutate_variant",
+            request,
+            dto.TestDtoWithVariants.from_binary)
+        return response.variant_array

zaber_motion-8.0.4/zaber_motion/version.py

@@ -0,0 +1 @@
+__version__ = "8.0.4"

{zaber_motion-8.0.3 → zaber_motion-8.0.4/zaber_motion.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zaber_motion
-Version: 8.0.3
+Version: 8.0.4
 Summary: An official library for communicating with Zaber devices.
 Author-email: "Zaber Technologies Inc." <contact@zaber.com>
 License: The MIT License (MIT)

{zaber_motion-8.0.3 → zaber_motion-8.0.4}/zaber_motion.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ zaber_motion/serialization.py
 zaber_motion/tools.py
 zaber_motion/unit_table.py
 zaber_motion/units.py
+zaber_motion/variant_test_api.py
 zaber_motion/version.py
 zaber_motion.egg-info/PKG-INFO
 zaber_motion.egg-info/SOURCES.txt
@@ -375,11 +376,13 @@ zaber_motion/dto/requests/stream_wait_request.py
 zaber_motion/dto/requests/stream_wait_until_idle_request.py
 zaber_motion/dto/requests/string_array_response.py
 zaber_motion/dto/requests/string_response.py
+zaber_motion/dto/requests/test_dto_with_variants.py
 zaber_motion/dto/requests/test_event.py
 zaber_motion/dto/requests/test_request.py
 zaber_motion/dto/requests/test_request_complex.py
 zaber_motion/dto/requests/test_response.py
 zaber_motion/dto/requests/test_response_long.py
+zaber_motion/dto/requests/test_variant.py
 zaber_motion/dto/requests/toggle_device_db_store_request.py
 zaber_motion/dto/requests/tools_list_serial_ports_response.py
 zaber_motion/dto/requests/translator_create_from_device_request.py

zaber_motion-8.0.3/zaber_motion/version.py

@@ -1 +0,0 @@
-__version__ = "8.0.3"