improve plugin sync with settings

Author: stevehenke

src/ptychodus/api/plugins.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
-from collections.abc import Sequence
+from collections.abc import Iterable, Iterator
 from dataclasses import dataclass
 from types import ModuleType
-from typing import Generic, TypeVar, overload
+from typing import Generic, TypeVar
 import importlib
 import logging
 import pkgutil
@@ -15,7 +15,8 @@
     UpscalingStrategy,
 )
 from .object import ObjectFileReader, ObjectFileWriter
-from .observer import Observable
+from .observer import Observable, Observer
+from .parametric import StringParameter
 from .patterns import DiffractionFileReader, DiffractionFileWriter
 from .probe import FresnelZonePlate, ProbeFileReader, ProbeFileWriter
 from .product import ProductFileReader, ProductFileWriter
@@ -33,69 +34,62 @@
 
 
 @dataclass(frozen=True)
-class PluginEntry(Generic[T]):
+class Plugin(Generic[T]):
     strategy: T
-    simpleName: str
-    displayName: str
+    simple_name: str
+    display_name: str
 
 
-class PluginChooser(Sequence[PluginEntry[T]], Observable):
+class PluginChooser(Iterable[Plugin[T]], Observable, Observer):
     def __init__(self) -> None:
         super().__init__()
-        self._entryList: list[PluginEntry[T]] = list()
-        self._currentIndex = 0
+        self._registered_plugins: list[Plugin[T]] = list()
+        self._current_index = 0
+        self._parameter: StringParameter | None = None
 
-    def getSimpleNameList(self) -> Sequence[str]:
-        return [entry.simpleName for entry in self._entryList]
+    def register_plugin(self, strategy: T, *, display_name: str, simple_name: str = '') -> None:
+        if not simple_name:
+            simple_name = re.sub(r'\W+', '', display_name)
 
-    def getDisplayNameList(self) -> Sequence[str]:
-        return [entry.displayName for entry in self._entryList]
-
-    def registerPlugin(self, strategy: T, *, displayName: str, simpleName: str = '') -> None:
-        if not simpleName:
-            simpleName = re.sub(r'\W+', '', displayName)
-
-        entry = PluginEntry[T](strategy, simpleName, displayName)
-        self._entryList.append(entry)
+        plugin = Plugin[T](strategy, simple_name, display_name)
+        self._registered_plugins.append(plugin)
         self.notifyObservers()
 
-    @property
-    def currentPlugin(self) -> PluginEntry[T]:
-        return self._entryList[self._currentIndex]
+    def get_current_plugin(self) -> Plugin[T]:
+        return self._registered_plugins[self._current_index]
 
-    def setCurrentPluginByName(self, name: str) -> None:
+    def set_current_plugin(self, name: str) -> None:
         namecf = name.casefold()
 
-        for index, entry in enumerate(self._entryList):
-            if namecf == entry.simpleName.casefold() or namecf == entry.displayName.casefold():
-                if self._currentIndex != index:
-                    self._currentIndex = index
+        for index, plugin in enumerate(self._registered_plugins):
+            if namecf == plugin.simple_name.casefold() or namecf == plugin.display_name.casefold():
+                if self._current_index != index:
+                    self._current_index = index
+
+                    if self._parameter is not None:
+                        self._parameter.setValue(self.get_current_plugin().simple_name)
+
                     self.notifyObservers()
 
                 return
 
         logger.debug(f'Invalid plugin name "{name}"')
 
-    @overload
-    def __getitem__(self, index: int) -> PluginEntry[T]: ...
-
-    @overload
-    def __getitem__(self, index: slice) -> Sequence[PluginEntry[T]]: ...
-
-    def __getitem__(self, index: int | slice) -> PluginEntry[T] | Sequence[PluginEntry[T]]:
-        return self._entryList[index]
+    def synchronize_with_parameter(self, parameter: StringParameter) -> None:
+        self._parameter = parameter
+        self.set_current_plugin(parameter.getValue())
+        self._parameter.addObserver(self)
 
-    def __len__(self) -> int:
-        return len(self._entryList)
+    def __iter__(self) -> Iterator[Plugin[T]]:
+        for plugin in self._registered_plugins:
+            yield plugin
 
     def __bool__(self) -> bool:
-        return bool(self._entryList)
+        return bool(self._registered_plugins)
 
-    def copy(self) -> PluginChooser[T]:
-        clone = PluginChooser[T]()
-        clone._entryList = self._entryList.copy()
-        clone._currentIndex = self._currentIndex
-        return clone
+    def update(self, observable: Observable) -> None:
+        if self._parameter is not None and observable is self._parameter:
+            self.set_current_plugin(self._parameter.getValue())
 
 
 class PluginRegistry:
@@ -118,7 +112,7 @@ def __init__(self) -> None:
         self.deconvolutionStrategies = PluginChooser[DeconvolutionStrategy]()
 
     @classmethod
-    def loadPlugins(cls) -> PluginRegistry:
+    def load_plugins(cls) -> PluginRegistry:
         registry = cls()
 
         import ptychodus.plugins
@@ -137,6 +131,6 @@ def loadPlugins(cls) -> PluginRegistry:
                 logger.warning(exc)
             else:
                 logger.info(f'Registering {moduleInfo.name}')
-                module.registerPlugins(registry)
+                module.register_plugins(registry)
 
         return registry

src/ptychodus/controller/object/core.py

@@ -137,7 +137,7 @@ def _loadCurrentObjectFromFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getOpenFilePath(
             self._view,
             'Open Object',
-            nameFilters=self._api.getOpenFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getOpenFileFilterList()],
             selectedNameFilter=self._api.getOpenFileFilter(),
         )
 
@@ -181,7 +181,7 @@ def _saveCurrentObjectToFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getSaveFilePath(
             self._view,
             'Save Object',
-            nameFilters=self._api.getSaveFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getSaveFileFilterList()],
             selectedNameFilter=self._api.getSaveFileFilter(),
         )
 

src/ptychodus/controller/patterns/core.py

@@ -103,8 +103,8 @@ def _saveDataset(self) -> None:
         filePath, nameFilter = self._file_dialog_factory.getSaveFilePath(
             self._view,
             'Save Diffraction File',
-            nameFilters=fileWriterChooser.getDisplayNameList(),
-            selectedNameFilter=fileWriterChooser.currentPlugin.displayName,
+            nameFilters=[plugin.display_name for plugin in fileWriterChooser],
+            selectedNameFilter=fileWriterChooser.get_current_plugin().display_name,
         )
 
         if filePath:

src/ptychodus/controller/patterns/wizard/files.py

@@ -222,8 +222,8 @@ def __init__(self, api: PatternsAPI) -> None:
         self._file_reader_chooser.addObserver(self)
         self._combo_box = QComboBox()
 
-        for file_type in self._file_reader_chooser.getDisplayNameList():
-            self._combo_box.addItem(file_type)
+        for plugin in self._file_reader_chooser:
+            self._combo_box.addItem(plugin.display_name)
 
         self._sync_model_to_view()
         self._combo_box.textActivated.connect(self._handle_text_activated)
@@ -238,7 +238,7 @@ def _handle_text_activated(self, text: str) -> None:
         self.notifyObservers()
 
     def _sync_model_to_view(self) -> None:
-        self._combo_box.setCurrentText(self._file_reader_chooser.currentPlugin.displayName)
+        self._combo_box.setCurrentText(self._file_reader_chooser.get_current_plugin().display_name)
 
     def get_widget(self) -> QWidget:
         return self._combo_box
@@ -284,7 +284,7 @@ def __init__(
 
     def open_dataset(self) -> None:
         file_reader_chooser = self._api.getFileReaderChooser()
-        file_type = file_reader_chooser.currentPlugin.simpleName
+        file_type = file_reader_chooser.get_current_plugin().simple_name
         file_path = self._settings.filePath.getValue()
 
         try:

src/ptychodus/controller/probe/core.py

@@ -179,7 +179,7 @@ def _loadCurrentProbeFromFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getOpenFilePath(
             self._view,
             'Open Probe',
-            nameFilters=self._api.getOpenFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getOpenFileFilterList()],
             selectedNameFilter=self._api.getOpenFileFilter(),
         )
 
@@ -223,7 +223,7 @@ def _saveCurrentProbeToFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getSaveFilePath(
             self._view,
             'Save Probe',
-            nameFilters=self._api.getSaveFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getSaveFileFilterList()],
             selectedNameFilter=self._api.getSaveFileFilter(),
         )
 

src/ptychodus/controller/probe/editorFactory.py

@@ -43,9 +43,9 @@ def __init__(self, title: str, probeBuilder: FresnelZonePlateProbeBuilder) -> No
         super().__init__()
         self._widget = GroupBoxWithPresets(title)
 
-        for index, presetsLabel in enumerate(probeBuilder.labelsForPresets()):
-            action = self._widget.presetsMenu.addAction(presetsLabel)
-            action.triggered.connect(lambda _, index=index: probeBuilder.applyPresets(index))
+        for label in probeBuilder.labelsForPresets():
+            action = self._widget.presetsMenu.addAction(label)
+            action.triggered.connect(lambda _, label=label: probeBuilder.applyPresets(label))
 
         self._zonePlateDiameterViewController = LengthWidgetParameterViewController(
             probeBuilder.zonePlateDiameterInMeters

src/ptychodus/controller/probe/fluorescence.py

@@ -194,7 +194,7 @@ def _openMeasuredDataset(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getOpenFilePath(
             self._dialog,
             title,
-            nameFilters=self._enhancer.getOpenFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._enhancer.getOpenFileFilterList()],
             selectedNameFilter=self._enhancer.getOpenFileFilter(),
         )
 
@@ -229,7 +229,7 @@ def _saveEnhancedDataset(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getSaveFilePath(
             self._dialog,
             title,
-            nameFilters=self._enhancer.getSaveFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._enhancer.getSaveFileFilterList()],
             selectedNameFilter=self._enhancer.getSaveFileFilter(),
         )
 

src/ptychodus/controller/product/core.py

@@ -239,7 +239,7 @@ def _openProductFromFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getOpenFilePath(
             self._view,
             'Open Product',
-            nameFilters=self._api.getOpenFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getOpenFileFilterList()],
             selectedNameFilter=self._api.getOpenFileFilter(),
         )
 
@@ -260,7 +260,7 @@ def _saveCurrentProductToFile(self) -> None:
             filePath, nameFilter = self._fileDialogFactory.getSaveFilePath(
                 self._view,
                 'Save Product',
-                nameFilters=self._api.getSaveFileFilterList(),
+                nameFilters=[nameFilter for nameFilter in self._api.getSaveFileFilterList()],
                 selectedNameFilter=self._api.getSaveFileFilter(),
             )
 

src/ptychodus/controller/scan/core.py

@@ -117,7 +117,7 @@ def _loadCurrentScanFromFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getOpenFilePath(
             self._view,
             'Open Scan',
-            nameFilters=self._api.getOpenFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getOpenFileFilterList()],
             selectedNameFilter=self._api.getOpenFileFilter(),
         )
 
@@ -161,7 +161,7 @@ def _saveCurrentScanToFile(self) -> None:
         filePath, nameFilter = self._fileDialogFactory.getSaveFilePath(
             self._view,
             'Save Scan',
-            nameFilters=self._api.getSaveFileFilterList(),
+            nameFilters=[nameFilter for nameFilter in self._api.getSaveFileFilterList()],
             selectedNameFilter=self._api.getSaveFileFilter(),
         )
 

src/ptychodus/model/automation/core.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from collections.abc import Sequence
+from collections.abc import Iterator
 from pathlib import Path
 import queue
 
@@ -36,7 +36,7 @@ def __init__(
         settings.addObserver(self)
         watcher.addObserver(self)
 
-    def getStrategyList(self) -> Sequence[str]:
+    def getStrategyList(self) -> Iterator[str]:
         return self._workflow.getAvailableWorkflows()
 
     def getStrategy(self) -> str: