class BaseTestMatplotlibDataViewer(object):
"""
Base class to test viewers based on MatplotlibDataViewer. This only runs
a subset of tests that relate to functionality implemented in
MatplotlibDataViewer and specific viewers are responsible for implementing
a more complete test suite.
Viewers based on this should inherit from this test class and define the
following attributes:
* ``data``: an instance of a data object that works by default in the viewer
* ``viewer_cls``: the viewer class
It is then safe to assume that ``data_collection``, ``viewer``, and ``hub``
are defined when writing tests.
"""
def setup_method(self, method):
if OBJGRAPH_INSTALLED:
self.viewer_count_start = self.viewer_count
self.data = self.init_data()
self.application = GlueApplication()
self.session = self.application.session
self.hub = self.session.hub
self.data_collection = self.session.data_collection
self.data_collection.append(self.data)
self.viewer = self.viewer_cls(self.session)
self.data_collection.register_to_hub(self.hub)
self.viewer.register_to_hub(self.hub)
def init_subset(self):
cid = self.data.visible_components[0]
self.data_collection.new_subset_group('subset 1', cid > 0)
@property
def viewer_count(self):
app = get_qapp()
app.processEvents()
obj = objgraph.by_type(self.viewer_cls.__name__)
return len(obj)
def teardown_method(self, method):
if self.viewer is not None:
self.viewer.close()
self.application.close()
# The following is a check to make sure that once the viewer and
# application have been closed, there are no leftover references to
# the data viewer. This was introduced because there were previously
# circular references that meant that viewer instances were not
# properly garbage collected, which in turn meant they still reacted
# in some cases to events.
if OBJGRAPH_INSTALLED:
self.viewer = None
self.application = None
if self.viewer_count > self.viewer_count_start:
raise ValueError("No net viewers should be created in tests")
def test_add_data(self):
# Add a dataset with no subsets and make sure the appropriate layer
# state and layer artists are created
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_add_data_with_subset(self):
# Make sure that if subsets are present in the data, they are added
# automatically
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def test_adding_subset_adds_data(self):
# TODO: in future consider whether we want to deprecate this behavior
self.init_subset()
self.viewer.add_subset(self.data.subsets[0])
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def test_add_data_then_subset(self):
# Make sure that if a subset is created in a dataset that has already
# been added to a viewer, the subset gets added
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
self.init_subset()
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def init_draw_count(self):
self.mpl_counter = MatplotlibDrawCounter(self.viewer.axes.figure)
@property
def draw_count(self):
return self.mpl_counter.draw_count
def test_single_draw(self):
# Make sure that the number of draws is kept to a minimum
self.init_draw_count()
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
assert self.draw_count == 1
def test_update_subset(self):
self.init_draw_count()
# Check that updating a subset causes the plot to be updated
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
count_before = self.draw_count
# Change the subset
cid = self.data.visible_components[0]
self.data.subsets[0].subset_state = cid > 1
# Make sure the figure has been redrawn
assert self.draw_count - count_before > 0
def test_double_add_ignored(self):
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
def test_removing_data_removes_layer_state(self):
# Removing data from data collection should remove data from viewer
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_data_removes_subsets(self):
# Removing data from data collection should remove subsets from viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 2
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_subset_removes_layers(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.data_collection.remove_subset_group(self.data_collection.subset_groups[0])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_artist_removes_layer_state(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer._layer_artist_container.remove(self.viewer.layers[1])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_state_removes_layer_artist(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer.state.layers.pop(1)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_new_subset_after_remove_data(self):
# Once we remove a dataset, if we make a new subset, it will not be
# added to the viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.viewer.state.layers.pop(0)
self.init_subset() # makes a new subset
assert len(self.data.subsets) == 2
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data.subsets[0]
def test_remove_not_present_ignored(self):
data = Data(label='not in viewer')
self.viewer.remove_data(data)
def test_limits_sync(self):
viewer_state = self.viewer.state
axes = self.viewer.axes
if axes.get_adjustable() == 'datalim':
pytest.xfail()
# Make sure that the viewer state and matplotlib viewer limits and log
# settings are in sync. We start by modifying the state and making sure
# that the axes follow.
viewer_state.x_min = 3
viewer_state.x_max = 9
viewer_state.y_min = -2
viewer_state.y_max = 3
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'linear'
assert axes.get_yscale() == 'linear'
viewer_state.x_log = True
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'linear'
viewer_state.y_log = True
# FIXME: the limits for y don't seem right, should be adjusted because of log?
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'log'
# Check that changing the axes changes the state
# NOTE: at the moment this doesn't work because Matplotlib doesn't
# emit events for changing xscale/yscale. This isn't crucial anyway for
# glue, but leaving the tests below in case this is fixed some day. The
# Matplotlib issue is https://github.com/matplotlib/matplotlib/issues/8439
axes.set_xscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert viewer_state.y_log
#
axes.set_yscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
axes.set_xlim(-1, 4)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == -2
assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
axes.set_ylim(5, 6)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == 5
assert viewer_state.y_max == 6
# assert not viewer_state.x_log
# assert not viewer_state.y_log
# TODO: the following test should deal gracefully with the fact that
# some viewers will want to show a Qt error for IncompatibleDataException
def test_add_invalid_data(self):
data2 = Data()
with pytest.raises(IncompatibleDataException):
self.viewer.add_data(data2)
# Communication tests
def test_ignore_data_add_message(self):
self.data_collection.append(self.data)
assert len(self.viewer.layers) == 0
def test_update_data_ignored_if_data_not_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count == ct0
def test_update_data_processed_if_data_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count > ct0
def test_add_subset_ignored_if_data_not_present(self):
self.data_collection.append(self.data)
sub = self.data.new_subset()
assert sub not in self.viewer._layer_artist_container
def test_add_subset_processed_if_data_present(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
def test_update_subset_ignored_if_not_present(self):
# This can be quite a difficult test to pass because it makes sure that
# there are absolutely no references to the layer state left over once
# a subset is removed - when originally written this identified quite
# a few places where references were being accidentally kept, and
# resulted in weakref being needed in a number of places. But ultimately
# this test should pass! No cheating :)
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
self.viewer.remove_subset(sub)
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count == ct0
def test_update_subset_processed_if_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count > ct0
def test_data_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
self.data_collection.remove(self.data)
assert self.data not in self.viewer._layer_artist_container
def test_subset_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
sub.delete()
assert sub not in self.viewer._layer_artist_container
def test_session_round_trip(self, tmpdir):
self.init_subset()
ga = GlueApplication(self.data_collection)
ga.show()
viewer = ga.new_data_viewer(self.viewer_cls)
viewer.add_data(self.data)
session_file = tmpdir.join('test_session_round_trip.glu').strpath
ga.save_session(session_file)
ga.close()
ga2 = GlueApplication.restore_session(session_file)
ga2.show()
viewer2 = ga2.viewers[0][0]
data2 = ga2.data_collection[0]
assert viewer2.layers[0].layer is data2
assert viewer2.layers[1].layer is data2.subsets[0]
ga2.close()
def test_apply_roi_undo(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
roi = XRangeROI(1, 2)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo1 = self.data.subsets[0].subset_state.lo
hi1 = self.data.subsets[0].subset_state.hi
roi = XRangeROI(0, 3)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo2 = self.data.subsets[0].subset_state.lo
hi2 = self.data.subsets[0].subset_state.hi
assert lo2 != lo1
assert hi2 != hi1
self.application.undo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo1
assert self.data.subsets[0].subset_state.hi == hi1
self.application.redo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo2
assert self.data.subsets[0].subset_state.hi == hi2
def test_numerical_data_changed(self):
self.init_draw_count()
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
assert self.draw_count == 1
data = Data()
for cid in self.data.visible_components:
data.add_component(self.data[cid] * 2, cid.label)
self.data.update_values_from_data(data)
assert self.draw_count == 2
class BaseTestMatplotlibDataViewer(object):
"""
Base class to test viewers based on MatplotlibDataViewer. This only runs
a subset of tests that relate to functionality implemented in
MatplotlibDataViewer and specific viewers are responsible for implementing
a more complete test suite.
Viewers based on this should inherit from this test class and define the
following attributes:
* ``data``: an instance of a data object that works by default in the viewer
* ``viewer_cls``: the viewer class
It is then safe to assume that ``data_collection``, ``viewer``, and ``hub``
are defined when writing tests.
"""
def setup_method(self, method):
if OBJGRAPH_INSTALLED:
self.viewer_count_start = self.viewer_count
self.data = self.init_data()
self.application = GlueApplication()
self.session = self.application.session
self.hub = self.session.hub
self.data_collection = self.session.data_collection
self.data_collection.append(self.data)
self.viewer = self.viewer_cls(self.session)
self.data_collection.register_to_hub(self.hub)
self.viewer.register_to_hub(self.hub)
def init_subset(self):
cid = self.data.main_components[0]
self.data_collection.new_subset_group('subset 1', cid > 0)
@property
def viewer_count(self):
app = get_qapp()
app.processEvents()
obj = objgraph.by_type(self.viewer_cls.__name__)
return len(obj)
def teardown_method(self, method):
if self.viewer is not None:
self.viewer.close()
self.application.close()
# The following is a check to make sure that once the viewer and
# application have been closed, there are no leftover references to
# the data viewer. This was introduced because there were previously
# circular references that meant that viewer instances were not
# properly garbage collected, which in turn meant they still reacted
# in some cases to events.
if OBJGRAPH_INSTALLED:
self.viewer = None
self.application = None
if self.viewer_count > self.viewer_count_start:
objgraph.show_backrefs(
objgraph.by_type(self.viewer_cls.__name__))
raise ValueError("No net viewers should be created in tests")
def test_add_data(self):
# Add a dataset with no subsets and make sure the appropriate layer
# state and layer artists are created
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_add_data_with_subset(self):
# Make sure that if subsets are present in the data, they are added
# automatically
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def test_add_data_then_subset(self):
# Make sure that if a subset is created in a dataset that has already
# been added to a viewer, the subset gets added
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
self.init_subset()
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def init_draw_count(self):
self.mpl_counter = MatplotlibDrawCounter(self.viewer.axes.figure)
@property
def draw_count(self):
return self.mpl_counter.draw_count
def test_single_draw(self):
# Make sure that the number of draws is kept to a minimum
self.init_draw_count()
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
assert self.draw_count == 1
def test_update_subset(self):
self.init_draw_count()
# Check that updating a subset causes the plot to be updated
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
count_before = self.draw_count
# Change the subset
cid = self.data.main_components[0]
self.data.subsets[0].subset_state = cid > 1
# Make sure the figure has been redrawn
assert self.draw_count - count_before > 0
def test_double_add_ignored(self):
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
def test_removing_data_removes_layer_state(self):
# Removing data from data collection should remove data from viewer
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_data_removes_subsets(self):
# Removing data from data collection should remove subsets from viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 2
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_subset_removes_layers(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.data_collection.remove_subset_group(
self.data_collection.subset_groups[0])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_artist_removes_layer_state(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer._layer_artist_container.remove(self.viewer.layers[1])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_state_removes_layer_artist(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer.state.layers.pop(1)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_new_subset_after_remove_data(self):
# Once we remove a dataset, if we make a new subset, it will not be
# added to the viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.viewer.state.layers.pop(0)
self.init_subset() # makes a new subset
assert len(self.data.subsets) == 2
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data.subsets[0]
def test_remove_not_present_ignored(self):
data = Data(label='not in viewer')
self.viewer.remove_data(data)
def test_limits_sync(self):
viewer_state = self.viewer.state
axes = self.viewer.axes
if axes.get_adjustable() == 'datalim':
pytest.xfail()
# Make sure that the viewer state and matplotlib viewer limits and log
# settings are in sync. We start by modifying the state and making sure
# that the axes follow.
viewer_state.x_min = 3
viewer_state.x_max = 9
viewer_state.y_min = -2
viewer_state.y_max = 3
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'linear'
assert axes.get_yscale() == 'linear'
viewer_state.x_log = True
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'linear'
viewer_state.y_log = True
# FIXME: the limits for y don't seem right, should be adjusted because of log?
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'log'
# Check that changing the axes changes the state
# NOTE: at the moment this doesn't work because Matplotlib doesn't
# emit events for changing xscale/yscale. This isn't crucial anyway for
# glue, but leaving the tests below in case this is fixed some day. The
# Matplotlib issue is https://github.com/matplotlib/matplotlib/issues/8439
# axes.set_xscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert viewer_state.y_log
#
# axes.set_yscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
viewer_state.x_log = False
viewer_state.y_log = False
axes.set_xlim(-1, 4)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == -2
assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
axes.set_ylim(5, 6)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == 5
assert viewer_state.y_max == 6
# assert not viewer_state.x_log
# assert not viewer_state.y_log
# TODO: the following test should deal gracefully with the fact that
# some viewers will want to show a Qt error for IncompatibleDataException
def test_add_invalid_data(self):
data2 = Data()
with pytest.raises(IncompatibleDataException):
self.viewer.add_data(data2)
# Communication tests
def test_ignore_data_add_message(self):
self.data_collection.append(self.data)
assert len(self.viewer.layers) == 0
def test_update_data_ignored_if_data_not_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count == ct0
def test_update_data_processed_if_data_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count > ct0
def test_add_subset_ignored_if_data_not_present(self):
self.data_collection.append(self.data)
sub = self.data.new_subset()
assert sub not in self.viewer._layer_artist_container
def test_add_subset_processed_if_data_present(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
def test_update_subset_ignored_if_not_present(self):
# This can be quite a difficult test to pass because it makes sure that
# there are absolutely no references to the layer state left over once
# a subset is removed - when originally written this identified quite
# a few places where references were being accidentally kept, and
# resulted in weakref being needed in a number of places. But ultimately
# this test should pass! No cheating :)
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
self.viewer.remove_subset(sub)
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count == ct0
def test_update_subset_processed_if_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count > ct0
def test_data_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
self.data_collection.remove(self.data)
assert self.data not in self.viewer._layer_artist_container
def test_subset_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
sub.delete()
assert sub not in self.viewer._layer_artist_container
def test_session_round_trip(self, tmpdir):
self.init_subset()
ga = GlueApplication(self.data_collection)
ga.show()
viewer = ga.new_data_viewer(self.viewer_cls)
viewer.add_data(self.data)
session_file = tmpdir.join('test_session_round_trip.glu').strpath
ga.save_session(session_file)
ga.close()
ga2 = GlueApplication.restore_session(session_file)
ga2.show()
viewer2 = ga2.viewers[0][0]
data2 = ga2.data_collection[0]
assert viewer2.layers[0].layer is data2
assert viewer2.layers[1].layer is data2.subsets[0]
ga2.close()
def test_apply_roi_undo(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
roi = XRangeROI(1, 2)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo1 = self.data.subsets[0].subset_state.lo
hi1 = self.data.subsets[0].subset_state.hi
roi = XRangeROI(0, 3)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo2 = self.data.subsets[0].subset_state.lo
hi2 = self.data.subsets[0].subset_state.hi
assert lo2 != lo1
assert hi2 != hi1
self.application.undo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo1
assert self.data.subsets[0].subset_state.hi == hi1
self.application.redo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo2
assert self.data.subsets[0].subset_state.hi == hi2
def test_numerical_data_changed(self):
self.init_draw_count()
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
assert self.draw_count == 1
data = Data(label=self.data.label)
data.coords = self.data.coords
for cid in self.data.main_components:
if self.data.get_kind(cid) == 'numerical':
data.add_component(self.data[cid] * 2, cid.label)
else:
data.add_component(self.data[cid], cid.label)
self.data.update_values_from_data(data)
assert self.draw_count == 2
@requires_matplotlib_ge_22
def test_aspect_resize(self):
# Make sure that the limits are adjusted appropriately when resizing
# depending on the aspect ratio mode. Note that we don't add any data
# here since it isn't needed for this test.
# This test works with Matplotlib 2.0 and 2.2 but not 2.1, hence we
# skip it with Matplotlib 2.1 above.
app = get_qapp()
# Set initial limits to deterministic values
self.viewer.state.aspect = 'auto'
self.viewer.state.x_min = 0.
self.viewer.state.x_max = 1.
self.viewer.state.y_min = 0.
self.viewer.state.y_max = 1.
self.viewer.state.aspect = 'equal'
# Resize events only work if widget is visible
self.viewer.show()
app.processEvents()
def limits(viewer):
return (viewer.state.x_min, viewer.state.x_max, viewer.state.y_min,
viewer.state.y_max)
# Set viewer to an initial size and save limits
self.viewer.viewer_size = (800, 400)
app.processEvents()
initial_limits = limits(self.viewer)
# Change the viewer size, and make sure the limits are adjusted
self.viewer.viewer_size = (400, 400)
app.processEvents()
with pytest.raises(AssertionError):
assert_allclose(limits(self.viewer), initial_limits)
# Now change the viewer size a number of times and make sure if we
# return to the original size, the limits match the initial ones.
self.viewer.viewer_size = (350, 800)
app.processEvents()
self.viewer.viewer_size = (900, 300)
app.processEvents()
self.viewer.viewer_size = (600, 600)
app.processEvents()
self.viewer.viewer_size = (800, 400)
app.processEvents()
assert_allclose(limits(self.viewer), initial_limits)
# Now check that the limits don't change in 'auto' mode
self.viewer.state.aspect = 'auto'
self.viewer.viewer_size = (900, 300)
assert_allclose(limits(self.viewer), initial_limits)
def test_update_data_values(self):
# Regression test for a bug that caused some viewers to not behave
# correctly if the data values were updated.
self.viewer.add_data(self.data)
data = self.init_data()
self.data_collection.append(data)
self.data.update_values_from_data(data)
class BaseTestMatplotlibDataViewer(object):
"""
Base class to test viewers based on MatplotlibDataViewer. This only runs
a subset of tests that relate to functionality implemented in
MatplotlibDataViewer and specific viewers are responsible for implementing
a more complete test suite.
Viewers based on this should inherit from this test class and define the
following attributes:
* ``data``: an instance of a data object that works by default in the viewer
* ``viewer_cls``: the viewer class
It is then safe to assume that ``data_collection``, ``viewer``, and ``hub``
are defined when writing tests.
"""
def setup_method(self, method):
self.data = self.init_data()
self.application = GlueApplication()
self.session = self.application.session
self.hub = self.session.hub
self.data_collection = self.session.data_collection
self.data_collection.append(self.data)
self.viewer = self.viewer_cls(self.session)
self.data_collection.register_to_hub(self.hub)
self.viewer.register_to_hub(self.hub)
def init_subset(self):
cid = self.data.visible_components[0]
self.data_collection.new_subset_group('subset 1', cid > 0)
def teardown_method(self, method):
self.viewer.close()
def test_add_data(self):
# Add a dataset with no subsets and make sure the appropriate layer
# state and layer artists are created
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_add_data_with_subset(self):
# Make sure that if subsets are present in the data, they are added
# automatically
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def test_adding_subset_adds_data(self):
# TODO: in future consider whether we want to deprecate this behavior
self.init_subset()
self.viewer.add_subset(self.data.subsets[0])
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def test_add_data_then_subset(self):
# Make sure that if a subset is created in a dataset that has already
# been added to a viewer, the subset gets added
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
self.init_subset()
assert len(self.viewer.layers) == 2
assert self.viewer.layers[0].layer is self.data
assert self.viewer.layers[1].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 2
assert self.viewer.state.layers[0].layer is self.data
assert self.viewer.state.layers[1].layer is self.data.subsets[0]
def init_draw_count(self):
self.mpl_counter = MatplotlibDrawCounter(self.viewer.axes.figure)
@property
def draw_count(self):
return self.mpl_counter.draw_count
def test_single_draw(self):
# Make sure that the number of draws is kept to a minimum
self.init_draw_count()
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
assert self.draw_count == 1
def test_update_subset(self):
self.init_draw_count()
# Check that updating a subset causes the plot to be updated
self.init_subset()
assert self.draw_count == 0
self.viewer.add_data(self.data)
count_before = self.draw_count
# Change the subset
cid = self.data.visible_components[0]
self.data.subsets[0].subset_state = cid > 1
# Make sure the figure has been redrawn
assert self.draw_count - count_before > 0
def test_double_add_ignored(self):
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
def test_removing_data_removes_layer_state(self):
# Removing data from data collection should remove data from viewer
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 1
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_data_removes_subsets(self):
# Removing data from data collection should remove subsets from viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.state.layers) == 2
self.data_collection.remove(self.data)
assert len(self.viewer.state.layers) == 0
def test_removing_subset_removes_layers(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.data_collection.remove_subset_group(self.data_collection.subset_groups[0])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_artist_removes_layer_state(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer._layer_artist_container.remove(self.viewer.layers[1])
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_removing_layer_state_removes_layer_artist(self):
# Removing a layer artist removes the corresponding layer state. We need
# to do this with a subset otherwise the viewer is closed
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
# self.layers is a copy so we need to remove from the original list
self.viewer.state.layers.pop(1)
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data
def test_new_subset_after_remove_data(self):
# Once we remove a dataset, if we make a new subset, it will not be
# added to the viewer
self.init_subset()
self.viewer.add_data(self.data)
assert len(self.viewer.layers) == 2
assert len(self.viewer.state.layers) == 2
self.viewer.state.layers.pop(0)
self.init_subset() # makes a new subset
assert len(self.data.subsets) == 2
assert len(self.viewer.layers) == 1
assert self.viewer.layers[0].layer is self.data.subsets[0]
assert len(self.viewer.state.layers) == 1
assert self.viewer.state.layers[0].layer is self.data.subsets[0]
def test_remove_not_present_ignored(self):
data = Data(label='not in viewer')
self.viewer.remove_data(data)
def test_limits_sync(self):
viewer_state = self.viewer.state
axes = self.viewer.axes
if axes.get_adjustable() == 'datalim':
pytest.xfail()
# Make sure that the viewer state and matplotlib viewer limits and log
# settings are in sync. We start by modifying the state and making sure
# that the axes follow.
viewer_state.x_min = 3
viewer_state.x_max = 9
viewer_state.y_min = -2
viewer_state.y_max = 3
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'linear'
assert axes.get_yscale() == 'linear'
viewer_state.x_log = True
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'linear'
viewer_state.y_log = True
# FIXME: the limits for y don't seem right, should be adjusted because of log?
assert axes.get_xlim() == (3, 9)
assert axes.get_ylim() == (-2, 3)
assert axes.get_xscale() == 'log'
assert axes.get_yscale() == 'log'
# Check that changing the axes changes the state
# NOTE: at the moment this doesn't work because Matplotlib doesn't
# emit events for changing xscale/yscale. This isn't crucial anyway for
# glue, but leaving the tests below in case this is fixed some day. The
# Matplotlib issue is https://github.com/matplotlib/matplotlib/issues/8439
axes.set_xscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert viewer_state.y_log
#
axes.set_yscale('linear')
#
# assert viewer_state.x_min == 3
# assert viewer_state.x_max == 9
# assert viewer_state.y_min == -2
# assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
axes.set_xlim(-1, 4)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == -2
assert viewer_state.y_max == 3
# assert not viewer_state.x_log
# assert not viewer_state.y_log
axes.set_ylim(5, 6)
assert viewer_state.x_min == -1
assert viewer_state.x_max == 4
assert viewer_state.y_min == 5
assert viewer_state.y_max == 6
# assert not viewer_state.x_log
# assert not viewer_state.y_log
def test_add_invalid_data(self):
data2 = Data()
with pytest.raises(IncompatibleDataException):
self.viewer.add_data(data2)
# Communication tests
def test_ignore_data_add_message(self):
self.data_collection.append(self.data)
assert len(self.viewer.layers) == 0
def test_update_data_ignored_if_data_not_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count == ct0
def test_update_data_processed_if_data_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
ct0 = self.draw_count
self.data.style.color = 'blue'
assert self.draw_count > ct0
def test_add_subset_ignored_if_data_not_present(self):
self.data_collection.append(self.data)
sub = self.data.new_subset()
assert sub not in self.viewer._layer_artist_container
def test_add_subset_processed_if_data_present(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
def test_update_subset_ignored_if_not_present(self):
# This can be quite a difficult test to pass because it makes sure that
# there are absolutely no references to the layer state left over once
# a subset is removed - when originally written this identified quite
# a few places where references were being accidentally kept, and
# resulted in weakref being needed in a number of places. But ultimately
# this test should pass! No cheating :)
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
self.viewer.remove_subset(sub)
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count == ct0
def test_update_subset_processed_if_present(self):
self.init_draw_count()
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
ct0 = self.draw_count
sub.style.color = 'blue'
assert self.draw_count > ct0
def test_data_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
self.data_collection.remove(self.data)
assert self.data not in self.viewer._layer_artist_container
def test_subset_remove_message(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
sub = self.data.new_subset()
assert sub in self.viewer._layer_artist_container
sub.delete()
assert sub not in self.viewer._layer_artist_container
def test_session_round_trip(self, tmpdir):
self.init_subset()
ga = GlueApplication(self.data_collection)
ga.show()
viewer = ga.new_data_viewer(self.viewer_cls)
viewer.add_data(self.data)
session_file = tmpdir.join('test_session_round_trip.glu').strpath
ga.save_session(session_file)
ga.close()
ga2 = GlueApplication.restore_session(session_file)
ga2.show()
viewer2 = ga2.viewers[0][0]
data2 = ga2.data_collection[0]
assert viewer2.layers[0].layer is data2
assert viewer2.layers[1].layer is data2.subsets[0]
def test_apply_roi_undo(self):
self.data_collection.append(self.data)
self.viewer.add_data(self.data)
roi = XRangeROI(1, 2)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo1 = self.data.subsets[0].subset_state.lo
hi1 = self.data.subsets[0].subset_state.hi
roi = XRangeROI(0, 3)
self.viewer.apply_roi(roi)
assert len(self.data.subsets) == 1
lo2 = self.data.subsets[0].subset_state.lo
hi2 = self.data.subsets[0].subset_state.hi
assert lo2 != lo1
assert hi2 != hi1
self.application.undo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo1
assert self.data.subsets[0].subset_state.hi == hi1
self.application.redo()
assert len(self.data.subsets) == 1
assert self.data.subsets[0].subset_state.lo == lo2
assert self.data.subsets[0].subset_state.hi == hi2
