1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
|
"""Tests for the Table widget."""
import os
import sys
import pytest
from magicgui.widgets import PushButton, Slider, Table
attr_xfail = pytest.mark.xfail(
bool(os.getenv("CI")), reason="periodic AttributeError", raises=AttributeError
)
_TABLE_DATA = {
# column-dict-of-lists
"list": {"col_1": [1, 4], "col_2": [2, 5], "col_3": [3, 6]},
# column-dict-of-row-dicts
"dict": {
"col_1": {"r1": 1, "r2": 4},
"col_2": {"r1": 2, "r2": 5},
"col_3": {"r1": 3, "r2": 6},
},
# list-of-lists
"data": [[1, 2, 3], [4, 5, 6]],
# Records: List-of-column-dict
"records": [
{"col_1": 1, "col_2": 2, "col_3": 3},
{"col_1": 4, "col_2": 5, "col_3": 6},
],
# 3-tuple of data, index, column
"tuple": ([[1, 2, 3], [4, 5, 6]], ("r1", "r2"), ("c1", "c2", "c3")),
# split-dict
"split": {
"data": [[1, 2, 3], [4, 5, 6]],
"index": ("r1", "r2"),
"columns": ("c1", "c2", "c3"),
},
}
@pytest.mark.parametrize("key", _TABLE_DATA)
def test_table(key):
"""Test a few ways to input tables."""
_input = _TABLE_DATA[key]
table = Table(value=_input)
if key == "split":
assert table.value == _input
if key not in ("tuple", "data"):
# make sure the output is the same as the input
assert table.to_dict(key) == _input
# can also test equality of table widgets
assert Table(value=table.to_dict(key)) == table
table.row_headers = ("x", "x")
table.column_headers = ("a", "a", "b")
with pytest.warns(UserWarning):
table.to_dict(key)
def test_constructor():
"""Test various combinations of data, index, column."""
t = Table(index=["r"], columns=["a", "b"], name="My Table")
assert t.shape == (1, 2)
assert t.row_headers == ("r",)
assert tuple(t) == ("a", "b")
assert repr(t).split(" at")[0] == "Table(name='My Table', shape=(1, 2)"
t = Table(index=["a", "b"], columns=["c"])
assert t.shape == (2, 1)
assert t.row_headers == ("a", "b")
assert t.column_headers == ("c",)
assert Table([1, 2]).shape == (2, 1) # single list is interpreted as column
assert Table([[1, 2]]).shape == (1, 2) # nested lists are rows
# arguments to constructor override those in a dict value
t = Table(_TABLE_DATA["dict"], columns=("x", "y", "z"))
assert t.column_headers == ("x", "y", "z")
# data and headers can be provided separately
t = Table([[1, 2, 3], [4, 5, 6]], columns=["col_1", "col_2", "col_3"])
assert dict(t) == _TABLE_DATA["list"]
# or together
assert t == Table(_TABLE_DATA["list"])
with pytest.warns(UserWarning):
# more columns than provided... truncated to provided columns
assert Table([[1, 2]], index=["a"], columns=["v"]).shape == (1, 1)
with pytest.raises(ValueError):
# more rows than provided index, raises
Table([[1], [2]], index=["a"], columns=["v"])
with pytest.raises(ValueError):
# same as above
Table([1, 2], index=["a"], columns=["v"])
def test_adding_deleting_to_empty_table():
"""Test the dict-like api starting with empty table."""
table = Table()
assert not any(table.data.to_list())
assert table.shape == (0, 0)
# add a new column
table["c1"] = [1, 2, 3, 4]
assert table["c1"] == [1, 2, 3, 4]
assert table.shape == (4, 1)
# add one with more data
table["c2"] = [1, 2, 3, 4, 5, 6]
assert table.shape == (6, 2)
# add one with less data
table["c3"] = [1, 2, 3]
assert table.shape == (6, 3)
assert table.size == 18
assert table["c3"][5] is None # it fills to meet the rows
assert table.row_headers == (0, 1, 2, 3, 4, 5)
assert table._get_row(table.row_headers[0]) == [1, 1, 1]
table._del_row(table.row_headers[0])
assert table._get_row(table.row_headers[0]) == [2, 2, 2]
# we can use dict methods
table.update({"c1": [1, 1]}) # it will clear the extra...
assert table["c1"] == [1, 1, None, None, None]
# we can del
del table["c2"]
assert "c2" not in table
with pytest.raises(KeyError):
table["c2"] # does not exist
with pytest.raises(TypeError):
# not a collection
table["c5"] = 1 # type: ignore
with pytest.raises(KeyError):
del table["c219"] # does not exist
table.clear()
assert table.shape == (0, 0)
assert not table.column_headers
assert not table.row_headers
@attr_xfail
def test_orient_index():
"""Test to_dict with orient = 'index' ."""
table = Table(value=_TABLE_DATA["dict"])
expected = {
"r1": {"col_1": 1, "col_2": 2, "col_3": 3},
"r2": {"col_1": 4, "col_2": 5, "col_3": 6},
}
assert table.to_dict("index") == expected
table = Table(value=_TABLE_DATA["dict"])
table.row_headers = ("a", "a")
with pytest.warns(UserWarning):
table.to_dict("index")
with pytest.raises(ValueError):
table.to_dict("notathing") # type: ignore
def test_table_from_numpy():
"""Test inputting tables from numpy array."""
np = pytest.importorskip("numpy")
data = np.arange(12).reshape(4, 3)
table = Table(value=data)
assert np.allclose(table.data.to_numpy(), data)
INDICES = (
1,
(2, 2),
(slice(None), 2),
(slice(None), slice(None)),
(slice(1, 3), slice(3)),
(slice(1, None, 3), slice(None, 3)),
slice(None, None, 2),
(slice(None), slice(None, None, 2)),
)
VALUES = (
(7,) * 4,
6,
(7,) * 6,
[[1] * 4] * 6,
[[1] * 3] * 2,
[[1] * 3] * 2,
[[1] * 4] * 3,
[[1] * 2] * 6,
)
@pytest.mark.parametrize("index", INDICES)
def test_dataview_getitem(index):
"""Test that table.data can be indexed like a numpy array."""
np = pytest.importorskip("numpy")
data = np.arange(24).reshape(6, 4)
table = Table(value=data)
assert np.allclose(table.data[index], data[index])
@pytest.mark.parametrize("index, value", zip(INDICES, VALUES))
def test_dataview_setitem(index, value):
"""Test that table.data can be indexed like a numpy array."""
np = pytest.importorskip("numpy")
data = np.arange(24).reshape(6, 4)
table = Table(value=data)
table.data[index] = value
assert not np.allclose(table.data.to_list(), data)
data[index] = value
assert np.allclose(table.data.to_list(), data)
def test_dataview_delitem():
"""Test that table.data can be indexed like a numpy array."""
_input = _TABLE_DATA["dict"]
table = Table(value=_input)
row_keys = table.keys("row") # also demoing keys views
col_keys = table.keys("column") # also demoing keys views
assert list(row_keys) == ["r1", "r2"]
assert list(col_keys) == ["col_1", "col_2", "col_3"]
del table.data[1]
assert table.to_dict("dict") != _input
assert list(row_keys) == ["r1"]
assert list(col_keys) == ["col_1", "col_2", "col_3"]
del table.data[:, 2]
assert list(row_keys) == ["r1"]
assert list(col_keys) == ["col_1", "col_2"]
with pytest.raises(ValueError):
del table.data[0, 0] # cannot delete cells
@attr_xfail
def test_dataview_repr():
"""Test the repr for table.data."""
table = Table(_TABLE_DATA["dict"], name="My Table")
assert (
repr(table.data).split(" at")[0]
== "<Data for Table(name='My Table', shape=(2, 3)"
)
def test_table_from_pandas():
"""Test inputting tables from pandas dataframe."""
pd = pytest.importorskip("pandas", reason="Pandas required for some tables tests")
df = pd.DataFrame.from_dict(_TABLE_DATA["dict"])
table = Table(value=df)
assert pd.DataFrame.equals(table.to_dataframe(), df)
@attr_xfail
def test_orient_series():
"""Test to_dict with orient = 'index' ."""
pd = pytest.importorskip("pandas", reason="Pandas required for some tables tests")
table = Table(value=_TABLE_DATA["dict"])
out = table.to_dict("series")
assert all(isinstance(s, pd.Series) for s in out.values())
ugly_dict = {
"col1": {"r1": 8, "r2": 9},
"col2": {"r1": 10, "r3": 11},
"col3": {"r7": 12, "r9": 12},
}
ugly_records = [{"col1": 1, "col2": 2}, {"col1": 3}, {"col3": 4, "col2": 5}]
def test_joins_with_pandas():
"""Test that pandas can help with ugly data."""
pd = pytest.importorskip("pandas", reason="Pandas required for some tables tests")
t = Table(value=ugly_dict)
assert t.shape == (5, 3)
pd.testing.assert_frame_equal(t.to_dataframe(), pd.DataFrame(ugly_dict))
t2 = Table(value=ugly_records)
assert t2.shape == (3, 3)
pd.testing.assert_frame_equal(t2.to_dataframe(), pd.DataFrame(ugly_records))
def test_joins_without_pandas(monkeypatch):
"""Test that we give a useful error with ugly data if pandas is not available."""
monkeypatch.setitem(sys.modules, "pandas", None)
with pytest.raises(ValueError) as e:
Table(value=ugly_dict)
assert "Install pandas" in str(e)
with pytest.raises(ValueError) as e:
Table(value=ugly_records)
assert "Install pandas" in str(e)
def test_widget_in_table():
"""Test we can put widgets in the table!."""
table = Table()
button = PushButton(text="hi")
slider = Slider(value=50)
table["a"] = [button, 1, slider, "wow!"]
assert table["a"] == [button, 1, slider, "wow!"]
def test_view_reprs():
"""Test our custom DictView objects."""
table = Table(value=_TABLE_DATA["dict"])
assert repr(table.keys()) == "column_headers(['col_1', 'col_2', 'col_3'])"
assert repr(table.keys("column")) == "column_headers(['col_1', 'col_2', 'col_3'])"
assert repr(table.keys("row")) == "row_headers(['r1', 'r2'])"
assert repr(table.items()) == "table_items(3 columns)"
assert repr(table.items("column")) == "table_items(3 columns)"
assert repr(table.items("row")) == "table_items(2 rows)"
def test_row_access_errors():
"""Test various exceptions upon bad access."""
table = Table(value=_TABLE_DATA["dict"])
table._set_row("r1", [9, 9, 9])
assert table._get_row("r1") == [9, 9, 9]
with pytest.raises(KeyError):
table._get_row("nonsense")
with pytest.raises(KeyError):
table._set_row("nonsense", [1, 2, 3])
with pytest.raises(KeyError):
table._del_row("nonsense")
with pytest.raises(IndexError):
table._get_rowi(10)
assert table._assert_col(0) == 0
with pytest.raises(IndexError):
table._assert_col(10)
def test_check_new_headers():
"""Check that we get good error messages when setting bad headers."""
table = Table(value=_TABLE_DATA["dict"])
with pytest.raises(ValueError) as e:
table.column_headers = ("a", "b", "c", "d")
assert "Length mismatch" in str(e)
with pytest.raises(ValueError) as e:
table.row_headers = ("a", "b", "c", "d")
assert "Length mismatch" in str(e)
# these are Qt-specific
def test_copy(qapp):
from qtpy.QtWidgets import QTableWidgetSelectionRange
table = Table(value=_TABLE_DATA["data"])
selrange = QTableWidgetSelectionRange(1, 1, 0, 0)
table.native.setRangeSelected(selrange, True)
table.native._copy_to_clipboard()
assert qapp.clipboard().text() == "1\t2\n4\t5"
def test_paste(qapp):
from qtpy.QtWidgets import QTableWidgetSelectionRange
table = Table(value=_TABLE_DATA["data"])
selrange = QTableWidgetSelectionRange(1, 1, 0, 0)
table.native.setRangeSelected(selrange, True)
qapp.clipboard().setText("0\t0\n1\t1")
table.read_only = True
table.native._paste_from_clipboard()
assert table.data.to_list() == [[1, 2, 3], [4, 5, 6]]
table.read_only = False
table.native._paste_from_clipboard()
assert table.data.to_list() == [[0, 0, 3], [1, 1, 6]]
def test_delete(qapp):
from qtpy.QtWidgets import QTableWidgetSelectionRange
table = Table(value=_TABLE_DATA["data"])
selrange = QTableWidgetSelectionRange(1, 1, 0, 0)
table.native.setRangeSelected(selrange, True)
table.read_only = True
assert table.read_only
table.native._delete_selection()
assert table.data.to_list() == [[1, 2, 3], [4, 5, 6]]
table.read_only = False
assert not table.read_only
table.native._delete_selection()
assert table.data.to_list() == [[None, None, 3], [None, None, 6]]
def test_item_delegate(qapp):
from magicgui.backends._qtpy.widgets import _format_number
data = ["1.2", "1.23456789", "0.000123", "1234567", "0.0", "1", "s"]
results = [_format_number(v, 4) for v in data]
assert results == ["1.2000", "1.2346", "1.230e-04", "1.235e+06", "0.0000", "1", "s"]
def test_row_delete(qapp) -> None:
table = Table(value=_TABLE_DATA["split"])
assert table.data.to_list() == [[1, 2, 3], [4, 5, 6]]
table.delete_row(index=0)
assert table.data.to_list() == [[4, 5, 6]]
table.delete_row(header="r2")
assert table.data.to_list() == []
|