processview 1.4.3__tar.gz → 1.5.0__tar.gz

{processview-1.4.3 → processview-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: processview
-Version: 1.4.3
+Version: 1.5.0
 Summary: Simple helper to provide user feedback about dataset processing
 Author: data analysis unit
 Author-email: henri.payno@esrf.fr

{processview-1.4.3 → processview-1.5.0}/processview/core/manager/manager.py

@@ -1,32 +1,4 @@
-# coding: utf-8
-# /*##########################################################################
-#
-# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# ###########################################################################*/
-
-__authors__ = ["H. Payno"]
-__license__ = "MIT"
-__date__ = "03/11/2020"
-
+from __future__ import annotations
 
 from processview.utils.singleton import singleton
 from processview.core.dataset import Dataset
@@ -62,7 +34,7 @@ class ProcessManager:
 
     def __init__(self):
         self._processes = {}
-        self._dataset_process_states = {}
+        self._dataset_process_states: dict[int, dict[str, tuple]] = {}
         """key is processID, Value is a tuple of
         (dataset state, details)"""
         self._processID = 0
@@ -72,6 +44,8 @@ class ProcessManager:
         """list of callback to trigger when a process is added"""
         self._processRemovedCallback = set()
         """list of callback to trigger when a process is removed"""
+        self._process_renamed_callback = set()
+        """list of callback to trigger when a process is renamed"""
         self.lock = threading.Lock()
 
     def met(self, process, dataset) -> bool:
@@ -85,6 +59,13 @@ class ProcessManager:
         if process.process_id in self._dataset_process_states:
             return dataset_id in self._dataset_process_states[process.process_id]
 
+    def process_renamed(self, process):
+        """
+        the process name only matter for the GUI side
+        """
+        for callback in self._process_renamed_callback:
+            callback(process)
+
     def register(self, process) -> int:
         """
         Register a process to the manager
@@ -154,7 +135,6 @@ class ProcessManager:
         """
 
         :return: tuple of processes currently registered
-        :rtype: tuple
         """
         processes = []
         for _, p in self._processes.items():
@@ -182,10 +162,15 @@ class ProcessManager:
         """
         dataset_id = self._find_dataset_id(dataset)
         for process_id in self._dataset_process_states:
-            if dataset_id in self._dataset_process_states[process_id]:
-                self._dataset_process_states[process_id].pop(dataset_id)
-
-    def notify_dataset_state(self, dataset, process, state, details=None) -> None:
+            self._dataset_process_states[process_id].pop(dataset_id, None)
+
+    def notify_dataset_state(
+        self,
+        dataset: Dataset | DatasetIdentifier,
+        process,
+        state: DatasetState,
+        details=None,
+    ) -> None:
         """
         Update dataset state
 
@@ -209,7 +194,14 @@ class ProcessManager:
             self._dataset_process_states[process.process_id] = OrderedDict()
         if details is None:
             details = ""
-        dataset_id = dataset.get_identifier()
+        if isinstance(dataset, Dataset):
+            dataset_id = dataset.get_identifier()
+        else:
+            dataset_id = dataset
+        if not isinstance(dataset_id, DatasetIdentifier):
+            raise TypeError(
+                f"dataset should be an instance of {Dataset} or {DatasetIdentifier}. Got {type(dataset)}"
+            )
         # as we store the identifier and not a string anymore we might need to remove another instanciation
         process_states = self._dataset_process_states[process.process_id]
         to_remove = set()
@@ -253,7 +245,6 @@ class ProcessManager:
         :param Dataset dataset_id:
         :param BaseProcess process:
         :return: DatasetState relative to provided process if know
-        :rtype: Union[None, DatasetState]
         """
         dataset_id = self._find_dataset_id(dataset_id)
         process = self._find_process(process)
@@ -273,7 +264,6 @@ class ProcessManager:
         :param Dataset dataset_id:
         :param BaseProcess process:
         :return: DatasetState relative to provided process if know
-        :rtype: Union[None, DatasetState]
         """
         dataset_id = self._find_dataset_id(dataset_id)
         process = self._find_process(process)
@@ -287,14 +277,15 @@ class ProcessManager:
                 return self._dataset_process_states[process.process_id][dataset_id][1]
         return None
 
-    def get_dataset_stream(self, dataset, time_stamp=False) -> tuple:
+    def get_dataset_stream(
+        self, dataset, time_stamp=False
+    ) -> tuple[int, DatasetState, list]:
         """
 
         :param Dataset dataset: dataset the stream is focus on
         :param bool time_stamp: if True then return timestamp in the list of
                                 elements
         :return: stream of (process ID, DatasetState) for a given dataset
-        :rtype: tuple of (process ID, DatasetState, [timestamp])
         """
         stream = []
         for process_id, dataset_states in self._dataset_process_states.items():
@@ -316,7 +307,6 @@ class ProcessManager:
         :param bool time_stamp: if True then return timestamp in the list of
                                 elements
         :return: tuple of (DatasetIdentifier, state, [timestamp])
-        :rtype: tuple
         """
         history = []
         if process.process_id in self._dataset_process_states:
@@ -370,6 +360,9 @@ class ProcessManager:
             if callback in self._processRemovedCallback:
                 self._processRemovedCallback.remove(callback)
 
+    def add_process_name_changed_callback(self, callback):
+        self._process_renamed_callback.add(callback)
+
     def clear(self):
         """
         clear registered processes and dataset states

{processview-1.4.3 → processview-1.5.0}/processview/gui/processmanager.py

@@ -1,33 +1,4 @@
-# coding: utf-8
-# /*##########################################################################
-#
-# Copyright (c) 2016-2017 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# ###########################################################################*/
-
-
-__authors__ = ["H. Payno"]
-__license__ = "MIT"
-__date__ = "03/11/2020"
-
+from __future__ import annotations
 
 import fnmatch
 from collections import OrderedDict
@@ -83,8 +54,8 @@ class ObservationTable(qt.QTableView):
         self.dataset_menu = qt.QMenu()
         self._copyAction = qt.QAction("copy")
         self.dataset_menu.addAction(self._copyAction)
-        self._clearAction = qt.QAction("clear")
-        self.dataset_menu.addAction(self._clearAction)
+        self._removeAction = qt.QAction("remove")
+        self.dataset_menu.addAction(self._removeAction)
 
         # QMenu for cell from on dataset and one process
         self.menu_dataset_vs_process = qt.QMenu()
@@ -94,14 +65,14 @@ class ObservationTable(qt.QTableView):
         self.menu_dataset_vs_process.addAction(self._cancelAction)
         self._infoAction = qt.QAction("info")
         self.menu_dataset_vs_process.addAction(self._infoAction)
-        self.menu_dataset_vs_process.addAction(self._clearAction)
+        self.menu_dataset_vs_process.addAction(self._removeAction)
 
         self._target = (None, None)
         # register target of the last menu (process, DatasetIdentifier)
 
         # connect signal / slot
         self._copyAction.triggered.connect(self._requestDatasetIdCopy)
-        self._clearAction.triggered.connect(self._requestClearDataset)
+        self._removeAction.triggered.connect(self._requestRemoveDataset)
         self._reprocessAction.triggered.connect(self._requestReprocessing)
         self._infoAction.triggered.connect(self._requestInfo)
         self._cancelAction.triggered.connect(self._requestCancelProcessing)
@@ -163,7 +134,7 @@ class ObservationTable(qt.QTableView):
             clipboard = qt.QGuiApplication.clipboard()
             clipboard.setText(dataset.to_str())
 
-    def _requestClearDataset(self, *args, **kwargs):
+    def _requestRemoveDataset(self, *args, **kwargs):
         def get_dataset_at(row: int):
             datasets = self.model()._sorted_datasets
             return datasets.get(
@@ -244,6 +215,7 @@ class ProcessManagerWidget(qt.QWidget):
         self._optionsWidget._orderingWidget.sigSortTypeChanged.connect(
             self.observationTable.model()._setSorting
         )
+        self._manager.sigProcessRenamed.connect(self._renameProcess)
         # update to fit existing processes / datasets
         self._updateProcesses()
         self._updateDatasetStates()
@@ -254,6 +226,11 @@ class ProcessManagerWidget(qt.QWidget):
     def _updateProcesses(self):
         self.observationTable.model().setProcesses(self._manager.get_processes())
 
+    def _renameProcess(self, process: SuperviseProcess):
+        self.observationTable.model().headerDataChanged.emit(
+            qt.Qt.Horizontal, 0, len(self._manager.get_processes())
+        )
+
     def _filterUpdated(self):
         self.observationTable.model().process_patterns = (
             self._dropDownOptionsWidget.getProcessPatterns()
@@ -628,6 +605,9 @@ class ProcessManager(qt.QObject):
     sigProcessUnregistered = qt.Signal()
     """Signal emitted when a process is unregistered"""
 
+    sigProcessRenamed = qt.Signal(SuperviseProcess)
+    """Emit when the process is renamed"""
+
     def __init__(self):
         qt.QObject.__init__(self)
         self.manager = _ProcessManager()
@@ -637,6 +617,7 @@ class ProcessManager(qt.QObject):
         self.manager.add_update_callback(self.updated)
         self.manager.add_new_process_callback(self.processAdded)
         self.manager.add_process_removed_callback(self.processRemoved)
+        self.manager.add_process_name_changed_callback(self.processRenamed)
 
     def updated(self):
         self.sigUpdated.emit()
@@ -647,8 +628,8 @@ class ProcessManager(qt.QObject):
     def processRemoved(self):
         self.sigProcessUnregistered.emit()
 
-    def processNameChanged(self, process):
-        self.sigProcessNameChanged.emit(process)
+    def processRenamed(self, process):
+        self.sigProcessRenamed.emit(process)
 
     def destroyed(self, object_):
         self.manager.remove_update_callback(self.updated)

{processview-1.4.3 → processview-1.5.0}/processview/gui/test/test_process_manager.py

@@ -92,7 +92,7 @@ class TestProcessManager(TestCaseQt):
         )
 
         window._centralWidget.observationTable.selectAll()
-        window._centralWidget.observationTable._requestClearDataset()
+        window._centralWidget.observationTable._requestRemoveDataset()
         self.qapp.processEvents()
         assert len(manager.manager._dataset_process_states[p1.process_id]) == 0
         manager.notify_dataset_state(

{processview-1.4.3 → processview-1.5.0}/processview/version.py

@@ -76,8 +76,8 @@ RELEASE_LEVEL_VALUE = {
 }
 
 MAJOR = 1
-MINOR = 4
-MICRO = 3
+MINOR = 5
+MICRO = 0
 RELEV = "final"  # <16
 SERIAL = 0  # <16
 

{processview-1.4.3 → processview-1.5.0}/processview.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: processview
-Version: 1.4.3
+Version: 1.5.0
 Summary: Simple helper to provide user feedback about dataset processing
 Author: data analysis unit
 Author-email: henri.payno@esrf.fr