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

pyworkflow/gui/widgets.py

@@ -1,307 +0,0 @@
-# **************************************************************************
-# *
-# * Authors:     J.M. De la Rosa Trevin (delarosatrevin@scilifelab.se) [1]
-# *
-# * [1] SciLifeLab, Stockholm University
-# *
-# * 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, see <https://www.gnu.org/licenses/>.
-# *
-# *  All comments concerning this program package may be sent to the
-# *  e-mail address 'scipion@cnb.csic.es'
-# *
-# **************************************************************************
-"""
-Some basic GUI widgets are implemented in this module.
-The widgets here are suppose to be used to build more complex 
-elements.
-"""
-
-import tkinter as tk
-import tkinter.ttk as ttk
-
-from math import ceil
-
-import pyworkflow
-from pyworkflow import TK_GRAY_DEFAULT, Config
-
-from . import gui
-from .tooltip import ToolTip
-
-
-class Button(tk.Button):
-    _images = {}
-
-    def __init__(self, master, text, imagePath=None, tooltip=None, **opts):
-        defaults = {}
-        # Used to be {'font': gui.fontButton} but there is no such
-        # definition in pyworkflow/gui.
-        defaults.update(opts)
-
-        if 'bg' in defaults and defaults['bg'] is None:
-            del defaults['bg']
-
-        if imagePath is not None:
-            btnImage = gui.getImage(imagePath)
-        else:
-            btnImage = None
-
-        if btnImage is not None:
-            if 'compound' not in defaults:
-                defaults['compound'] = tk.LEFT
-            tk.Button.__init__(self, master, text=text, image=btnImage, **defaults)
-            self.image = btnImage
-        else:
-            tk.Button.__init__(self, master, text=text, **defaults)
-
-        if tooltip:
-            ToolTip(self, tooltip, 500)
-
-    def setImage(self, imagePath):
-        self.image = gui.getImage(imagePath)
-        self.config(image=self.image)
-
-
-class HotButton(Button):
-    """ Button having the firebrick color and some other settings. """
-
-    def __init__(self, master, text, imagePath=None, tooltip=None, **opts):
-        defaults = {'activebackground': gui.cfgButtonActiveBgColor, 'bg': gui.cfgButtonBgColor,
-                    'fg': gui.cfgButtonFgColor, 'activeforeground': gui.cfgButtonActiveFgColor,
-                    'compound': tk.LEFT}
-        defaults.update(opts)
-        Button.__init__(self, master, text, imagePath, tooltip, **defaults)
-
-
-class IconButton(HotButton):
-    """ Hot button, but only with image and no border """
-
-    def __init__(self, master, text, imagePath, tooltip=None, **opts):
-        defaults = {'bd': 0, 'bg': Config.SCIPION_BG_COLOR, 'compound': tk.NONE}
-        defaults.update(opts)
-        HotButton.__init__(self, master, text, imagePath, tooltip, **defaults)
-
-
-class AutoScrollbar(tk.Scrollbar):
-    """"A scrollbar that hides itself if it's not needed."""
-
-    def set(self, lo, hi):
-        if float(lo) <= 0.0 and float(hi) >= 1.0:
-            self.grid_remove()
-            # self.tk.call("grid", "remove", self)
-        else:
-            self.grid()
-        tk.Scrollbar.set(self, lo, hi)
-
-
-class Scrollable(object):
-    """This is a base class for all scrollable widgets.
-    If it is enabled, it will wrap the widget with a frame
-    and will add vertical and horizontal AutoScrollbar"""
-
-    def __init__(self, master, WidgetClass, frame=True, **opts):
-        if frame:
-            self.frame = tk.Frame(master)
-            self.frame.rowconfigure(0, weight=1)
-            self.frame.columnconfigure(0, weight=1)
-            self.vscroll = AutoScrollbar(self.frame)
-            self.vscroll.grid(row=0, column=1, sticky='ns')
-            self.hscroll = AutoScrollbar(self.frame, orient=tk.HORIZONTAL)
-            self.hscroll.grid(row=1, column=0, sticky='ew')
-            WidgetClass.__init__(self, self.frame,
-                                 yscrollcommand=self.vscroll.set,
-                                 xscrollcommand=self.hscroll.set, **opts)
-            self.vscroll.config(command=self.yview)
-            self.hscroll.config(command=self.xview)
-            self.grid(row=0, column=0, sticky='news')
-            self.grid = self.frame.grid
-            self.grid_remove = self.frame.grid_remove
-        else:
-            WidgetClass.__init__(self, master, **opts)
-
-        # Bind ourselves
-        self.bindWidget(self)
-
-
-    def scroll(self, event):
-        print("Deprecated, use scrollV")
-        self.scrollV(event)
-
-    def scrollV(self, event):
-        self._basescroll(event, self.yview)
-
-    def scrollH(self, event):
-        self._basescroll(event, self.xview)
-
-    def _basescroll(self, event, view):
-
-        if event.num == 5 or event.delta < 0:
-            count = 1
-        if event.num == 4 or event.delta > 0:
-            count = -1
-        view("scroll", count, "units")
-
-    def bindWidget(self, widget):
-        """ Make the scroll in the widget, respond to this.
-        Useful for child widgets.
-        """
-        # with Windows OS
-        widget.bind("<MouseWheel>", self.scrollV)
-        # with Linux OS
-        widget.bind("<Button-4>", self.scrollV)
-        widget.bind("<Button-5>", self.scrollV)
-
-        widget.bind("<Shift-Button-4>", self.scrollH)
-        widget.bind("<Shift-Button-5>", self.scrollH)
-
-
-    def getVScroll(self):
-        return self.vscroll.get()
-
-    def getHScroll(self):
-        return self.hscroll.get()
-
-
-class ExplanationText(tk.Text):
-    """Create an explanation text box"""
-
-    def __init__(self, frame, text='', bg=TK_GRAY_DEFAULT, border=0, wrap='word'):
-        self.text = tk.Text(frame, bg=bg, wrap=wrap, border=border)
-        self.updateExpText(text)
-
-    def updateExpText(self, text, width=50):
-        # Adapt textbox height to text length (width is in characters)
-        n_lines = ceil(len(text) / width)
-
-        self.text.config(state='normal', height=n_lines)  # Make it editable
-        self.text.insert(tk.END, text)
-        self.text.config(state='disabled')  # Disable text edit
-
-
-class LabelSlider(ttk.Frame):
-    """ Create a personalized frame that contains label, slider and label value
-        it also keeps a variable with the value """
-
-    def __init__(self, master, label, from_=0, to=100, value=50, callback=None, step=0.01, length=None,
-                 labelWidth=None, tickinterval=None, showvalue=None):
-        self.selectedLabelText = '=> {}'.format(label)
-        self.labelText = '   {}'.format(label)
-        self.var = tk.DoubleVar()
-        self.var.set(float(value))
-        ttk.Frame.__init__(self, master)
-        self.labelWidget = ttk.Label(self, text=self.labelText, width=labelWidth)
-        self.slider = tk.Scale(self, from_=from_, to=to, variable=self.var,
-                               bigincrement=step, resolution=step, orient=tk.HORIZONTAL, length=length,
-                               tickinterval=tickinterval, showvalue=showvalue)
-        if callback:
-            self.var.trace('w', callback)
-
-        self.labelWidget.grid(row=0, column=0, sticky='nes', padx=5, pady=5)
-        self.slider.grid(row=0, column=1, sticky='news', padx=5, pady=5)
-        self.columnconfigure(1, weight=3)
-
-    def get(self):
-        return self.var.get()
-
-    def highlightLabel(self):
-        self.labelWidget.config(text=self.selectedLabelText)
-
-    def removeHighlightFromLabel(self):
-        self.labelWidget.config(text=self.labelText)
-
-
-class ComboBox(ttk.Combobox):
-    """ Extension of ttk.ComboBox to allow having different display text and values.
-    Also adding some utils to getSelected index and value (same for set)
-    """
-
-    def __init__(self, parent, choices, values=None, initial=None, onChange=None, **kwargs):
-        """ Create a combobox from a list of choices.
-        Params:
-            parent: the parent widget (required by Tkinter)
-            choices: a list with the options to be shown.
-            values: if None, will enumerate from 0 to len(choices)-1
-                if a list is provided, should have the same length as choices.
-            initial: if None, take the first choice
-            onChange: provide a callback function to be used when change the selected value
-            **kwargs: extra arguments passed to ttk.Combobox constructor.
-        """
-        indexes = range(len(choices))
-        if values is None:
-            values = indexes
-        choices = [str(c) for c in choices]  # Convert to a list of strings
-
-        if initial is None:
-            initial = choices[0]
-        self._valuesDict = dict(zip(choices, values))
-        self._indexDict = dict(zip(choices, indexes))
-
-        self._var = tk.StringVar()
-        self._var.set(initial)
-        self._changeCallback = onChange
-        self._var.trace('w', self._onChanged)
-        ttk.Combobox.__init__(self, parent, textvariable=self._var, state='readonly', **kwargs)
-        self['values'] = choices
-
-    def getValue(self):
-        """ Return the selected value. """
-        return self._valuesDict[self._var.get()]
-
-    def getIndex(self):
-        """ Return the selected value. """
-        return self._indexDict[self._var.get()]
-
-    def getText(self):
-        """ Return the selected option text. """
-        return self._var.get()
-
-    def setChangeCallback(self, callback):
-        self._changeCallback = callback
-
-    def _onChanged(self, *args):
-        if self._changeCallback:
-            self._changeCallback(self)
-
-
-class GradientFrame(tk.Canvas):
-    """A gradient frame which uses a canvas to draw the background
-    Taken from:
-        http://stackoverflow.com/questions/11892521/tkinter-custom-window
-    """
-
-    def __init__(self, parent, **args):
-        tk.Canvas.__init__(self, parent, **args)
-        self._color1 = Config.SCIPION_BG_COLOR #"#d2a7a7"
-        self._color2 = Config.SCIPION_MAIN_COLOR #"#820808"
-        self.bind("<Configure>", self._draw_gradient)
-
-    def _draw_gradient(self, event=None):
-        self.delete("gradient")
-        width = self.winfo_width()
-        height = self.winfo_height()
-        limit = width // 2
-        r1, g1, b1 = self.winfo_rgb(self._color1)
-        r2, g2, b2 = self.winfo_rgb(self._color2)
-        r_ratio = (r2 - r1) / limit
-        g_ratio = (g2 - g1) / limit
-        b_ratio = (b2 - b1) / limit
-
-        for i in range(limit + 1):
-            nr = int(r1 + (r_ratio * i))
-            ng = int(g1 + (g_ratio * i))
-            nb = int(b1 + (b_ratio * i))
-            color = "#%4.4x%4.4x%4.4x" % (nr, ng, nb)
-            self.create_line(i, 0, i, height, tags=("gradient",), fill=color)
-            self.create_line(width - i, 0, width - i, height,
-                             tags=("gradient",), fill=color)
-        self.lower("gradient")

pyworkflow/mapper/__init__.py

@@ -1,26 +0,0 @@
-# -*- coding: utf-8 -*-
-# **************************************************************************
-# *
-# * Authors:     J.M. De la Rosa Trevin (delarosatrevin@scilifelab.se) [1]
-# *
-# * [1] SciLifeLab, Stockholm University
-# *
-# * 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, see <https://www.gnu.org/licenses/>.
-# *
-# *  All comments concerning this program package may be sent to the
-# *  e-mail address 'scipion@cnb.csic.es'
-# *
-# **************************************************************************
-from .mapper import Mapper
-from .sqlite import SqliteMapper, SqliteDb, SqliteFlatMapper, SqliteFlatDb

pyworkflow/mapper/mapper.py

@@ -1,222 +0,0 @@
-# **************************************************************************
-# *
-# * 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'
-# *
-# **************************************************************************
-import logging
-logger = logging.getLogger(__name__)
-
-import pyworkflow.object as obj
-
-
-class Mapper:
-    """This class will serves as a Data Mapper pattern.
-    It will store/retrieve objects from some storage environment.
-    (like SQL, XML or others)
-    The mapper should have access to class dictionary
-    in order to build any give class by name"""
-    
-    # Just to avoid print several times the same warning
-    __warnings = set()
-
-    ORIGINAL_CLASS_NAME_ATTRIBUTE = "oldClassName"
-
-    @staticmethod
-    def annotateClassName(instance, oldClassName):
-        """ Annotate an object with the original class name"""
-        setattr(instance, Mapper.ORIGINAL_CLASS_NAME_ATTRIBUTE, oldClassName)
-
-    @staticmethod
-    def getObjectPersistingClassName(instance):
-        if hasattr(instance, Mapper.ORIGINAL_CLASS_NAME_ATTRIBUTE):
-            return getattr(instance, Mapper.ORIGINAL_CLASS_NAME_ATTRIBUTE)
-        else:
-            return instance.getClassName()
-
-    def __init__(self, dictClasses=None):
-        if dictClasses:
-            self.dictClasses = dictClasses 
-        else:
-            self.dictClasses = dir(obj)
-            
-    def warning(self, msg):
-        if msg not in self.__warnings:
-            print("WARNING: %s" % msg)
-            self.__warnings.add(msg)
-    
-    def _buildObjectFromClass(self, className):
-        """ Build an instance of an object
-        given the class name, it should be in 
-        the classes' dictionary.
-
-        If class is missing, then the default class is used ("LegacyProtocol") and warns about it
-        """
-        if className not in self.dictClasses:
-            self.warning("Class '%s' not found in mapper dict. Ignored. "
-                         % className)
-            return None
-        
-        objClass = self.dictClasses[className]
-        
-        if not issubclass(objClass, obj.Object):
-            logger.warning("WARNING: Class '%s' is not a subclass of Object. Ignored. " % className)
-            return None
-
-        try:
-            instance = self.dictClasses[className]()
-        except Exception as e:
-            clazz = self.dictClasses._default
-            logger.error('Class %s could not be created. Replacing it with %s ' % (className, clazz.__name__), exc_info=e)
-            instance = clazz()
-
-        # If it's the default class in the dictionary
-        if objClass.__name__ != className:
-            # ... annotate original class name
-            self.annotateClassName(instance, className)
-
-        return instance
-
-    def _getStrValue(self, value):
-        """ Return empty string if value is None or empty. """
-        if not value:
-            return ''
-        return value
-    
-    def commit(self):
-        """Commit changes made to the storage"""
-        pass
-    
-    def insert(self, obj):
-        """Insert a new object into the system, the id will be set"""
-        pass
-    
-    def update(self, obj, direction='to'):
-        """Update an existing object, the id should not be None
-        direction can be "to" or "from" which indicates the 
-        priority of the update.
-        If "to" is used, object data is put in storage.
-        If "from", object data is retrieved from storage"""
-        if direction == 'to':  # Update db with object changes
-            self.updateTo(obj)
-        elif direction == 'from':  # Update object with db info
-            self.updateFrom(obj)
-        else:
-            raise Exception('Invalid option %s for Sqlite.updateObject' % direction)
-    
-    def updateFrom(self, obj):
-        """Update object data with storage info"""
-        pass
-    
-    def updateTo(self, obj):
-        """Update storage with object info"""
-        pass
-    
-    def store(self, obj):
-        """Stores an object, it can be inserted or updated"""
-        if obj._objId is None:
-            self.insert(obj)
-        else:
-            self.updateTo(obj)
-            
-    def selectById(self, objId):
-        """Return the object which id is objId"""
-        pass
-
-    def exists(self, objId):
-        """Return True if the id is in the database"""
-        pass
-
-    def selectAll(self, iterate=False):
-        """Return all object from storage"""
-        pass
-    
-    def selectFirst(self):
-        """Return only the first element"""
-        for obj in self.selectAll(iterate=True):
-            return obj
-        return None
-    
-    def selectBy(self, **args):
-        """Select object meetings some criteria"""
-        pass 
-    
-    def selectByClass(self, className, includeSubclasses=True):
-        """Select all object of a give class.
-        By default object of subclasses will be retrieved also.
-        This behaviour can be changed by passing includeSubclass=False"""
-        return self.selectBy(classname=className)
-    
-    def getParent(self, obj):
-        """ Retrieve the parent object of another. """
-        pass
-
-    def getFullName(self, obj):
-        """ Return the full object name such as:
-        grandparent.parent.objName
-        """
-        nameParts = []
-        parent = obj
-        
-        while parent:
-            nameParts.insert(0, parent.getLastName())
-            parent = self.getParent(parent)
-            
-        return '.'.join(nameParts)
-            
-    def insertRelation(self, relName, creatorObj, parentObj, childObj):
-        """ This function will add a new relation between two objects.
-        Params:
-            relName: the name of the relation to be added.
-            creatorObj: this object will be the one who register the relation.
-            parentObj: this is "parent" in the relation
-            childObj: this is "child" in the relation
-        """
-        pass
-    
-    def getRelationChilds(self, relName, parentObj):
-        """ Return all "child" objects for a given relation.
-        Params:
-            relName: the name of the relation.
-            parentObj: this is "parent" in the relation
-        Returns: 
-            a list of "child" objects.
-        """
-        pass  
-            
-    def getRelationParents(self, relName, childObj):
-        """ Return all "parent" objects for a given relation.
-        Params:
-            relName: the name of the relation.
-            childObj: this is "child" in the relation
-        Returns: 
-            a list of "parent" objects.
-        """
-        pass
-    
-    def getRelationsByCreator(self, creatorObj):
-        """ Return all relations created by creatorObj. """
-        pass
-    
-    def deleteRelations(self, creatorObj):
-        """ Delete all relations created by object creatorObj """
-        pass