pymmcore-plus 0.13.6__py3-none-any.whl → 0.14.0__py3-none-any.whl

pymmcore_plus/core/_mmcore_plus.py

@@ -23,6 +23,7 @@ from pymmcore_plus._util import find_micromanager, print_tabular_data
 from pymmcore_plus.mda import MDAEngine, MDARunner, PMDAEngine
 from pymmcore_plus.metadata.functions import summary_metadata
 
+from . import _device
 from ._adapter import DeviceAdapter
 from ._config import Configuration
 from ._config_group import ConfigGroup
@@ -31,26 +32,38 @@ from ._constants import (
     DeviceInitializationState,
     DeviceType,
     FocusDirection,
+    Keyword,
     PixelType,
     PropertyType,
 )
-from ._device import Device
 from ._metadata import Metadata
 from ._property import DeviceProperty
 from .events import CMMCoreSignaler, PCoreSignaler, _get_auto_core_callback_class
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Iterator, Sequence
-    from typing import Literal, TypedDict, Unpack
+    from typing import Literal, TypeAlias, TypedDict, Union, Unpack
 
     import numpy as np
+    from pymmcore import DeviceLabel
     from useq import MDAEvent
 
     from pymmcore_plus.mda._runner import SingleOutput
     from pymmcore_plus.metadata.schema import SummaryMetaV1
 
     _T = TypeVar("_T")
+    _DT = TypeVar("_DT", bound=_device.Device)
     ListOrTuple = list[_T] | tuple[_T, ...]
+    DeviceTypesWithCurrent: TypeAlias = Union[
+        Literal[DeviceType.CameraDevice]
+        | Literal[DeviceType.ShutterDevice]
+        | Literal[DeviceType.StageDevice]
+        | Literal[DeviceType.XYStageDevice]
+        | Literal[DeviceType.AutoFocusDevice]
+        | Literal[DeviceType.SLMDevice]
+        | Literal[DeviceType.GalvoDevice]
+        | Literal[DeviceType.ImageProcessorDevice]
+    ]
 
     class PropertySchema(TypedDict, total=False):
         """JSON schema `dict` describing a device property."""
@@ -334,7 +347,12 @@ class CMMCorePlus(pymmcore.CMMCore):
         and the property Value has actually changed.
         """
         with self._property_change_emission_ensured(stateDeviceLabel, STATE_PROPS):
-            super().setStateLabel(stateDeviceLabel, stateLabel)
+            try:
+                super().setStateLabel(stateDeviceLabel, stateLabel)
+            except RuntimeError as e:  # pragma: no cover
+                state_labels = self.getStateLabels(stateDeviceLabel)
+                msg = f"{e}.  Available Labels: {state_labels}"
+                raise RuntimeError(msg) from None
 
     def setDeviceAdapterSearchPaths(self, paths: Sequence[str]) -> None:
         """Set the device adapter search paths.
@@ -377,6 +395,9 @@ class CMMCorePlus(pymmcore.CMMCore):
             recognized by the specific plugin library. See
             [`pymmcore.CMMCore.getAvailableDevices`][] for a list of valid device names.
         """
+        if str(label).lower() == Keyword.CoreDevice.value.lower():  # pragma: no cover
+            raise ValueError(f"Label {label!r} is reserved.")
+
         try:
             super().loadDevice(label, moduleName, deviceName)
         except (RuntimeError, ValueError) as e:
@@ -850,7 +871,7 @@ class CMMCorePlus(pymmcore.CMMCore):
         device_adapter: str | re.Pattern | None = ...,
         *,
         as_object: Literal[True] = ...,
-    ) -> Iterator[Device]: ...
+    ) -> Iterator[_device.Device]: ...
 
     def iterDevices(
         self,
@@ -859,7 +880,7 @@ class CMMCorePlus(pymmcore.CMMCore):
         device_adapter: str | re.Pattern | None = None,
         *,
         as_object: bool = True,
-    ) -> Iterator[Device] | Iterator[str]:
+    ) -> Iterator[_device.Device] | Iterator[str]:
         """Iterate over currently loaded devices.
 
         :sparkles: *This method is new in `CMMCorePlus`.*
@@ -912,7 +933,7 @@ class CMMCorePlus(pymmcore.CMMCore):
             devices = [d for d in devices if ptrn.search(self.getDeviceLibrary(d))]
 
         for dev in devices:
-            yield Device(dev, mmcore=self) if as_object else dev
+            yield _device.Device.create(dev, mmcore=self) if as_object else dev
 
     @overload
     def iterProperties(
@@ -1093,7 +1114,77 @@ class CMMCorePlus(pymmcore.CMMCore):
         """
         return DeviceAdapter(library_name, mmcore=self)
 
-    def getDeviceObject(self, device_label: str) -> Device:
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Camera]
+    ) -> _device.CameraDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Stage]
+    ) -> _device.StageDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.State]
+    ) -> _device.StateDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Shutter]
+    ) -> _device.ShutterDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.XYStage]
+    ) -> _device.XYStageDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Serial]
+    ) -> _device.SerialDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Generic]
+    ) -> _device.GenericDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.AutoFocus]
+    ) -> _device.AutoFocusDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.ImageProcessor]
+    ) -> _device.ImageProcessorDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.SignalIO]
+    ) -> _device.SignalIODevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Magnifier]
+    ) -> _device.MagnifierDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.SLM]
+    ) -> _device.SLMDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Hub]
+    ) -> _device.HubDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: Literal[DeviceType.Galvo]
+    ) -> _device.GalvoDevice: ...
+    @overload
+    def getDeviceObject(
+        self,
+        device_label: Literal[Keyword.CoreDevice],
+        device_type: Literal[DeviceType.Core],
+    ) -> _device.CoreDevice: ...
+    @overload
+    def getDeviceObject(
+        self, device_label: str, device_type: DeviceType = ...
+    ) -> _device.Device: ...
+    @overload
+    def getDeviceObject(self, device_label: str, device_type: type[_DT]) -> _DT: ...
+    def getDeviceObject(
+        self, device_label: str, device_type: type[_DT] | DeviceType = DeviceType.Any
+    ) -> _DT | _device.Device:
         """Return a `Device` object bound to device_label on this core.
 
         :sparkles: *This method is new in `CMMCorePlus`.*
@@ -1136,7 +1227,18 @@ class CMMCorePlus(pymmcore.CMMCore):
             }
         }
         """
-        return Device(device_label, mmcore=self)
+        dev = _device.Device.create(device_label, mmcore=self)
+        if (isinstance(device_type, type) and not isinstance(dev, device_type)) or (
+            isinstance(device_type, DeviceType)
+            and device_type not in {DeviceType.Any, DeviceType.Unknown}
+            and dev.type() != device_type
+        ):
+            raise TypeError(
+                f"{device_type!r} requested but device with label "
+                f"{device_label!r} is a {dev.type()}."
+            )
+
+        return dev
 
     def getConfigGroupObject(
         self, group_name: str, allow_missing: bool = False
@@ -1189,6 +1291,61 @@ class CMMCorePlus(pymmcore.CMMCore):
         for group in self.getAvailableConfigGroups():
             yield ConfigGroup(group, mmcore=self)
 
+    def getCurrentDeviceOfType(
+        self, device_type: DeviceTypesWithCurrent
+    ) -> DeviceLabel | Literal[""]:
+        """Return the current device of type `device_type`.
+
+        Only the following device types have a "current" device:
+            - CameraDevice
+            - ShutterDevice
+            - StageDevice
+            - XYStageDevice
+            - AutoFocusDevice
+            - SLMDevice
+            - GalvoDevice
+            - ImageProcessorDevice
+
+        Calling this method with any other device type will raise a `ValueError`.
+
+        :sparkles: *This method is new in `CMMCorePlus`.*
+
+        Parameters
+        ----------
+        device_type : DeviceType
+            The type of device to get the current device for.
+            See [`DeviceType`][pymmcore_plus.DeviceType] for a list of device types.
+
+        Returns
+        -------
+        str
+            The label of the current device of type `device_type`.
+            If no device of that type is currently set, an empty string is returned.
+
+        Raises
+        ------
+        ValueError
+            If the core does not have the concept of a "current" device of the provided
+            `device_type`.
+        """
+        if device_type == DeviceType.CameraDevice:
+            return self.getCameraDevice()
+        if device_type == DeviceType.ShutterDevice:
+            return self.getShutterDevice()
+        if device_type == DeviceType.StageDevice:
+            return self.getFocusDevice()
+        if device_type == DeviceType.XYStageDevice:
+            return self.getXYStageDevice()
+        if device_type == DeviceType.AutoFocusDevice:
+            return self.getAutoFocusDevice()
+        if device_type == DeviceType.SLMDevice:
+            return self.getSLMDevice()
+        if device_type == DeviceType.GalvoDevice:
+            return self.getGalvoDevice()
+        if device_type == DeviceType.ImageProcessorDevice:
+            return self.getImageProcessorDevice()
+        raise ValueError(f"'Current' {device_type.name} is undefined. ")
+
     def getDeviceSchema(self, device_label: str) -> DeviceSchema:
         """Return JSON-schema describing device `device_label` and its properties.
 

pymmcore_plus/mda/handlers/_tensorstore_handler.py

@@ -320,7 +320,9 @@ class TensorStoreHandler:
             ]
 
         if self.ts_driver.startswith("zarr"):
-            store.kvstore.write(".zattrs", json_dumps(metadata).decode("utf-8"))
+            store.kvstore.write(
+                ".zattrs", json_dumps(metadata).decode("utf-8")
+            ).result()
         elif self.ts_driver == "n5":  # pragma: no cover
             attrs = json_loads(store.kvstore.read("attributes.json").result().value)
             attrs.update(metadata)

{pymmcore_plus-0.13.6.dist-info → pymmcore_plus-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymmcore-plus
-Version: 0.13.6
+Version: 0.14.0
 Summary: pymmcore superset providing improved APIs, event handling, and a pure python acquisition engine
 Project-URL: Source, https://github.com/pymmcore-plus/pymmcore-plus
 Project-URL: Tracker, https://github.com/pymmcore-plus/pymmcore-plus/issues
@@ -25,57 +25,32 @@ Classifier: Topic :: System :: Hardware
 Classifier: Topic :: System :: Hardware :: Hardware Drivers
 Classifier: Topic :: Utilities
 Requires-Python: >=3.9
-Requires-Dist: numpy>=1.17.3
+Requires-Dist: numpy>=1.25.2
+Requires-Dist: numpy>=1.26.0; python_version >= '3.12'
+Requires-Dist: numpy>=2.1.0; python_version >= '3.13'
 Requires-Dist: platformdirs>=3.0.0
-Requires-Dist: psygnal>=0.7
-Requires-Dist: pymmcore>=10.7.0.71.0
+Requires-Dist: psygnal>=0.10
+Requires-Dist: pymmcore>=11.2.1.71.0
 Requires-Dist: rich>=10.2.0
-Requires-Dist: tensorstore<=0.1.71
+Requires-Dist: tensorstore!=0.1.72,>=0.1.67
+Requires-Dist: tensorstore!=0.1.72,>=0.1.71; python_version >= '3.13'
 Requires-Dist: typer>=0.4.2
-Requires-Dist: typing-extensions
-Requires-Dist: useq-schema>=0.7.0
+Requires-Dist: typing-extensions>=4
+Requires-Dist: useq-schema>=0.7.2
 Provides-Extra: cli
 Requires-Dist: rich>=10.2.0; extra == 'cli'
 Requires-Dist: typer>=0.4.2; extra == 'cli'
-Provides-Extra: dev
-Requires-Dist: ipython; extra == 'dev'
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: pdbpp; (sys_platform != 'win32') and extra == 'dev'
-Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Requires-Dist: tensorstore-stubs; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: mkdocs-autorefs==1.3.1; extra == 'docs'
-Requires-Dist: mkdocs-material; extra == 'docs'
-Requires-Dist: mkdocs-typer==0.0.3; extra == 'docs'
-Requires-Dist: mkdocs>=1.4; extra == 'docs'
-Requires-Dist: mkdocstrings-python==1.1.2; extra == 'docs'
-Requires-Dist: mkdocstrings==0.22.0; extra == 'docs'
 Provides-Extra: io
 Requires-Dist: tifffile>=2021.6.14; extra == 'io'
-Requires-Dist: zarr<3,>=2.2; extra == 'io'
+Requires-Dist: zarr<3,>=2.15; extra == 'io'
 Provides-Extra: pyqt5
 Requires-Dist: pyqt5>=5.15.4; extra == 'pyqt5'
 Provides-Extra: pyqt6
-Requires-Dist: pyqt6<6.8,>=6.4.2; extra == 'pyqt6'
+Requires-Dist: pyqt6>=6.4.2; extra == 'pyqt6'
 Provides-Extra: pyside2
-Requires-Dist: pyside2>=5.15; extra == 'pyside2'
+Requires-Dist: pyside2>=5.15.2.1; extra == 'pyside2'
 Provides-Extra: pyside6
-Requires-Dist: pyside6<6.8,>=6.4.0; extra == 'pyside6'
-Provides-Extra: test
-Requires-Dist: mm-device-adapters; (sys_platform == 'darwin' and platform_machine == 'x86_64') and extra == 'test'
-Requires-Dist: mm-device-adapters; (sys_platform == 'win32') and extra == 'test'
-Requires-Dist: msgpack; extra == 'test'
-Requires-Dist: msgspec; extra == 'test'
-Requires-Dist: pytest-cov>=4; extra == 'test'
-Requires-Dist: pytest-qt>=4; extra == 'test'
-Requires-Dist: pytest>=7.3.2; extra == 'test'
-Requires-Dist: qtpy>=2; extra == 'test'
-Requires-Dist: rich; extra == 'test'
-Requires-Dist: tifffile>=2021.6.14; extra == 'test'
-Requires-Dist: typer>=0.4.2; extra == 'test'
-Requires-Dist: xarray; extra == 'test'
-Requires-Dist: zarr<3,>=2.2; extra == 'test'
+Requires-Dist: pyside6==6.7.3; extra == 'pyside6'
 Description-Content-Type: text/markdown
 
 # pymmcore-plus

{pymmcore_plus-0.13.6.dist-info → pymmcore_plus-0.14.0.dist-info}/RECORD

@@ -1,22 +1,23 @@
-pymmcore_plus/__init__.py,sha256=9-vK2P2jkJJ2REhCjFDBbJu0wrZM0jvDcf-d2GsjTk0,1415
+pymmcore_plus/__init__.py,sha256=EEwtq7bwQ1NC0-wu1DoyA9kJQS7nHqZOlUoYmK3-FQI,1500
+pymmcore_plus/_accumulator.py,sha256=WUgCrLW0U8_kWXfmhSRrC17ubWZNQNckkGVBiTp72F8,9205
 pymmcore_plus/_benchmark.py,sha256=YJICxXleFQVbOluJdq4OujnIcTkkuMVzeB8GJ8nUv5I,6011
 pymmcore_plus/_build.py,sha256=RPTAuwCZWGL5IDJj4JZo1DIIouUsIqS3vnbPbG2_bRE,10993
-pymmcore_plus/_cli.py,sha256=ofh7Yac4VqVuWrEYZ9ZpY4jR8FYzzxfjihvs1_gOqpM,16768
+pymmcore_plus/_cli.py,sha256=wmqlG8UGBNiTefRppSnRHwnD3w-5DAhN168lIBujbRA,16831
 pymmcore_plus/_logger.py,sha256=d7ldqxY0rGWORKdIzNUiFc9BW6cFBx57kHWtXyY1HE0,5416
 pymmcore_plus/_pymmcore.py,sha256=tcWtTRte9AFQznLGn6CmwLW0W3Rsse8N8NQ5L7JwKCc,630
-pymmcore_plus/_util.py,sha256=oeJiDgt5_EoC8srmGz-QH_yNCgsxJ4k0C43qrAspL2A,22706
+pymmcore_plus/_util.py,sha256=VGcb_nQu6BBWZsQihed0TrCHdTRADKlBo_qSnIbeF0Q,22814
 pymmcore_plus/install.py,sha256=U4TbQXbUc12aMtGRF_SkinNOTDCuuzIhME5Oup_4ds0,10768
 pymmcore_plus/mocks.py,sha256=jNUfmffD1OArtIvEmqWsy7GCrtTpssVF03flH8cEYx8,1867
 pymmcore_plus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pymmcore_plus/seq_tester.py,sha256=ielLx2ZUJrOXVCojk64UXTeKDoARxt8QkQjt5AE5Gng,3776
-pymmcore_plus/core/__init__.py,sha256=rYHv5JQVMVDlwYD1wodCc5L9ZbpVld1C_swGx4CRogA,1011
+pymmcore_plus/core/__init__.py,sha256=gCZMmUjvCh4GX3dwKPxiPzt6NQokFtuHl0-tBUG7B9g,1620
 pymmcore_plus/core/_adapter.py,sha256=eu2BhGe_dnoQrIsh-u3poxWXsiF2Y8pfbKIGWbUgOk8,2857
 pymmcore_plus/core/_config.py,sha256=yWwOnW6f37lLt83MnodNce04az-g8YDjyo7BvMiTc8s,10672
 pymmcore_plus/core/_config_group.py,sha256=R-o4xuPDBPQAC3s-mFsiKwHVKWR38L9qq_aoWdPrAq8,8542
 pymmcore_plus/core/_constants.py,sha256=yS_YVRZQkpvTuQdOPFJdetaFpvXh4CTvd7i0qDIiAuA,13200
-pymmcore_plus/core/_device.py,sha256=Pz9Ekhss2c9IBA3B7WyMU2cCwc19Dp_dGVhMkzqUaIE,7762
+pymmcore_plus/core/_device.py,sha256=v58TcROSuvxE5ALBjzS474Dx430e0iMA61OuBSnc2rE,33197
 pymmcore_plus/core/_metadata.py,sha256=L8x1gX_zXPz02BUqc7eqJM_Bey2G0RyX30SOBs2aBNc,2755
-pymmcore_plus/core/_mmcore_plus.py,sha256=15_QvUuURNP23rtN_nkWcqVOx6ohwizZyYPEta6O7ww,94187
+pymmcore_plus/core/_mmcore_plus.py,sha256=Qel61qHKIo-CM4fhji-PZusjs_YuSSkm5n37EO6ESPY,100368
 pymmcore_plus/core/_property.py,sha256=QsQEzqOAedR24zEJ1Ge4kwScfT_7NOApVcgz6QxBJrI,8265
 pymmcore_plus/core/_sequencing.py,sha256=QmaCoyWzR9lX-3ldZxGYqAiEqOn8gts3X0qmskZXzQo,16887
 pymmcore_plus/core/events/__init__.py,sha256=F8r10LEBLrAV8qfkXScSkpqfExdT2XoOx92OqSturpc,1078
@@ -49,7 +50,7 @@ pymmcore_plus/mda/handlers/__init__.py,sha256=TbgpRdcs3BRdCf6uXJlwo_IIbxM6xXaLoc
 pymmcore_plus/mda/handlers/_img_sequence_writer.py,sha256=XUJovvdWViTkn2VZr4XcovNIuBNZF4J4cCHIdwAs1WE,11639
 pymmcore_plus/mda/handlers/_ome_tiff_writer.py,sha256=pqqdl3KQd0tH5Gp4rHVgYqqh2Y8iwoKRXTjwq1JLy1E,6239
 pymmcore_plus/mda/handlers/_ome_zarr_writer.py,sha256=cKg3kJR7TId6M2qC1nJMLlxkv5vlfA5XEAlTIr9kt_E,12275
-pymmcore_plus/mda/handlers/_tensorstore_handler.py,sha256=rgLyuTJjV1m5j-O5tLm-BggIblJpdrHa_FB17_S7rug,15282
+pymmcore_plus/mda/handlers/_tensorstore_handler.py,sha256=YrKwahypq1yoXP3cOcsJTGF-f4LOLrp4KuNHYzPBK64,15321
 pymmcore_plus/mda/handlers/_util.py,sha256=pZydpKAXtQ_gjq5x1yNK1D0hfS7NUL2nH9ivOBg4abc,1600
 pymmcore_plus/metadata/__init__.py,sha256=0o_v53kwR4U_RLlCnr7GD1G6OdFlVuUByIqXiaaM5uk,699
 pymmcore_plus/metadata/functions.py,sha256=Nw2zMbJx0c6aJs6I_uaLGz6cop0IIPfRZOR-qx-SQbc,12937
@@ -64,8 +65,8 @@ pymmcore_plus/model/_device.py,sha256=AX3rO2gbY7AXJyMN3FfI_n2jl2V0IAPuBh7MiDA5Sq
 pymmcore_plus/model/_microscope.py,sha256=69VV6cuevinOK_LhYEkQygHGesvCZefdn9YNt3mV618,11353
 pymmcore_plus/model/_pixel_size_config.py,sha256=RXk8AAwARe8clsXue0GZfOTb1bxyXIsO0ibcDLHM4_s,3889
 pymmcore_plus/model/_property.py,sha256=NQzNtnEzSCR9ogwx1cfi8X-qbJ_cBSJKdSBAaoKoPQ0,3720
-pymmcore_plus-0.13.6.dist-info/METADATA,sha256=LPZrzi2nVttLeRhGn-UlURw4NUoOVOG34fUn59_S3Yc,9961
-pymmcore_plus-0.13.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pymmcore_plus-0.13.6.dist-info/entry_points.txt,sha256=NtFyndrQzBpUNJyil-8e5hMGke2utAf7mkGavTLcLOY,51
-pymmcore_plus-0.13.6.dist-info/licenses/LICENSE,sha256=OHJjRpOPKKRc7FEnpehNWdR5LRBdBhUtIFG-ZI0dCEA,1522
-pymmcore_plus-0.13.6.dist-info/RECORD,,
+pymmcore_plus-0.14.0.dist-info/METADATA,sha256=OzbM7QxgZUlFrhCR3w4lpdchrL7i4AGeANeLqwvl8J0,8835
+pymmcore_plus-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pymmcore_plus-0.14.0.dist-info/entry_points.txt,sha256=NtFyndrQzBpUNJyil-8e5hMGke2utAf7mkGavTLcLOY,51
+pymmcore_plus-0.14.0.dist-info/licenses/LICENSE,sha256=OHJjRpOPKKRc7FEnpehNWdR5LRBdBhUtIFG-ZI0dCEA,1522
+pymmcore_plus-0.14.0.dist-info/RECORD,,