pymodaq_gui 5.3.2__tar.gz → 5.3.7__tar.gz

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pymodaq_gui
-Version: 5.3.2
+Version: 5.3.7
 Summary: User Interface components for PyMoDAQ
 Project-URL: Homepage, http://pymodaq.cnrs.fr
 Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ
@@ -67,7 +67,7 @@ Requires-Dist: pyqt5; extra == 'pyqt5'
 Provides-Extra: pyqt6
 Requires-Dist: pyqt6; extra == 'pyqt6'
 Provides-Extra: pyside6
-Requires-Dist: pyside6<6.12; extra == 'pyside6'
+Requires-Dist: pyside6!=6.12.0; extra == 'pyside6'
 Description-Content-Type: text/x-rst
 
 .. ############################################################

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/pyproject.toml

@@ -60,7 +60,7 @@ dev = [
     "qtmonaco"
 ]
 pyside6 = [
-    "pyside6<6.12",
+    "pyside6!=6.12.0",  # 6.12.0 aborts on Signal(bool).emit(True) (bool_dealloc)
 ]
 
 pyqt6 = [

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/examples/custom_viewer.py

@@ -3,11 +3,11 @@
 from pymodaq_gui.utils.widgets.table import SpinBoxDelegate
 from pymodaq_gui.parameter.utils import get_widget_from_tree
 from pymodaq_gui.plotting.data_viewers.viewer2D import Viewer2D
-from pymodaq.utils import gui_utils as gutils
+from pymodaq_gui import utils as gutils
 from pymodaq_gui.utils.dock import Dock
 from pymodaq_gui.parameter import ParameterTree, Parameter
 from pymodaq_gui.parameter.pymodaq_ptypes.tableview import TableViewCustom
-from pymodaq.utils.scanner.scanners.tabular import TableModelTabular
+from pymodaq_gui.utils.widgets.table import TableModelTabular
 from qtpy.QtCore import QObject, Qt, Slot
 from qtpy import QtWidgets
 
@@ -81,8 +81,8 @@ class ViewerPointList(QObject):
 
 
 if __name__ == '__main__':
-    from pymodaq.utils.gui_utils import DockArea
-    from pymodaq.utils.data import Axis, DataFromPlugins
+    from pymodaq_gui.utils import DockArea
+    from pymodaq_data.data import Axis, DataRaw
     import sys
     import numpy as np
 
@@ -96,11 +96,11 @@ if __name__ == '__main__':
     Ny = 200
     x = (np.linspace(0, Nx - 1, Nx) + 100) / 2
     y = (np.linspace(0, Ny - 1, Ny) - 10) * 2
-    from pymodaq.utils.math_utils import gauss2D
+    from pymodaq_utils.math_utils import gauss2D
 
     data_red = 3 * gauss2D(x, np.mean(x), (np.max(x)-np.min(x)) / 5, y, np.mean(y), (np.max(y)-np.min(y)) / 5, 1)
     data_red += np.random.random(data_red.shape)
-    data_to_plot = DataFromPlugins(name='mydata', distribution='uniform', data=[data_red],
+    data_to_plot = DataRaw(name='mydata', distribution='uniform', data=[data_red],
                                    axes=[Axis('xaxis', units='xpxl', data=x, index=1),
                                          Axis('yaxis', units='ypxl', data=y, index=0)])
 

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/examples/data_picker.py

@@ -15,7 +15,7 @@ from pymodaq_gui.plotting.data_viewers.viewer2D import Viewer2D
 from pymodaq_gui.utils.custom_app import CustomApp, Dock, DockArea
 
 from pymodaq_gui.parameter.pymodaq_ptypes.tableview import TableViewCustom
-from pymodaq.utils.scanner.scanners.tabular import TableModelTabular
+from pymodaq_gui.utils.widgets.table import TableModelTabular
 
 
 class DataPicker(CustomApp):
@@ -114,7 +114,7 @@ def main():
     Ny = 200
     x = (np.linspace(0, Nx - 1, Nx) + 100) / 2
     y = (np.linspace(0, Ny - 1, Ny) - 10) * 2
-    from pymodaq.utils.math_utils import gauss2D
+    from pymodaq_utils.math_utils import gauss2D
 
     data_red = 3 * gauss2D(x, np.mean(x), (np.max(x)-np.min(x)) / 5, y, np.mean(y), (np.max(y)-np.min(y)) / 5, 1)
     data_red += np.random.random(data_red.shape)

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/examples/function_plotter.py

@@ -9,7 +9,7 @@ import numpy as np
 from qtpy import QtWidgets
 from qtpy.QtCore import QDate, QTimer
 
-from pymodaq.utils.logger import set_logger, get_module_name
+from pymodaq_utils.logger import set_logger, get_module_name
 from pymodaq_utils.config import GlobalConfig as Config
 
 from pymodaq_data.data import DataRaw, Axis

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/managers/settings/subentries.py

@@ -1,12 +1,10 @@
 from dataclasses import dataclass
-from pymodaq.control_modules.move_utility_classes import HW_SETTINGS_KEY as ACTUATOR_SETTINGS_KEY
 import time
 from typing import Callable, TYPE_CHECKING, Union, Tuple
 
 from qtpy import QtWidgets, QtCore
 from serializall import SerializableFactory
 
-from pymodaq.utils.managers.modules import ModuleType
 from pymodaq_gui.managers.parameter_manager import ParameterManager
 from pymodaq_utils.enums import StrEnum
 from pymodaq_utils.abstract import abstract_attribute
@@ -24,7 +22,6 @@ ser_factory = SerializableFactory()
 if TYPE_CHECKING:
     from pymodaq_gui.managers.settings.utils import SettingsManagerModel
     from pymodaq_gui.managers.settings.settings_manager import SettingsManager
-    from pymodaq.dashboard import DashBoard
 
 
 class SubEntryError(Exception):

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/managers/settings/utils.py

@@ -1,4 +1,5 @@
 from collections.abc import Iterable
+from numbers import Number
 from pathlib import Path
 from typing import Union, Any, TYPE_CHECKING, Sequence
 
@@ -179,11 +180,18 @@ class SettingsManagerModel(TableModel):
                 elif index.column() == 2:
                     dat = entry.setting.parameter.title()
                 elif index.column() == 3:
-                    suffix = ''
-                    if entry.setting.parameter.opts.get('suffix', None) is not None:
-                        suffix = f' {entry.setting.parameter.opts.get("suffix")}'
-                    val, prefix = get_si_prefix(entry.setting.parameter.value())
-                    dat = f"{val} {prefix}{suffix}"
+                    value = entry.setting.parameter.value()
+                    if isinstance(value, Number):
+                        suffix = entry.setting.parameter.opts.get('suffix', '')
+                        if suffix is None:
+                            suffix = ''
+                        if isinstance(value, float):
+                            value, prefix = get_si_prefix(value)
+                            dat = f"{value} {prefix}{suffix}"
+                        else:
+                            dat = f"{value} {suffix}"
+                    else:
+                        dat = f'{value}'
                 else:
                     dat = ''
                 return dat
@@ -255,7 +263,7 @@ class SettingsManagerModel(TableModel):
             for child in entry.setting.parameter.children():
                 if child.opts.get(VALID_FOR_CONFIGURATION, True) :  # only add the ones specifying they are configurable
                     pwp = ParameterWithPath(parameter=child, path=entry.setting.path + [child.name()])
-                    config_entry = SubEntry(entry.entry_type, entry.module_name, entry.module_type, pwp)
+                    config_entry = SubEntry(entry.entry_type, entry.module_name, pwp)
                     self.split_entry(config_entry, entries)
         return entries
 

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/parameter/pymodaq_ptypes/pixmap.py

@@ -146,7 +146,7 @@ def main_widget():
 
 
 def main_parameter():
-    from pymodaq.utils.managers.parameter_manager import ParameterManager
+    from pymodaq_gui.managers.parameter_manager import ParameterManager
     data = np.arange(128 * 256).reshape((256, 128))
     data = data / np.max(data) * 255
     data = data.astype(np.uint8)

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/plotting/data_viewers/viewer1Dbasic.py

@@ -210,7 +210,7 @@ if __name__ == '__main__':  # pragma: no cover
     prog.show_roi_line()
     prog.roi_region_signal.connect(print_region)
     prog.roi_line_signal.connect(print_line)
-    from pymodaq.utils.daq_utils import gauss1D
+    from pymodaq_utils.math_utils import gauss1D
 
     x = np.linspace(0, 200, 201)
     y1 = gauss1D(x, 75, 25)

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/plotting/plotter/plotters/qt_plotters.py

@@ -67,9 +67,9 @@ class Plotter(PlotterBase):
 
 
 if __name__ == '__main__':
-    from pymodaq.utils import data as data_mod
+    from pymodaq_data import data as data_mod
     import numpy as np
-    from pymodaq.utils.math_utils import gauss1D
+    from pymodaq_utils.math_utils import gauss1D
 
 
     qapp = start_qapplication()

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/plotting/utils/filter.py

@@ -557,7 +557,7 @@ if __name__ == '__main__':
     app = QtWidgets.QApplication(sys.argv)
     prog = FourierFilterer()
 
-    from pymodaq.utils.daq_utils import gauss1D
+    from pymodaq_utils.math_utils import gauss1D
 
     xdata = np.linspace(0, 400, 401)
     x0 = 50

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/utils/app_worker.py

@@ -1,9 +1,9 @@
 import numpy as np
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
 from qtpy import QtCore
 from qtpy.QtCore import QObject, Signal
 
-from pymodaq.utils.managers.modules import ModulesManager
 from pymodaq_data import DataToExport, Axis
 from pymodaq_data.h5modules.data_saving import DataLoader, DataBundle, DataToExportSaver, DataToExportExtendedSaver, \
     DataToExportEnlargeableSaver, DataToExportTimedSaver
@@ -13,32 +13,43 @@ from pymodaq_gui.managers.h5manager import H5Manager
 from pymodaq_gui.managers.runner_thread_manager import WorkerThreadManager, ThreadWorker, DataForProcessor, \
     get_thread_params
 
-from pymodaq.utils.h5modules.module_saving import (
-    ExtensionSaver, ScanSaver, LoggerSaver, OptimizerSaver)
-from pymodaq.utils.custom_ext import CustomExt
 from pymodaq_gui.parameter import Parameter
 from pymodaq_gui.utils import CustomApp
 from pymodaq_gui.utils.custom_app import WorkFlowActions
 from pymodaq_utils.utils import ThreadCommand
 
 
+# the savers a SaverWorker can use
+SaverTypes = (DataToExportSaver | DataToExportExtendedSaver |
+              DataToExportEnlargeableSaver | DataToExportTimedSaver)
+
+if TYPE_CHECKING:  # only for the annotations, pymodaq_gui does not depend on pymodaq at run time
+    from pymodaq.utils.managers.modules import ModulesManager
+
+
 
 
 class SaverWorker(ThreadWorker):
     """ Worker in separated thread receiving the data ad DataBundle
     and adding them into the extended or enlargeable arrays within a H5file using one of the
-    ExtensionSaver module saver """
+    ExtensionSaver module saver
+
+    Note
+    ----
+    The type of the saver is only hinted with the DataToExport savers (SaverTypes) the worker
+    relies on. It can also be an object of a higher level, such as the extension savers of pymodaq
+    (ScanSaver, LoggerSaver, OptimizerSaver...), as long as it provides the same saving interface.
+    """
 
     nav_axes_signal = Signal(list)
     worker_setting_name: str = 'saver_worker'
     name = 'SaverWorker'
     params = get_thread_params(worker_setting_name)
 
-    def __init__(self, saver: ScanSaver | LoggerSaver | OptimizerSaver, parent = None):
+    def __init__(self, saver: SaverTypes, parent = None):
         super().__init__(parent)
 
-        self.saver: (ScanSaver | LoggerSaver | OptimizerSaver | DataToExportSaver | DataToExportExtendedSaver |
-                     DataToExportEnlargeableSaver | DataToExportTimedSaver) = saver
+        self.saver: SaverTypes = saver
         self.data_to_save_signal.connect(self.save_data, QtCore.Qt.ConnectionType.QueuedConnection)
         self.nav_axes_signal.connect(self.add_nav_axes, QtCore.Qt.ConnectionType.QueuedConnection)
 
@@ -134,7 +145,7 @@ class ExtensionWorker(QObject):
         return self._app.h5_manager
 
     @property
-    def modules_manager(self) -> ModulesManager:
+    def modules_manager(self) -> 'ModulesManager':
         """ Convenience property"""
         return self._app.modules_manager
 
@@ -143,7 +154,7 @@ class ExtensionWorker(QObject):
         return self._app.settings
 
     @property
-    def module_and_data_saver(self) -> ScanSaver | LoggerSaver | OptimizerSaver:
+    def module_and_data_saver(self) -> SaverTypes:
         """ Convenience property"""
         return self._app.module_and_data_saver
 

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/utils/custom_app.py

@@ -281,6 +281,11 @@ class CustomApp(QObject, ActionManager, ParameterManager):
     def get_theme(name: str = None) -> Theme:
         return qt_themes.get_theme(name)
 
+    def _overrides(self, name: str) -> bool:
+        """True if the class of this instance (or one of its parents below CustomApp) redefines the method ``name``
+        of CustomApp, used to call the deprecated hooks only for the apps that still define them"""
+        return getattr(type(self), name) is not getattr(CustomApp, name)
+
     def setup_ui(self):
         self.setup_docks_and_widgets()
 
@@ -337,9 +342,9 @@ class CustomApp(QObject, ActionManager, ParameterManager):
         See Also
         --------
         """
-        if hasattr(self, 'setup_docks'):
+        if self._overrides('setup_docks'):
             self.setup_docks()  # for backcompatibility
-            deprecation_msg('You should not call setup_docks anymore, use `setup_docks_and_widgets` instead')
+            deprecation_msg('You should not define setup_docks anymore, use `setup_docks_and_widgets` instead')
 
     def setup_docks(self):
         """ deprecated, see setup_docks_and_widgets
@@ -362,7 +367,9 @@ class CustomApp(QObject, ActionManager, ParameterManager):
         --------
         pymodaq.utils.managers.action_manager.ActionManager
         """
-        self.setup_menu(menubar)  # for back-compatibility
+        if self._overrides('setup_menu'):
+            self.setup_menu(menubar)  # for back-compatibility
+            deprecation_msg('You should not define setup_menu anymore, use `setup_menus_and_toolbars` instead')
 
     def setup_menu(self, menubar: QtWidgets.QMenuBar = None):
         """ Deprecated, use `setup_menus_and_toolbars`

{pymodaq_gui-5.3.2 → pymodaq_gui-5.3.7}/src/pymodaq_gui/utils/widgets/table.py

@@ -7,6 +7,7 @@ from pymodaq_data.data import parse_quantity
 from pymodaq_utils import utils
 from pymodaq_gui.qvariant import QVariant
 from pymodaq_gui.qt_utils import decode_data
+from pymodaq_gui.utils.file_io import select_file
 from pymodaq_data import Q_
 from qtpy import QtWidgets, QtCore
 
@@ -210,6 +211,76 @@ class TableModel(QtCore.QAbstractTableModel):
 
 
 
+class TableModelTabular(TableModel):
+    """Table Model for the Model/View Qt framework dedicated to the Tabular scan mode"""
+    def __init__(self, data, axes_name=None, **kwargs):
+        if axes_name is None:
+            if 'header' in kwargs:  # when saved as XML the header will be saved and restored here
+                axes_name = [h for h in kwargs['header']]
+                kwargs.pop('header')
+            else:
+                raise Exception('Invalid header')
+        if kwargs.pop('display_units', False):
+            self.units = [str(parse_quantity(dat).units) for dat in data[0]]
+        else:
+            self.units = ['' for _ in axes_name]
+        header = [name for name in axes_name]
+        editable = [True for _ in axes_name]
+        super().__init__(data, header, editable=editable, cast=str, **kwargs)
+
+    def __len__(self):
+        return len(self._data)
+
+    def add_data(self, row, data=None):
+        if data is not None:
+            self.insert_data(row, [f'{d}' for d in data])
+        else:
+            self.insert_data(row, [f'0. {unit}' if unit != '' else f'0.' for unit in self.units])
+
+    def remove_data(self, row):
+        self.remove_row(row)
+
+    def load_txt(self):
+        fname = select_file(start_path=None, save=False, ext='*')
+        if fname is not None and fname != '':
+            while self.rowCount(self.index(-1, -1)) > 0:
+                self.remove_row(0)
+
+            data = np.loadtxt(fname, dtype=str, delimiter='\t')
+            if len(data.shape) == 1:
+                data = data.reshape((data.size, 1))
+            self.set_data_all(data)
+
+    def save_txt(self):
+        fname = select_file(start_path=None, save=True, ext='dat')
+        if fname is not None and fname != '':
+            np.savetxt(fname, self.get_data_all(), delimiter='\t',  fmt='%s')
+
+    def __repr__(self):
+        return f'{self.__class__.__name__} from module {self.__class__.__module__}'
+
+    def validate_data(self, row, col, value):
+        """
+        make sure the values and signs of the start, stop and step values are "correct"
+        Parameters
+        ----------
+        row: (int) row within the table that is to be changed
+        col: (int) col within the table that is to be changed
+        value: (float) new value for the value defined by row and col
+
+        Returns
+        -------
+        bool: True is the new value is fine (change some other values if needed) otherwise False
+        """
+
+        return True
+
+
+class TableModelTabularReadOnly(TableModelTabular):
+    def setData(self, index, value, role):
+        return False
+
+
 class BooleanDelegate(QtWidgets.QStyledItemDelegate):
     """
     TO implement custom widget editor for cells in a tableview