pymmcore-plus 0.16.0__tar.gz → 0.17.1__tar.gz

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymmcore-plus
-Version: 0.16.0
+Version: 0.17.1
 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
@@ -35,12 +35,12 @@ Requires-Dist: pymmcore>=11.10.0.74.0
 Requires-Dist: rich>=10.2.0
 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: typer>=0.13.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'
+Requires-Dist: typer>=0.13.0; extra == 'cli'
 Provides-Extra: io
 Requires-Dist: tifffile>=2021.6.14; extra == 'io'
 Requires-Dist: zarr<3,>=2.15; extra == 'io'
@@ -52,6 +52,8 @@ Provides-Extra: pyside2
 Requires-Dist: pyside2>=5.15.2.1; extra == 'pyside2'
 Provides-Extra: pyside6
 Requires-Dist: pyside6==6.7.3; extra == 'pyside6'
+Provides-Extra: simulate
+Requires-Dist: pillow>=11.0; extra == 'simulate'
 Description-Content-Type: text/markdown
 
 # pymmcore-plus

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/pyproject.toml

@@ -46,7 +46,7 @@ dependencies = [
     "tensorstore >=0.1.71,!=0.1.72; python_version >= '3.13'",
     "tensorstore >=0.1.67,!=0.1.72",
     # cli requirements included by default for now
-    "typer >=0.4.2",
+    "typer >=0.13.0",
     "rich >=10.2.0",
     "ome-types >=0.6.0",
 ]
@@ -54,8 +54,9 @@ dependencies = [
 # extras
 # https://peps.python.org/pep-0621/#dependencies-optional-dependencies
 [project.optional-dependencies]
-cli = ["typer >=0.4.2", "rich >=10.2.0"]
+cli = ["typer >=0.13.0", "rich >=10.2.0"]
 io = ["tifffile >=2021.6.14", "zarr >=2.15,<3"]
+simulate = ["pillow >=11.0"]
 PySide2 = ["PySide2 >=5.15.2.1"]
 PySide6 = ["PySide6 ==6.7.3"]
 PyQt5 = ["PyQt5 >=5.15.4"]
@@ -72,7 +73,7 @@ docs = [
     "mkdocs-typer ==0.0.3",
 ]
 test = [
-    "pymmcore-plus[io]",
+    "pymmcore-plus[io,simulate]",
     "msgspec >= 0.19",
     "msgpack >=1",
     "pytest-cov >=7",
@@ -95,6 +96,8 @@ dev = [
     "pre-commit>=4.1.0",
     "ruff>=0.9.4",
     "pydantic >2.7.4; python_version >= '3.13'",
+    "opencv-python>=4.11.0.86",
+    "pytest-xdist>=3.8.0",
 ]
 
 [tool.uv.sources]
@@ -229,4 +232,4 @@ ignore = [
 ]
 
 [tool.typos.default]
-extend-ignore-identifiers-re = ["(?i)nd2?.*", "(?i)ome", "anager", "ba"]
+extend-ignore-identifiers-re = ["(?i)nd2?.*", "(?i)ome", "anager", "ba", "(?:FOVs?)"]

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/_ipy_completion.py

@@ -291,7 +291,7 @@ LABEL_COMPLETERS: dict[tuple[str, int], tuple[int, CoreLabelCompleter]] = {
 # fmt: on
 
 
-@context_matcher()  # type: ignore[misc]
+@context_matcher()  # type: ignore[untyped-decorator]
 def cmmcoreplus_matcher(ctx: CompletionContext) -> SimpleMatcherResult:
     """
     Offer string completions for CMMCorePlus calls such as.

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/_logger.py

@@ -54,7 +54,7 @@ class CustomFormatter(logging.Formatter):
         return formatter.format(record)
 
 
-_FILE_FORMMATTER = logging.Formatter(
+_FILE_FORMATTER = logging.Formatter(
     "%(asctime)s.%(msecs)03d    tid0x%(thread)x [%(levelname)s,%(name)s] %(message)s",
     datefmt="%Y-%m-%dT%H:%M:%S",
 )
@@ -141,7 +141,7 @@ def configure_logging(
             log_file, maxBytes=file_rotation * 1_000_000, backupCount=file_retention
         )
         file_handler.setLevel(file_level)
-        file_handler.setFormatter(_FILE_FORMMATTER)
+        file_handler.setFormatter(_FILE_FORMATTER)
         logger.addHandler(file_handler)
 
 

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/core/_device.py

@@ -35,6 +35,12 @@ class Device:
         Device label assigned to this device.
     mmcore : CMMCorePlus
         CMMCorePlus instance that owns this device.
+    device_type : DeviceType or Device subclass, optional
+        The type of device to create. If not specified, the type will be inferred
+        from the core if the device is already loaded. If the device is not loaded,
+        an error will be raised. This parameter is mainly intended for usage when
+        calling from `CMMCorePlus.getDeviceObject()`.  Otherwise, prefer using
+        `[SpecificDeviceSubclass].create()`.
 
     Examples
     --------
@@ -57,14 +63,39 @@ class Device:
     propertyChanged: PSignalInstance
 
     @classmethod
-    def create(cls, device_label: str, mmcore: CMMCorePlus) -> Self:
-        sub_cls = cls.get_subclass(device_label, mmcore)
+    def create(
+        cls,
+        device_label: str,
+        mmcore: CMMCorePlus,
+        device_type: type[Device] | DeviceType = DeviceType.Any,
+    ) -> Self:
+        if device_type in {DeviceType.Any, DeviceType.Unknown}:
+            try:
+                sub_cls = cls.get_subclass(device_label, mmcore)
+            except RuntimeError as e:
+                raise RuntimeError(
+                    f"Could not determine device type for {device_label}. "
+                    "If you are preloading a device object, "
+                    "please specify `device_type` as a `pymmcore_plus.DeviceType`."
+                ) from e
+        else:
+            if isinstance(device_type, type) and issubclass(device_type, Device):
+                sub_cls = device_type
+            elif isinstance(device_type, DeviceType):
+                sub_cls = _TYPE_MAP[device_type]
+            else:
+                raise TypeError(
+                    f"Invalid device_type: {device_type!r}.  Must be a "
+                    "pymmcore_plus `DeviceType` or `Device` subclass."
+                )
+
         # make sure it's an error to call this class method on a subclass with
         # a non-matching type
-        if issubclass(sub_cls, cls):
-            return sub_cls(device_label, mmcore)
-        dev_type = mmcore.getDeviceType(device_label).name
-        raise TypeError(f"Cannot cast {dev_type} {device_label!r} to {cls}")
+        if not issubclass(sub_cls, cls):
+            dev_type = mmcore.getDeviceType(device_label).name
+            raise TypeError(f"Cannot cast {dev_type} {device_label!r} to {cls}")
+
+        return sub_cls(device_label, mmcore)
 
     @classmethod
     def get_subclass(cls, device_label: str, mmcore: CMMCorePlus) -> type[Device]:

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/core/_mmcore_plus.py

@@ -1268,18 +1268,7 @@ class CMMCorePlus(pymmcore.CMMCore):
             }
         }
         """
-        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
+        return _device.Device.create(device_label, mmcore=self, device_type=device_type)
 
     def getConfigGroupObject(
         self, group_name: str, allow_missing: bool = False
@@ -2091,13 +2080,13 @@ class CMMCorePlus(pymmcore.CMMCore):
         super().deleteConfig(*args)
         self.events.configDeleted.emit(groupName, configName)
 
-    def deleteConfigGroup(self, group: str) -> None:
+    def deleteConfigGroup(self, groupName: str) -> None:
         """Deletes an entire configuration `group`.
 
         **Why Override?** To emit a `configGroupDeleted` event.
         """
-        super().deleteConfigGroup(group)
-        self.events.configGroupDeleted.emit(group)
+        super().deleteConfigGroup(groupName)
+        self.events.configGroupDeleted.emit(groupName)
 
     @overload
     def defineConfig(self, groupName: str, configName: str) -> None: ...

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/core/_property.py

@@ -149,7 +149,7 @@ class DeviceProperty:
         return self.core.getDeviceType(self.device)
 
     def allowedValues(self) -> tuple[str, ...]:
-        """Return allowed values for this property, if contstrained."""
+        """Return allowed values for this property, if constrained."""
         # https://github.com/micro-manager/mmCoreAndDevices/issues/172
         allowed = self.core.getAllowedPropertyValues(self.device, self.name)
         if not allowed and self.deviceType() is DeviceType.StateDevice:

{pymmcore_plus-0.16.0 → pymmcore_plus-0.17.1}/src/pymmcore_plus/core/_sequencing.py

@@ -348,6 +348,8 @@ class EventCombiner:
             z_pos=first_event.z_pos,
             exposure=first_event.exposure,
             channel=first_event.channel,
+            min_start_time=first_event.min_start_time,
+            reset_event_timer=first_event.reset_event_timer,
         )
 
     # -------------- helper methods to query props & max lengths ----------------

pymmcore_plus-0.17.1/src/pymmcore_plus/experimental/simulate/__init__.py

@@ -0,0 +1,88 @@
+"""Simulated microscope sample for testing and development.
+
+This module provides tools for creating virtual microscope samples that
+integrate with CMMCorePlus. When a sample is installed on a core, image
+acquisition returns rendered images based on the sample objects and
+current microscope state (stage position, exposure, pixel size, etc.).
+
+Examples
+--------
+Create a sample with some objects and use it with a core:
+
+>>> from pymmcore_plus import CMMCorePlus
+>>> from pymmcore_plus.experimental.simulate import (
+...     Sample,
+...     Point,
+...     Line,
+...     Rectangle,
+...     RenderConfig,
+... )
+>>>
+>>> # Create core and load config
+>>> core = CMMCorePlus.instance()
+>>> core.loadSystemConfiguration()
+>>>
+>>> # Define sample objects (coordinates in microns)
+>>> sample = Sample(
+...     [
+...         Point(0, 0, intensity=200, radius=5),
+...         Point(50, 50, intensity=150, radius=3),
+...         Line((0, 0), (100, 100), intensity=100),
+...         Rectangle((20, 20), width=30, height=20, intensity=180, fill=True),
+...     ]
+... )
+>>>
+>>> # Use as context manager
+>>> with sample.patch(core):
+...     core.snapImage()
+...     img = core.getImage()  # Returns rendered simulation
+...     print(img.shape, img.dtype)
+
+Custom render configuration:
+
+>>> config = RenderConfig(
+...     noise_std=5.0,  # More noise
+...     defocus_scale=0.2,  # More blur with Z
+...     shot_noise=False,  # Disable shot noise
+...     bit_depth=16,  # 16-bit output
+... )
+>>> sample = Sample([Point(0, 0)], config=config)
+
+Manual install/uninstall:
+
+>>> sample.install(core)
+>>> # ... do stuff ...
+>>> sample.uninstall()
+"""
+
+from ._objects import (
+    Arc,
+    Bitmap,
+    Bounds,
+    Ellipse,
+    Line,
+    Point,
+    Polygon,
+    Rectangle,
+    RegularPolygon,
+    SampleObject,
+    rects_intersect,
+)
+from ._render import RenderConfig
+from ._sample import Sample
+
+__all__ = [
+    "Arc",
+    "Bitmap",
+    "Bounds",
+    "Ellipse",
+    "Line",
+    "Point",
+    "Polygon",
+    "Rectangle",
+    "RegularPolygon",
+    "RenderConfig",
+    "Sample",
+    "SampleObject",
+    "rects_intersect",
+]