processview 1.5.1__tar.gz → 1.5.3__tar.gz

{processview-1.5.1 → processview-1.5.3}/PKG-INFO

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

processview-1.5.3/doc/conf.py

@@ -0,0 +1,287 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Orange3 Example Add-on documentation build configuration file, created by
+# sphinx-quickstart on Fri Aug 21 11:28:31 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# General information about the project.
+project = "processview"
+copyright = "2016-2021, ESRF"
+author = "ESRF"
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "nbsphinx",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+source_suffix = [".rst", ".md"]
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = "index"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = "1.2"
+# The full version, including alpha/beta/rc tags.
+release = "1.2"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ["build", "**.ipynb_checkpoints"]
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "nature"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = "img/processview.png"
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "processview"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+# latex_documents = [
+#   (master_doc, 'Orange3ESRFAdd-on.tex', 'Orange3 ESRF Add-on Documentation',
+#    'Biolab', 'manual'),
+# ]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "processview", [author], 1)]
+
+htmlhelp_pages = [(master_doc, "processview", [author], 1)]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "processview",
+        "processview Documentation",
+        author,
+        "processview",
+        "One line description of project.",
+        "Miscellaneous",
+    )
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+
+nbsphinx_allow_errors = True
+nbsphinx_timeout = 60

processview-1.5.3/example/show_processmanagerwindow.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+import time
+import numpy
+import threading
+from silx.gui import qt
+from processview.gui.processmanager import ProcessManagerWindow
+from processview.core.superviseprocess import SuperviseProcess
+from processview.core.dataset import Dataset
+from processview.core.dataset import DatasetIdentifier
+from processview.core.manager import DatasetState
+from processview.gui.processmanager import ProcessManager
+import datetime
+
+
+class _DummyDataset(Dataset):
+    def __init__(self, name):
+        super().__init__()
+        self.__name = name
+
+    def __str__(self) -> str:
+        return self.__name
+
+    def get_identifier(self) -> DatasetIdentifier:
+        return _DummyIdentifier(
+            self,
+            metadata={
+                "name": self.__name,
+                "creation_time": datetime.datetime.now(),
+                "modification_time": datetime.datetime.now(),
+            },
+        )
+
+
+class _DummyIdentifier(DatasetIdentifier):
+    def to_str(self):
+        return str(self)
+
+    def __str__(self):
+        return self.name()
+
+    def __eq__(self, other):
+        return self.name() == other.name()
+
+    def __hash__(self):
+        return hash(self.name())
+
+
+app = qt.QApplication([])
+
+window = ProcessManagerWindow(parent=None)
+window.show()
+
+p1 = SuperviseProcess(name="process1")
+p2 = SuperviseProcess(name="process2")
+p3 = SuperviseProcess(name="process3")
+
+
+manager = ProcessManager()
+
+
+class RecursiveThread(threading.Thread):
+    def __init__(self, execute_each: int):
+        self.running = True
+        self.execute_each = execute_each
+        super().__init__()
+
+    def run(self):
+        """Method implementing thread loop that updates the plot"""
+        while self.running:
+            time.sleep(self.execute_each)
+            self.process()
+
+    def process(self):
+        raise NotImplementedError()
+
+    def stop(self):
+        """Stop the update thread"""
+        self.running = False
+        self.join(2)
+
+
+class CreateNewDataset(RecursiveThread):
+    """Thread creating a new dataset each n seconds"""
+
+    def process(self):
+        dataset = _DummyDataset(f"scan {numpy.random.randint(0, 999999)}")
+        manager.notify_dataset_state(
+            dataset=dataset, state=DatasetState.PENDING, process=p1
+        )
+
+
+class UpdateDataset(RecursiveThread):
+    """Thread that will update randomly one of the existing dataset"""
+
+    def process(self):
+        datasets = manager.get_datasets()
+        if len(datasets) == 0:
+            return
+        dataset_to_update = numpy.random.choice(datasets)
+        state = numpy.random.choice(DatasetState)
+        process = numpy.random.choice(manager.get_processes())
+        manager.notify_dataset_state(
+            dataset=dataset_to_update,
+            state=state,
+            process=process,
+        )
+
+
+create_new_dataset_thread = CreateNewDataset(execute_each=3)
+create_new_dataset_thread.start()
+update_dataset_thread = UpdateDataset(execute_each=1)
+update_dataset_thread.start()
+
+app.exec()
+
+create_new_dataset_thread.stop()
+update_dataset_thread.stop()

{processview-1.5.1 → processview-1.5.3}/processview/core/sorting.py

@@ -1,4 +1,4 @@
-from silx.utils.enum import Enum as _Enum
+from enum import Enum as _Enum
 
 
 class SortType(_Enum):

processview-1.5.3/processview/gui/processmanager/ObservationTable.py

@@ -0,0 +1,137 @@
+from __future__ import annotations
+
+from silx.gui import qt
+from processview.gui.messagebox import MessageBox
+from processview.core.manager import ProcessManager as _ProcessManager
+from processview.core.superviseprocess import SuperviseProcess
+from processview.core.dataset import DatasetIdentifier
+
+from .ProcessManager import ProcessManager
+
+
+class ObservationTable(qt.QTableView):
+    """
+    Redefinition of QTableView for datasets and processes
+    """
+
+    def __init__(self, parent):
+        qt.QTableView.__init__(self, parent)
+        self.verticalHeader().setSectionsClickable(True)
+
+        # QMenu for the dataset name
+        self.dataset_menu = qt.QMenu()
+        self._copyAction = qt.QAction("copy")
+        self.dataset_menu.addAction(self._copyAction)
+        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()
+        self._reprocessAction = qt.QAction("reprocess")
+        self.menu_dataset_vs_process.addAction(self._reprocessAction)
+        self._cancelAction = qt.QAction("cancel")
+        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._removeAction)
+
+        self._target = (None, None)
+        # register target of the last menu (process, DatasetIdentifier)
+
+        # connect signal / slot
+        self._copyAction.triggered.connect(self._requestDatasetIdCopy)
+        self._removeAction.triggered.connect(self._requestRemoveDataset)
+        self._reprocessAction.triggered.connect(self._requestReprocessing)
+        self._infoAction.triggered.connect(self._requestInfo)
+        self._cancelAction.triggered.connect(self._requestCancelProcessing)
+
+    def _processAt(self, x_pos):
+        column = self.columnAt(x_pos)
+        if column >= 1:
+            processes = self.model()._processes
+            process_idx = column - 1
+            if process_idx < len(processes):
+                return processes[list(processes.keys())[process_idx]]
+
+    def _datasetAt(self, y_pos):
+        row = self.rowAt(y_pos)
+        if row >= 0:
+            datasets = self.model()._sorted_datasets
+            if row < len(datasets):
+                return datasets[list(datasets.keys())[row]]
+
+    def contextMenuEvent(self, event):
+        row = self.columnAt(event.pos().x())
+        dataset = self._datasetAt(event.pos().y())
+        if row == 0:
+            # handle column column
+            self._target = (None, dataset)
+            self.dataset_menu.exec(event.globalPos())
+        else:
+            # handle processes column
+            process = self._processAt(event.pos().x())
+            if (
+                process is not None
+                and dataset is not None
+                and _ProcessManager().met(process=process, dataset=dataset)
+            ):
+                self._target = (process, dataset)
+                self.menu_dataset_vs_process.exec(event.globalPos())
+            else:
+                self._target = (None, None)
+        super().contextMenuEvent(event)
+
+    def _requestReprocessing(self, *args, **kwargs):
+        process, dataset = self._target
+
+        if process is not None and dataset is not None:
+            assert isinstance(process, SuperviseProcess)
+            assert isinstance(dataset, DatasetIdentifier)
+            process.reprocess(dataset.recreate_dataset())
+
+    def _requestCancelProcessing(self, *args, **kwargs):
+        process, dataset = self._target
+        if process is not None and dataset is not None:
+            assert isinstance(process, SuperviseProcess)
+            assert isinstance(dataset, DatasetIdentifier)
+            process.cancel(dataset.recreate_dataset())
+
+    def _requestDatasetIdCopy(self, *args, **kwargs):
+        _, dataset = self._target
+        if dataset is not None:
+            clipboard = qt.QGuiApplication.clipboard()
+            clipboard.setText(dataset.to_str())
+
+    def _requestRemoveDataset(self, *args, **kwargs):
+        def get_dataset_at(row: int):
+            datasets = self.model()._sorted_datasets
+            return datasets.get(
+                list(datasets.keys())[row],
+                None,
+            )
+
+        datasets = [get_dataset_at(index.row()) for index in self.selectedIndexes()]
+        [ProcessManager().remove_dataset(dataset) for dataset in datasets]
+        self.model().remove_datasets(datasets)
+
+    def _requestInfo(self, *args, **kwargs):
+        process, dataset = self._target
+        if process is not None and dataset is not None:
+            infos = ProcessManager().get_dataset_details(
+                dataset=dataset, process=process
+            )
+            if infos in (None, ""):
+                infos = "No extra information provided"
+
+            msg = MessageBox(self)
+            msg.setInfos(infos=infos)
+            extra_info = "{} processing {}".format(process.name, dataset)
+            msg.setWindowTitle(extra_info)
+            msg.setWindowModality(qt.Qt.NonModal)
+            msg.show()
+
+    def sizeHintForColumn(self, column):
+        if column == 0:
+            return 350
+        else:
+            return super().sizeHintForColumn(column)

processview-1.5.3/processview/gui/processmanager/ProcessManager.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+from silx.gui import qt
+from processview.core.manager import ProcessManager as _ProcessManager
+from processview.core.superviseprocess import SuperviseProcess
+from processview.utils import docstring
+from processview.core.manager import DatasetState
+
+
+class ProcessManager(qt.QObject):
+    sigUpdated = qt.Signal()
+    """Signal emitted when the state of some process / dataset is updated
+    """
+
+    sigNewProcessRegistered = qt.Signal()
+    """Signal emitted when a new process is registered"""
+
+    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()
+
+        # monkey patch manager updated function
+        # TODO: add / remove callback would be simpler
+        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()
+
+    def processAdded(self):
+        self.sigNewProcessRegistered.emit()
+
+    def processRemoved(self):
+        self.sigProcessUnregistered.emit()
+
+    def processRenamed(self, process):
+        self.sigProcessRenamed.emit(process)
+
+    def destroyed(self, object_):
+        self.manager.remove_update_callback(self.updated)
+        qt.QObject.destroyed(object_)
+
+    # expose some of the original ProcessManager API
+    @docstring(_ProcessManager)
+    def notify_dataset_state(self, dataset, process, state, details=None) -> None:
+        self.manager.notify_dataset_state(
+            dataset=dataset, process=process, state=state, details=details
+        )
+
+    @docstring(_ProcessManager)
+    def get_dataset_state(self, dataset, process) -> None | DatasetState:
+        return self.manager.get_dataset_state(dataset_id=dataset, process=process)
+
+    @docstring(_ProcessManager)
+    def get_dataset_details(self, dataset, process) -> None | DatasetState:
+        return self.manager.get_dataset_details(dataset_id=dataset, process=process)
+
+    @docstring(_ProcessManager)
+    def get_dataset_stream(self, dataset, time_stamp=False) -> tuple:
+        return self.manager.get_dataset_stream(dataset=dataset, time_stamp=time_stamp)
+
+    @docstring(_ProcessManager)
+    def get_process_history(self, process, time_stamp=False) -> tuple:
+        return self.manager.get_process_history(process=process, time_stamp=time_stamp)
+
+    @docstring(_ProcessManager)
+    def get_processes(self):
+        return self.manager.get_processes()
+
+    @docstring(_ProcessManager)
+    def get_datasets(self):
+        return self.manager.get_datasets()
+
+    def remove_dataset(self, *args, **kwargs):
+        return self.manager.remove_dataset(*args, **kwargs)