pymmcore-plus 0.15.4__tar.gz → 0.17.0__tar.gz

{pymmcore_plus-0.15.4 → pymmcore_plus-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymmcore-plus
-Version: 0.15.4
+Version: 0.17.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
@@ -28,18 +28,19 @@ Requires-Python: >=3.9
 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: ome-types>=0.6.0
 Requires-Dist: platformdirs>=3.0.0
 Requires-Dist: psygnal>=0.10
-Requires-Dist: pymmcore>=11.9.0.73.0
+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'
@@ -51,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.15.4 → pymmcore_plus-0.17.0}/pyproject.toml

@@ -40,27 +40,30 @@ dependencies = [
     "numpy >=1.26.0; python_version >= '3.12'",
     "numpy >=1.25.2",
     "psygnal >=0.10",
-    "pymmcore >=11.9.0.73.0",
+    "pymmcore >=11.10.0.74.0",
     "typing-extensions >=4",                                   # not actually required at runtime
     "useq-schema >=0.7.2",
     "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",
 ]
 
 # 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"]
 PyQt6 = ["PyQt6 >=6.4.2"]
 
 [dependency-groups]
+nano = ["pymmcore-nano==11.10.0.74.0"]
 docs = [
     "mkdocs >=1.4",
     "mkdocs-material>=9.5",
@@ -70,13 +73,14 @@ docs = [
     "mkdocs-typer ==0.0.3",
 ]
 test = [
-    "pymmcore-plus[io]",
+    "pymmcore-plus[io,simulate]",
     "msgspec >= 0.19",
     "msgpack >=1",
-    "pytest-cov >=5",
+    "pytest-cov >=7",
     "ipython>=8.18.0",
     "pytest >=8",
     "xarray >=2024.1",
+    "lxml >=6.0",
 ]
 test-codspeed = [{ include-group = "test" }, "pytest-codspeed >=3.2.0"]
 test-qt = [{ include-group = 'test' }, "pytest-qt ==4.4", "qtpy >=2"]
@@ -92,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]
@@ -173,6 +179,9 @@ filterwarnings = [
     "error",
     "ignore:Failed to disconnect::pytestqt",
     "ignore:numpy.core.multiarray is deprecated",
+    "ignore:Focus direction is unknown",
+    "ignore:'BaseCommand' is deprecated:DeprecationWarning:typer",
+    "ignore:Failing to pass a value to the 'type_params' parameter",
 ]
 markers = ["run_last: mark a test to run last"]
 
@@ -200,6 +209,7 @@ exclude_lines = [
     "if TYPE_CHECKING:",
     "@overload",
     "except ImportError",
+    "except Exception as e:",     # ok not to cover bare exception catches in tests
     "raise AssertionError",
     "\\.\\.\\.",
     "if __name__ == .__main__.:",
@@ -222,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.15.4 → pymmcore_plus-0.17.0}/src/pymmcore_plus/__init__.py

@@ -2,16 +2,19 @@
 
 import logging
 from importlib.metadata import PackageNotFoundError, version
+from typing import TYPE_CHECKING, Any
 
 try:
     __version__ = version("pymmcore-plus")
 except PackageNotFoundError:  # pragma: no cover
     __version__ = "unknown"
 
+if TYPE_CHECKING:
+    from ._ipy_completion import install_pymmcore_ipy_completion
 
 from ._accumulator import AbstractChangeAccumulator
+from ._discovery import find_micromanager, use_micromanager
 from ._logger import configure_logging
-from ._util import find_micromanager, use_micromanager
 from .core import (
     ActionType,
     CFGCommand,
@@ -63,10 +66,26 @@ __all__ = [
     "__version__",
     "configure_logging",
     "find_micromanager",
+    "install_pymmcore_ipy_completion",
     "use_micromanager",
 ]
 
 
+def __getattr__(name: str) -> Any:
+    """Lazy import for compatibility with pymmcore."""
+    if name == "install_pymmcore_ipy_completion":
+        try:
+            from ._ipy_completion import install_pymmcore_ipy_completion
+        except ImportError as e:  # pragma: no cover
+            raise ImportError(
+                f"Error importing IPython completion for pymmcore-plus: {e}"
+            ) from None
+
+        return install_pymmcore_ipy_completion
+    raise AttributeError(f"module '{__name__}' has no attribute '{name}'. ")
+
+
+# install the IPython completer when imported, if running in an IPython environment
 def _install_ipy_completer() -> None:  # pragma: no cover
     import os
     import sys

{pymmcore_plus-0.15.4 → pymmcore_plus-0.17.0}/src/pymmcore_plus/_accumulator.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import abc
 import sys
+import weakref
 from abc import ABC, abstractmethod
 from collections.abc import Sequence
 from typing import TYPE_CHECKING, Any, ClassVar, Generic, Literal, TypeVar
@@ -166,9 +167,10 @@ class DeviceAccumulator(abc.ABC, Generic[DT]):
         mmcore: CMMCorePlus | None = None,
         **kwargs: Any,
     ) -> None:
-        self._mmcore = mmcore or CMMCorePlus.instance()
+        core = mmcore or CMMCorePlus.instance()
+        self._mmcore_ref = weakref.ref(core)
         dev_type = self._device_type()
-        if not self._mmcore.getDeviceType(device_label) == dev_type:  # pragma: no cover
+        if not core.getDeviceType(device_label) == dev_type:  # pragma: no cover
             raise ValueError(
                 f"Cannot create {self.__class__.__name__}. "
                 f"Device {device_label!r} is not a {dev_type.name}. "
@@ -177,6 +179,16 @@ class DeviceAccumulator(abc.ABC, Generic[DT]):
         self._device_label = device_label
         super().__init__(**kwargs)
 
+    @property
+    def _mmcore(self) -> CMMCorePlus:
+        """Get the CMMCorePlus instance for this accumulator."""
+        if (mmcore := self._mmcore_ref()) is None:  # pragma: no cover
+            raise RuntimeError(
+                f"The CMMCorePlus instance for this {self.__class__.__name__!r} has "
+                "been garbage collected."
+            )
+        return mmcore
+
     def _is_busy(self) -> bool:
         return self._mmcore.deviceBusy(self._device_label)
 
@@ -204,18 +216,24 @@ class DeviceAccumulator(abc.ABC, Generic[DT]):
         device_type = mmcore.getDeviceType(device)
         if cache_key not in DeviceAccumulator._CACHE:
             if device_type == cls._device_type():
-                cls._CACHE[cache_key] = cls(device_label=device, mmcore=mmcore)
+                DeviceAccumulator._CACHE[cache_key] = cls(
+                    device_label=device, mmcore=mmcore
+                )
             else:
                 for sub in cls.__subclasses__():
                     if sub._device_type() == device_type:  # noqa: SLF001
-                        cls._CACHE[cache_key] = sub(device_label=device, mmcore=mmcore)
+                        DeviceAccumulator._CACHE[cache_key] = sub(
+                            device_label=device, mmcore=mmcore
+                        )
                         break
                 else:
                     raise ValueError(
                         "No matching DeviceTypeMixin subclass found for device type "
                         f"{device_type.name} (for device {device!r})."
                     )
-        obj = cls._CACHE[cache_key]
+
+            weakref.finalize(mmcore, DeviceAccumulator._CACHE.pop, cache_key, None)
+        obj = DeviceAccumulator._CACHE[cache_key]
         if not isinstance(obj, cls):
             raise TypeError(
                 f"Cannot create {cls.__name__} for {device!r}. "

{pymmcore_plus-0.15.4 → pymmcore_plus-0.17.0}/src/pymmcore_plus/_cli.py

@@ -7,9 +7,9 @@ import sys
 import time
 from contextlib import suppress
 from pathlib import Path
+from platform import system
 from typing import Optional, Union, cast
 
-from pymmcore_plus._util import get_device_interface_version
 from pymmcore_plus.core._device import Device
 from pymmcore_plus.core._mmcore_plus import CMMCorePlus
 
@@ -26,9 +26,9 @@ import pymmcore_plus
 from pymmcore_plus._build import DEFAULT_PACKAGES, build
 from pymmcore_plus._logger import configure_logging
 from pymmcore_plus._util import USER_DATA_MM_PATH
-from pymmcore_plus.install import PLATFORM
 
 app = typer.Typer(name="mmcore", no_args_is_help=True)
+PLATFORM = system()
 
 
 def _show_version_and_exit(value: bool) -> None:
@@ -103,32 +103,44 @@ def clean(
 
 @app.command(name="list")
 def _list() -> None:
-    """Show all Micro-Manager installs downloaded by pymmcore-plus."""
+    """Show all discovered Micro-Manager installations."""
+    from pymmcore_plus import _discovery
+
     configure_logging(stderr_level="CRITICAL")
-    found: dict[Path, list[str]] = {}
+    found: dict[Path, list[tuple[str, _discovery.DiscoveredMM]]] = {}
     with suppress(Exception):
-        for p in pymmcore_plus.find_micromanager(return_first=False):
-            pth = Path(p)
-            found.setdefault(pth.parent, []).append(pth.name)
+        for dm in _discovery.discover_mm():
+            pth = Path(dm.path)
+            found.setdefault(pth.parent, []).append((pth.name, dm))
+
+    active_mm = _discovery.find_micromanager(return_first=True)
+    required_div = _discovery.PYMMCORE_DIV
 
     if found:
-        first = True
+        print(f"[magenta]Required pymmcore device interface version: {required_div}")
         for parent, items in found.items():
-            print(f":file_folder:[bold green] {parent}")
-            for item in items:
-                version = ""
-                for _lib in (parent / item).glob("*_dal_*"):
-                    with suppress(Exception):
-                        div = get_device_interface_version(_lib)
-                        version = f" (Dev. Interface {div})"
-                        break
-                bullet = "   [bold yellow]*" if first else "   •"
-                using = " [bold blue](active)" if first else ""
-                print(f"{bullet} [cyan]{item}{version}{using}")
-                first = False
+            print(f"\n:file_folder:[bold green] {parent}")
+            for item_name, dm in items:
+                version = f" (DIV {dm.device_interface})" if dm.device_interface else ""
+                is_active = str(dm.path) == active_mm
+                is_compatible = dm.div_compatible
+
+                # Choose bullet and status
+                bullet = "   •"
+                status = ""
+                if is_active:
+                    bullet = "   [bold yellow]➤"
+                    if is_compatible:
+                        status = " [bold blue](active)[/bold blue]"
+                    else:
+                        status = " [bold red](active, incompatible!)[/bold red]"
+                else:
+                    status = " [red](incompatible)[/red]"
+
+                print(f"{bullet} [cyan]{item_name}{version}{status}")
     else:
-        print(":x: [bold red]There are no pymmcore-plus Micro-Manager files.")
-        print("[magenta]run `mmcore install` to install a version of Micro-Manager")
+        print(":x: [bold red]No Micro-Manager installations found.")
+        print("[magenta]Run `mmcore install` to install a version of Micro-Manager")
 
 
 @app.command()
@@ -174,18 +186,24 @@ def install(
         help="Do not use rich output. Useful for scripting.",
         show_default=False,
     ),
+    test_adapters: bool = typer.Option(
+        False,
+        "--test-adapters",
+        help="Install only test adapters (e.g. DemoCamera and others for testing).",
+    ),
 ) -> None:
     """Install Micro-Manager Device adapters from <https://download.micro-manager.org>."""
     import pymmcore_plus.install
 
+    kwargs = {}
     if plain_output:
 
         def _log_msg(text: str, color: str = "", emoji: str = "") -> None:
             print(text)
 
-        pymmcore_plus.install.install(dest, release, log_msg=_log_msg)
-    else:
-        pymmcore_plus.install.install(dest, release)
+        kwargs["log_msg"] = _log_msg
+
+    pymmcore_plus.install.install(dest, release, test_adapters=test_adapters, **kwargs)
 
 
 @app.command()
@@ -414,7 +432,7 @@ def use(
     ),
 ) -> None:
     """Change the currently used Micro-manager version/path."""
-    from pymmcore_plus._util import use_micromanager
+    from pymmcore_plus._discovery import use_micromanager
 
     _pth = Path(pattern)
     if _pth.exists():