scipion-pyworkflow 3.11.0__py3-none-any.whl → 3.11.1__py3-none-any.whl

pyworkflow/gui/project/constants.py

@@ -0,0 +1,139 @@
+# **************************************************************************
+# *
+# * Authors:     J.M. De la Rosa Trevin (jmdelarosa@cnb.csic.es)
+# *
+# * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
+# *
+# * This program is free software; you can redistribute it and/or modify
+# * it under the terms of the GNU General Public License as published by
+# * the Free Software Foundation; either version 3 of the License, or
+# * (at your option) any later version.
+# *
+# * This program is distributed in the hope that it will be useful,
+# * but WITHOUT ANY WARRANTY; without even the implied warranty of
+# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# * GNU General Public License for more details.
+# *
+# * You should have received a copy of the GNU General Public License
+# * along with this program; if not, write to the Free Software
+# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# * 02111-1307  USA
+# *
+# *  All comments concerning this program package may be sent to the
+# *  e-mail address 'scipion@cnb.csic.es'
+# *
+# **************************************************************************
+
+
+from pyworkflow.protocol import (STATUS_SAVED, STATUS_LAUNCHED, STATUS_RUNNING,
+                                 STATUS_FINISHED, STATUS_FAILED,
+                                 STATUS_INTERACTIVE, STATUS_ABORTED,
+                                 STATUS_SCHEDULED)
+
+from pyworkflow.utils.properties import Message, Icon, KEYSYM
+
+STATUS_COLORS = {
+               STATUS_SAVED: '#D9F1FA',
+               STATUS_LAUNCHED: '#D9F1FA',
+               STATUS_RUNNING: '#FCCE62',
+               STATUS_FINISHED: '#D2F5CB',
+               STATUS_FAILED: '#F5CCCB',
+               STATUS_INTERACTIVE: '#F3F5CB',
+               STATUS_ABORTED: '#F5CCCB',
+               STATUS_SCHEDULED: '#F3F5CB'
+               }
+
+# For protocols with warnings
+WARNING_COLOR = '#848484'
+
+ACTION_NEW = Message.LABEL_NEW
+ACTION_EDIT = Message.LABEL_EDIT
+ACTION_RENAME = Message.LABEL_RENAME
+ACTION_SELECT_FROM = Message.LABEL_SELECT_FROM
+ACTION_SELECT_TO = Message.LABEL_SELECT_TO
+ACTION_COPY = Message.LABEL_COPY
+ACTION_PASTE = Message.LABEL_PASTE
+ACTION_DUPLICATE = Message.LABEL_DUPLICATE
+ACTION_DELETE = Message.LABEL_DELETE
+ACTION_REFRESH = Message.LABEL_REFRESH
+ACTION_STEPS = Message.LABEL_STEPS
+ACTION_BROWSE = Message.LABEL_BROWSE
+ACTION_DB = Message.LABEL_DB
+ACTION_TREE = Message.LABEL_TREE
+ACTION_STOP = Message.LABEL_STOP
+ACTION_DEFAULT = Message.LABEL_DEFAULT
+ACTION_CONTINUE = Message.LABEL_CONTINUE
+ACTION_RESULTS = Message.LABEL_ANALYZE
+ACTION_EXPORT = Message.LABEL_EXPORT
+ACTION_EXPORT_UPLOAD = Message.LABEL_EXPORT_UPLOAD
+ACTION_SWITCH_VIEW = 'Switch_View'
+ACTION_COLLAPSE = 'Collapse'
+ACTION_EXPAND = 'Expand'
+ACTION_LABELS = 'Labels'
+ACTION_RESTART_WORKFLOW = Message.LABEL_RESTART_WORKFLOW
+ACTION_CONTINUE_WORKFLOW = Message.LABEL_CONTINUE_WORKFLOW
+ACTION_STOP_WORKFLOW = Message.LABEL_STOP_WORKFLOW
+ACTION_RESET_WORKFLOW = Message.LABEL_RESET_WORKFLOW
+ACTION_SEARCH = 'Search'
+
+ActionIcons = {
+    ACTION_NEW: Icon.ACTION_NEW,
+    ACTION_EDIT: Icon.ACTION_EDIT,
+    ACTION_SELECT_FROM: Icon.ACTION_SELECT_FROM,
+    ACTION_SELECT_TO: Icon.ACTION_SELECT_TO,
+    ACTION_DUPLICATE: Icon.ACTION_DUPLICATE,
+    ACTION_COPY: Icon.ACTION_COPY,
+    ACTION_PASTE:Icon.ACTION_PASTE,
+    ACTION_DELETE: Icon.ACTION_DELETE,
+    ACTION_REFRESH: Icon.ACTION_REFRESH,
+    ACTION_RENAME: Icon.ACTION_RENAME,
+    ACTION_STEPS: Icon.CODE_BRANCH,
+    ACTION_BROWSE: Icon.ACTION_BROWSE,
+    ACTION_DB: Icon.ACTION_DB,
+    ACTION_TREE: None,  # should be set
+    ACTION_STOP: Icon.ACTION_STOP,
+    ACTION_CONTINUE: Icon.ACTION_CONTINUE,
+    ACTION_RESULTS: Icon.ACTION_RESULTS,
+    ACTION_EXPORT: Icon.ACTION_EXPORT,
+    ACTION_EXPORT_UPLOAD: Icon.ACTION_EXPORT_UPLOAD,
+    ACTION_COLLAPSE: Icon.ACTION_COLLAPSE,
+    ACTION_EXPAND: Icon.ACTION_EXPAND,
+    ACTION_LABELS: Icon.TAGS,
+    ACTION_RESTART_WORKFLOW: Icon.BACKWARD,
+    ACTION_CONTINUE_WORKFLOW: Icon.ACTION_CONTINUE,
+    ACTION_STOP_WORKFLOW: Icon.ACTION_STOP_WORKFLOW,
+    ACTION_RESET_WORKFLOW: Icon.BROOM,
+    ACTION_SEARCH: Icon.ACTION_SEARCH,
+}
+
+# TODO: Centralize this and the 2 above collections
+ActionShortCuts = {
+    ACTION_NEW: "<Control-f>",
+    # F keys
+    ACTION_RENAME: "<F2>",
+    ACTION_REFRESH: "<F5>",
+    # Letter keys, uppercase first, sorted
+    ACTION_COLLAPSE: "-",
+    ACTION_EXPAND: "+",
+    ACTION_RESULTS: "a",
+    ACTION_BROWSE: "b",
+    ACTION_CONTINUE_WORKFLOW:"c",
+    ACTION_DB: "d",
+    ACTION_EDIT: "e",
+    ACTION_SELECT_FROM: "f",
+    ACTION_LABELS: "l",
+    ACTION_TREE: "o",
+    ACTION_RESTART_WORKFLOW: "R",
+    ACTION_RESET_WORKFLOW:"r",
+    ACTION_STEPS: "S",
+    ACTION_STOP: "s",
+    ACTION_SELECT_TO: "t",
+    # Control +, sorted
+    ACTION_COPY: "<Control-c>",
+    ACTION_DUPLICATE: "<Control-d>",
+    ACTION_PASTE: "<Control-v>",
+    ACTION_STOP_WORKFLOW: "<Control-s>",
+    ACTION_DELETE: "<Delete>",
+
+
+}

pyworkflow/gui/project/labels.py

@@ -0,0 +1,205 @@
+# **************************************************************************
+# *
+# * Authors:     J.M. De la Rosa Trevin (jmdelarosa@cnb.csic.es)
+# *
+# * Unidad de  Bioinformatica of Centro Nacional de Biotecnologia , CSIC
+# *
+# * This program is free software; you can redistribute it and/or modify
+# * it under the terms of the GNU General Public License as published by
+# * the Free Software Foundation; either version 3 of the License, or
+# * (at your option) any later version.
+# *
+# * This program is distributed in the hope that it will be useful,
+# * but WITHOUT ANY WARRANTY; without even the implied warranty of
+# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# * GNU General Public License for more details.
+# *
+# * You should have received a copy of the GNU General Public License
+# * along with this program; if not, write to the Free Software
+# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+# * 02111-1307  USA
+# *
+# *  All comments concerning this program package may be sent to the
+# *  e-mail address 'scipion@cnb.csic.es'
+# *
+# **************************************************************************
+"""
+Tree widget implementation.
+"""
+        
+import tkinter as tk
+
+
+from pyworkflow import Config
+from pyworkflow.project import Label
+from pyworkflow.gui import Icon, configureWeigths, getDefaultFont
+from pyworkflow.gui.tree import TreeProvider
+import pyworkflow.gui.dialog as dialog
+
+
+class LabelsTreeProvider(TreeProvider):
+    """ Populate Tree from Labels. """
+    def __init__(self, objList=None):
+        TreeProvider.__init__(self)
+        self.objList = objList
+        self._parentDict = {}
+
+    def getColumns(self):
+        return [('name', 300), ('color', 150)]
+
+    def getObjectInfo(self, label:Label):
+
+        return {'key': label.getName(), 'parent': None,
+                'text': label.getName(), 'values': (label.getColor()),
+                'tags': label.getColor()}
+
+    def getObjectPreview(self, obj):
+        return None, None
+
+    def getObjectActions(self, obj):
+        return []
+
+    def _getObjectList(self):
+        """Retrieve the object list"""
+        return self.objList
+
+    def getObjects(self):
+        objList = self._getObjectList()
+        return objList
+
+    def configureTags(self, tree):
+        for label in self.getObjects():
+            tree.tag_configure(label.getColor(), background=label.getColor())
+
+
+class LabelsDialog(dialog.ToolbarListDialog):
+    """
+    This class extend from ListDialog to allow an
+    extra toolbar to handle operations over the elements
+    in the list (e.g. Edit, New, Delete).
+    """
+    def __init__(self, parent, labels, **kwargs):
+        """ From kwargs:
+                message: message tooltip to show when browsing.
+                selected: the item that should be selected.
+                validateSelectionCallback:
+                    a callback function to validate selected items.
+                allowSelect: if set to False, the 'Select' button will not
+                    be shown.
+        """
+        self.labels = labels
+        toolbarButtons = [
+            dialog.ToolbarButton('Add', self._addLabel, Icon.ACTION_NEW),
+            dialog.ToolbarButton('Edit', self._editLabel, Icon.ACTION_EDIT),
+            dialog.ToolbarButton('Delete', self._deleteLabel, Icon.ACTION_DELETE)
+        ]
+
+        helpMsg ="Select the label to edit or delete. Selected labels will be assigned to selected protocols." \
+                 "\nUse 'Control' key for multiple selection. Do not select any label to clear the labels of selected protocols."
+
+        dialog.ToolbarListDialog.__init__(self, parent,
+                                          "Manage labels",
+                                          LabelsTreeProvider(labels),
+                                          helpMsg,
+                                          toolbarButtons,
+                                          allowsEmptySelection=True,
+                                          itemDoubleClick=self._editLabel,
+                                          cancelButton=False,
+                                          **kwargs)
+
+    def _newColor(self):
+        """ Pick a color by default for a given label from a predefined list.
+         Check that the color have not been used by other label.
+        """
+        colors = ["#e57373", "#4fc3f7", "#81c784", "#ff8a65", "#9575cd",
+                  "#a1887f", "#ffd54f", "#dce775", "#4db6ac"]
+
+        for c in colors:
+            if all(l.getColor().lower() != c for l in self.labels):
+                return c
+
+        return 'red'
+
+    def _addLabel(self, e=None):
+        label = Label(color=self._newColor())
+        dlg = EditLabelDialog(self, "Add label", label)
+        if dlg.resultYes():
+            self.labels.addLabel(label)
+            self.tree.update()
+
+    def _editLabel(self, e=None):
+        selection = self.tree.getSelectedObjects()
+        if selection:
+            label = selection[0]
+            dlg = EditLabelDialog(self, "Edit label", label)
+            if dlg.resultYes():
+                self.tree.update()
+
+    def _deleteLabel(self, e=None):
+        selection = self.tree.getSelectedObjects()
+        if selection:
+            labelsStr = '\n'.join('- %s' % l.getName() for l in selection)
+            if dialog.askYesNo("Delete a label",
+                               "Are you sure to delete the "
+                               "following label(s)?\n %s" % labelsStr, self):
+                for label in selection:
+                    self.labels.deleteLabel(label)
+                self.tree.update()
+
+
+class EditLabelDialog(dialog.Dialog):
+    """ Dialog to edit a label (name, color) """
+    def __init__(self, parent, title, label, **kwargs):
+        self.label = label
+        dialog.Dialog.__init__(self, parent, title)
+
+    def body(self, bodyFrame):
+        bodyFrame.config(bg=Config.SCIPION_BG_COLOR)
+        configureWeigths(bodyFrame, 1, 1)
+
+        # Label
+        label_text = tk.Label(bodyFrame, text="Name", bg=Config.SCIPION_BG_COLOR, bd=0)
+        label_text.grid(row=0, column=0, sticky='nw', padx=(15, 10), pady=15)
+        # Label box
+        var = tk.StringVar()
+        var.set(self.label.getName())
+        self.textVar = var
+        self.textLabel = tk.Entry(bodyFrame, width=20, font=getDefaultFont(), textvariable=var)
+        self.textLabel.grid(row=0, column=1, sticky='news', padx=5, pady=5)
+
+        # Comment
+        colorLabel = tk.Label(bodyFrame, text='Color \n(Click to change)',
+                              bg=Config.SCIPION_BG_COLOR, bd=0)
+        colorLabel.grid(row=1, column=0, sticky='nw', padx=(15, 10), pady=15)
+        self.colorVar = tk.StringVar()
+        self.colorVar.set(self.label.getColor())
+        self.colorBox = tk.Frame(bodyFrame, bg=self.colorVar.get())
+        self.colorBox.grid(row=1, column=1, sticky='news', padx=5, pady=5)
+        colorLabel.bind('<Button-1>', self._changeColor)
+        self.colorBox.bind('<Button-1>', self._changeColor)
+
+    def apply(self):
+        self.label.setName(self.textVar.get())
+        self.label.setColor(self.colorVar.get())
+
+    def _changeColor(self, e=None):
+        hexColor = dialog.askColor(parent=self, defaultColor=self.colorVar.get())
+        if hexColor is not None:
+            self.colorBox.config(bg=hexColor)
+            self.colorVar.set(hexColor)
+
+    def validate(self):
+
+        validationMsg = None
+
+        if len(self.textVar.get().strip()) == 0:
+            validationMsg = "Label name can't be empty.\n"
+
+        if validationMsg is not None:
+            dialog.showError("Validation error", validationMsg, self)
+            return False
+
+        return True
+
+
+