Changeset 1560:94620f900411 in orange-bioinformatics


Ignore:
Timestamp:
02/13/12 13:38:07 (2 years ago)
Author:
ales_erjavec
Branch:
default
Message:

Some code cleanup, added docstrings.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • widgets/OWQualityControl.py

    r1559 r1560  
    2525 
    2626@contextmanager 
    27 def control_disable(widget): 
     27def widget_disable(widget): 
     28    """A context to disable the widget (enabled property)   
     29    """ 
    2830    widget.setEnabled(False) 
    2931    yield 
     
    3234@contextmanager 
    3335def disable_updates(widget): 
     36    """ 
     37    A context that sets '_disable_updates' member to True, and 
     38    then restores it. 
     39     
     40    """ 
    3441    widget._disable_updates = True 
    3542    yield 
     
    3744 
    3845def group_label(splits, groups): 
    39     """ 
    40     Return group label 
     46    """Return group label. 
    4147    """ 
    4248    labels = ["{}={}".format(split, group) \ 
     
    4652 
    4753def sort_label(sort, attr): 
    48     """ 
    49     Return within group sorted items label for attribute. 
     54    """Return within group sorted items label for attribute. 
    5055    """ 
    5156    items = [(key, attr.attributes.get(key, "?")) \ 
     
    5560 
    5661def float_if_posible(val): 
     62    """Return val as float if possible otherwise return the value unchanged. 
     63     
     64    """ 
    5765    try: 
    5866        return float(val) 
     
    6472    settingsList = [] 
    6573     
    66     DISTANCE_FUNCTIONS = [("Distance from Pearson correlation", exp.dist_pcorr), 
    67                           ("Euclidean distance", exp.dist_eucl), 
    68                           ("Distance from Spearman correlation", exp.dist_spearman)] 
     74    DISTANCE_FUNCTIONS = [("Distance from Pearson correlation", 
     75                           exp.dist_pcorr), 
     76                          ("Euclidean distance",  
     77                           exp.dist_eucl), 
     78                          ("Distance from Spearman correlation",  
     79                           exp.dist_spearman)] 
    6980 
    7081    def __init__(self, parent=None, signalManager=None, 
     
    178189         
    179190    def get_suitable_keys(self, data): 
    180         """ Return suitable attr label keys from the data where the key has at least 
    181         two unique values in the data. 
     191        """ Return suitable attr label keys from the data where 
     192        the key has at least two unique values in the data. 
    182193         
    183194        """ 
     
    213224     
    214225    def selected_base_index(self): 
     226        """Return the selected base index 
     227        """ 
    215228        return self.base_index 
    216229 
     
    232245        ## Restore saved context 
    233246        context = self.currentContexts[""] 
    234         split_by_labels= getattr(context, "split_by_labels", set()) 
     247        split_by_labels = getattr(context, "split_by_labels", set()) 
    235248        sort_by_labels = getattr(context, "sort_by_labels", set()) 
    236249         
    237250        def select(model, selection_model, selected_items): 
     251            """Select items in a Qt item model view 
     252            """ 
    238253            all_items = list(model) 
    239254            try: 
     
    242257                indices = [] 
    243258            for ind in indices: 
    244                 selection_model.select(model.index(ind), QItemSelectionModel.Select) 
     259                selection_model.select(model.index(ind),  
     260                                       QItemSelectionModel.Select) 
    245261                 
    246 #        self._disable_updates = True 
    247 #        try: 
    248262        with disable_updates(self): 
    249263            select(self.split_by_view.model(), 
     
    254268                   self.sort_by_view.selectionModel(), 
    255269                   sort_by_labels) 
    256 #        finally: 
    257 #            self._disable_updates = False 
    258270             
    259271        self.split_and_update() 
    260272         
    261273    def on_split_key_changed(self, *args): 
    262         with control_disable(self): 
     274        """Split key has changed 
     275        """ 
     276        with widget_disable(self): 
    263277            if not self._disable_updates: 
    264278                context = self.currentContexts[""] 
     
    267281     
    268282    def on_sort_key_changed(self, *args): 
    269         with control_disable(self): 
     283        """Sort key has changed 
     284        """ 
     285        with widget_disable(self): 
    270286            if not self._disable_updates: 
    271287                context = self.currentContexts[""] 
     
    274290         
    275291    def on_distance_measure_changed(self): 
     292        """Distance measure has changed 
     293        """ 
    276294        self.update_distances() 
    277295        self.replot_experiments() 
    278296         
    279297    def on_view_resize(self, size): 
     298        """The view with the quality plot has changed 
     299        """ 
    280300        if self.main_widget: 
    281301            current = self.main_widget.size() 
     
    286306         
    287307    def on_rug_item_clicked(self, item): 
     308        """An ``item`` in the quality plot has been clicked. 
     309        """ 
    288310        base = item.index 
    289311        if base != self.base_index: 
     
    482504         
    483505    def update_rug_geometry(self): 
     506        """Recompute the rug items positions within this widget. 
     507        """ 
    484508        size = self.size() 
    485509        height = size.height() 
     
    492516 
    493517    def resizeEvent(self, event): 
     518        """Reimplemented from QGraphicsWidget 
     519        """ 
    494520        QGraphicsWidget.resizeEvent(self, event) 
    495521        self.update_rug_geometry() 
    496522 
    497523    def setGeometry(self, geom): 
     524        """Reimplemented from QGraphicsWidget 
     525        """ 
    498526        QGraphicsWidget.setGeometry(self, geom) 
    499527 
Note: See TracChangeset for help on using the changeset viewer.