pymmcore-plus 0.13.2__tar.gz → 0.13.4__tar.gz

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymmcore-plus
-Version: 0.13.2
+Version: 0.13.4
 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
@@ -33,7 +33,7 @@ Requires-Dist: rich>=10.2.0
 Requires-Dist: tensorstore; python_version < '3.13'
 Requires-Dist: typer>=0.4.2
 Requires-Dist: typing-extensions
-Requires-Dist: useq-schema>=0.6.2
+Requires-Dist: useq-schema>=0.7.0
 Provides-Extra: cli
 Requires-Dist: rich>=10.2.0; extra == 'cli'
 Requires-Dist: typer>=0.4.2; extra == 'cli'

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
     "psygnal >=0.7",
     "pymmcore >=10.7.0.71.0",
     "typing-extensions",                    # not actually required at runtime
-    "useq-schema >=0.6.2",
+    "useq-schema >=0.7.0",
     "tensorstore; python_version < '3.13'",
     # cli requirements included by default for now
     "typer >=0.4.2",

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/src/pymmcore_plus/core/_mmcore_plus.py

@@ -1675,6 +1675,7 @@ class CMMCorePlus(pymmcore.CMMCore):
 
         **Why Override?** To emit a `startContinuousSequenceAcquisition` event.
         """
+        self.events.continuousSequenceAcquisitionStarting.emit()
         super().startContinuousSequenceAcquisition(intervalMs)
         self.events.continuousSequenceAcquisitionStarted.emit()
 
@@ -1703,12 +1704,16 @@ class CMMCorePlus(pymmcore.CMMCore):
 
         **Why Override?** To emit a `startSequenceAcquisition` event.
         """
-        super().startSequenceAcquisition(*args, **kwargs)
         if len(args) == 3:
             numImages, intervalMs, stopOnOverflow = args
             cameraLabel = super().getCameraDevice()
         else:
             cameraLabel, numImages, intervalMs, stopOnOverflow = args
+
+        self.events.sequenceAcquisitionStarting.emit(
+            cameraLabel, numImages, intervalMs, stopOnOverflow
+        )
+        super().startSequenceAcquisition(*args, **kwargs)
         self.events.sequenceAcquisitionStarted.emit(
             cameraLabel, numImages, intervalMs, stopOnOverflow
         )

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/src/pymmcore_plus/core/events/_protocol.py

@@ -133,14 +133,26 @@ class PCoreSignaler(Protocol):
     > :sparkles: This signal is unique to `pymmcore-plus`.
     """
 
+    continuousSequenceAcquisitionStarting: PSignal
+    """Emits with no arguments *before* continuous sequence acquisition is started.
+
+    > :sparkles: This signal is unique to `pymmcore-plus`.
+    """
     continuousSequenceAcquisitionStarted: PSignal
-    """Emits with no arguments when continuous sequence acquisition is started.
+    """Emits with no arguments *after* continuous sequence acquisition has started.
+
+    > :sparkles: This signal is unique to `pymmcore-plus`.
+    """
+    sequenceAcquisitionStarting: PSignal
+    """Emits `(str, int, float, bool)` *before* sequence acquisition is started.
 
+    (cameraLabel, numImages, intervalMs, stopOnOverflow)
     > :sparkles: This signal is unique to `pymmcore-plus`.
     """
     sequenceAcquisitionStarted: PSignal
-    """Emits `(str, int, float, bool)` when sequence acquisition is started.
+    """Emits `(str, int, float, bool)` *after* sequence acquisition has started.
 
+    (cameraLabel, numImages, intervalMs, stopOnOverflow)
     > :sparkles: This signal is unique to `pymmcore-plus`.
     """
     sequenceAcquisitionStopped: PSignal

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/src/pymmcore_plus/core/events/_psygnal.py

@@ -25,7 +25,9 @@ class CMMCoreSignaler(SignalGroup, _DevicePropertyEventMixin):
     # added for CMMCorePlus
     imageSnapped = Signal()  # whenever snapImage is called
     mdaEngineRegistered = Signal(MDAEngine, MDAEngine)
+    continuousSequenceAcquisitionStarting = Signal()
     continuousSequenceAcquisitionStarted = Signal()
+    sequenceAcquisitionStarting = Signal(str, int, float, bool)
     sequenceAcquisitionStarted = Signal(str, int, float, bool)
     sequenceAcquisitionStopped = Signal(str)
     autoShutterSet = Signal(bool)

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/src/pymmcore_plus/core/events/_qsignals.py

@@ -29,8 +29,10 @@ class QCoreSignaler(QObject):
     imageSnapped = Signal()  # on snapImage()
     mdaEngineRegistered = Signal(object, object)  # new engine, old engine
     # when continuousSequenceAcquisition is started
+    continuousSequenceAcquisitionStarting = Signal()
     continuousSequenceAcquisitionStarted = Signal()
     # when SequenceAcquisition is started
+    sequenceAcquisitionStarting = Signal(str, int, float, bool)
     sequenceAcquisitionStarted = Signal(str, int, float, bool)
     # when (Continuous)SequenceAcquisition is stopped
     sequenceAcquisitionStopped = Signal(str)

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/src/pymmcore_plus/mda/_engine.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Literal, NamedTuple, cast
 
 import numpy as np
 import useq
-from useq import HardwareAutofocus, MDAEvent, MDASequence
+from useq import AcquireImage, HardwareAutofocus, MDAEvent, MDASequence
 
 from pymmcore_plus._logger import logger
 from pymmcore_plus._util import retry
@@ -195,6 +195,13 @@ class MDAEngine(PMDAEngine):
                 )
             return
 
+        # don't try to execute any other action types. Mostly, this is just
+        # CustomAction, which is a user-defined action that the engine doesn't know how
+        # to handle.  But may include other actions in the future, and this ensures
+        # backwards compatibility.
+        if not isinstance(action, (AcquireImage, type(None))):
+            return
+
         # if the autofocus was engaged at the start of the sequence AND autofocus action
         # did not fail, re-engage it. NOTE: we need to do that AFTER the runner calls
         # `setup_event`, so we can't do it inside the exec_event autofocus action above.

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/tests/test_events.py

@@ -171,32 +171,39 @@ def test_device_property_events(core: CMMCorePlus) -> None:
 
 
 def test_sequence_acquisition_events(core: CMMCorePlus) -> None:
-    mock1 = Mock()
-    mock2 = Mock()
+    mock1a = Mock()
+    mock1b = Mock()
+    mock2a = Mock()
+    mock2b = Mock()
     mock3 = Mock()
 
-    core.events.continuousSequenceAcquisitionStarted.connect(mock1)
-    core.events.sequenceAcquisitionStopped.connect(mock2)
-    core.events.sequenceAcquisitionStarted.connect(mock3)
+    core.events.continuousSequenceAcquisitionStarting.connect(mock1a)
+    core.events.continuousSequenceAcquisitionStarted.connect(mock1b)
+    core.events.sequenceAcquisitionStarting.connect(mock2a)
+    core.events.sequenceAcquisitionStarted.connect(mock2b)
+    core.events.sequenceAcquisitionStopped.connect(mock3)
 
     core.startContinuousSequenceAcquisition()
-    mock1.assert_called_once()
+    mock1a.assert_called_once()
+    mock1b.assert_called_once()
 
     core.stopSequenceAcquisition()
-    mock2.assert_any_call(core.getCameraDevice())
+    mock3.assert_any_call(core.getCameraDevice())
 
     # without camera label
     core.startSequenceAcquisition(5, 100.0, True)
-    mock3.assert_any_call(core.getCameraDevice(), 5, 100.0, True)
+    mock2a.assert_any_call(core.getCameraDevice(), 5, 100.0, True)
+    mock2b.assert_any_call(core.getCameraDevice(), 5, 100.0, True)
     core.stopSequenceAcquisition()
-    mock2.assert_any_call(core.getCameraDevice())
+    mock3.assert_any_call(core.getCameraDevice())
 
     # with camera label
     cam = core.getCameraDevice()
     core.startSequenceAcquisition(cam, 5, 100.0, True)
-    mock3.assert_any_call(cam, 5, 100.0, True)
+    mock2a.assert_any_call(cam, 5, 100.0, True)
+    mock2b.assert_any_call(cam, 5, 100.0, True)
     core.stopSequenceAcquisition(cam)
-    mock2.assert_any_call(cam)
+    mock3.assert_any_call(cam)
 
 
 def test_shutter_device_events(core: CMMCorePlus) -> None:

{pymmcore_plus-0.13.2 → pymmcore_plus-0.13.4}/tests/test_mda.py

@@ -490,3 +490,9 @@ def test_get_handlers(core: CMMCorePlus) -> None:
     # but they should have been available during start and finish events
     assert on_start_names == ["TensorStoreHandler"]
     assert on_finish_names == ["TensorStoreHandler"]
+
+
+def test_custom_action(core: CMMCorePlus) -> None:
+    """Make sure we can handle custom actions gracefully"""
+
+    core.mda.run([MDAEvent(action=useq.CustomAction())])