Rank: Move TableView and TableModel to gui

[ajdapretnar]

Issue

Rank's TableView and TableModel are not independent modules that can be called for other widgets.

Description of changes

Move the two classes to gui.py, so other widgets can use them.

Includes

• Code changes
• Tests
• Documentation

[codecov]

Codecov Report

Merging #6098 (263b782) into master (9d73b8e) will decrease coverage by 0.00%.
The diff coverage is 85.91%.

❗ Current head 263b782 differs from pull request most recent head 7bcc2f7. Consider uploading reports for the commit 7bcc2f7 to get more accurate results

@@            Coverage Diff             @@
##           master    #6098      +/-   ##
==========================================
- Coverage   86.63%   86.62%   -0.01%     
==========================================
  Files         315      315              
  Lines       67560    67559       -1     
==========================================
- Hits        58531    58524       -7     
- Misses       9029     9035       +6     

[janezd]

I agree, but I fear we already have a plentitude of table models and views. Quick check showed it may not be so bad; details below. Still, please

• Rename TableModel into something more meaningful, e.g. BarTableModel (still, it is not the only model to provide bars)
• Add a docstring
• I'm not sure TableView adds anything that warrants moving it from owrank to widgets.gui. All visual settings and selection-related behaviour may be specific to the rank widget.

Now for my "brief analysis":

Models

General table models

orangewidget.utils.itemmodels.AbstractSortTableModel:

A sorting proxy table model that sorts its rows in fast numpy, avoiding potentially thousands of calls into `QSortFilterProxyModel.lessThan()` or any potentially costly reordering of original data. Override `sortColumnData()`, adapting it to your underlying model.

Orange.widgets.utils.itemmodels.AbstractSortTableModel(AbstractSortTableModel):

Add two deprecated methods for backward compatibility

Orange.widgets.utils.itemmodels.PyTableModel(AbstractSortTableModel):

A model for displaying python tables (sequences of sequences) in `QTableView objects`.

Orange.widgets.utils.itemmodels.TableModel(AbstractSortTableModel):

An adapter for using Orange.data.Table within Qt's Item View Framework. Also adds VariableStatsRole (min, max, etc.) and DomainRole (attr, class, meta)

Table models defined in widget modules (excluding specific models, such as those in Feature Statistics, Distance Matrix, Predictions...)

Orange.widgets.data.owtable.RichTableModel(TableModel):

Add BarRole and information for headers (attributes of attributes)

Orange.widgets.data.owrank.TableModel:

Add a BarRatioRole that returns Data, normalized between the extremes. In sorting, put NaNs last.

Views

Orange.widgets.utils.tableview.TableView(QTableView):

A QTableView subclass that is more suited for displaying large data models. Provides a `selectionFinished` signal that is emitted when selection is finished, but not during selecting.

orangewidget.gui.TableView(QTableView):

An auxiliary table view for use with PyTableModel in control areas. Essentially about sizing, and a delegate that may print some text in bold.

**I believe we should deprecate or at least rename this class** because it is being used instead of `QTableView`. It may be indeed useful in evaluation widgets, though I'm not sure - it may also be redundant there. There are some eclatant misuses, such as importing it to get an enum, which is actually defined in `QTableView`.</dd>

[ajdapretnar]

@janezd I did as suggested. The alternative is to simply copy the code from Rank into OWCollocations (biolab/orange3-text#782), which would also simplify release-making (Collocations would depend on releasing master first).

I am fine with either option, whatever you think is best.

[janezd]

Could you, please, also move this test to Orange.widgets.tests.test_gui?

[ajdapretnar]

Done. I just wasn't sure whether to rename the test...

[janezd]

I apologize for being such a nazi. We, that is pylint and I, think that you should also clean and rearrange your imports.

[ajdapretnar]

I know. I was waiting for hints from the lint run. I don't know how to run it locally so.... 🤷‍♀️