Minimally disruptive change to Protocol

Author: mwcraig

astrowidgets/__init__.py

@@ -6,4 +6,4 @@
 from ._astropy_init import *  # noqa
 # ----------------------------------------------------------------------------
 
-from .core import *  # noqa
+from .ginga import *  # noqa

astrowidgets/core.py renamed to astrowidgets/ginga.py

@@ -0,0 +1,93 @@
+from typing import Protocol, runtime_checkable, Any
+from abc import abstractmethod
+
+# Allowed locations for cursor display
+ALLOWED_CURSOR_LOCATIONS = ['top', 'bottom', None]
+
+# List of marker names that are for internal use only
+RESERVED_MARKER_SET_NAMES = ['all']
+
+__all__ = [
+    'ImageViewerInterface',
+    'ALLOWED_CURSOR_LOCATIONS',
+    'RESERVED_MARKER_SET_NAMES'
+]
+
+
+@runtime_checkable
+class ImageViewerInterface(Protocol):
+    # This are attributes, not methods. The type annotations are there
+    # to make sure Protocol knows they are attributes. Python does not
+    # do any checking at all of these types.
+    click_center: bool
+    click_drag: bool
+    scroll_pan: bool
+    image_width: int
+    image_height: int
+    zoom_level: float
+    marker: Any
+    cuts: Any
+    stretch: str
+    # viewer: Any
+
+    # The methods, grouped loosely by purpose
+
+    # Methods for loading data
+    @abstractmethod
+    def load_fits(self, file):
+        raise NotImplementedError
+
+    @abstractmethod
+    def load_array(self, array):
+        raise NotImplementedError
+
+    @abstractmethod
+    def load_nddata(self, data):
+        raise NotImplementedError
+
+    # Saving contents of the view and accessing the view
+    @abstractmethod
+    def save(self, filename):
+        raise NotImplementedError
+
+    # Marker-related methods
+    @abstractmethod
+    def start_marking(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def stop_marking(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def add_markers(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def remove_all_markers(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def remove_markers_by_name(self, marker_name=None):
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_all_markers(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_markers_by_name(self, marker_name=None):
+        raise NotImplementedError
+
+    # Methods that modify the view
+    @abstractmethod
+    def center_on(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def offset_by(self):
+        raise NotImplementedError
+
+    @abstractmethod
+    def zoom(self):
+        raise NotImplementedError

astrowidgets/interface_definition.py

@@ -10,30 +10,30 @@
 
 from ginga.ColorDist import ColorDistBase
 
-from ..core import ImageWidget, ALLOWED_CURSOR_LOCATIONS
+from ..ginga import ImageWidget, ALLOWED_CURSOR_LOCATIONS
 
 
-def test_load_fits():
+def test_load_fits():  # yep
     image = ImageWidget()
     data = np.random.random([100, 100])
     hdu = fits.PrimaryHDU(data=data)
     image.load_fits(hdu)
 
 
-def test_load_nddata():
+def test_load_nddata():  # yep
     image = ImageWidget()
     data = np.random.random([100, 100])
     nddata = NDData(data)
     image.load_nddata(nddata)
 
 
-def test_load_array():
+def test_load_array():  # yep
     image = ImageWidget()
     data = np.random.random([100, 100])
     image.load_array(data)
 
 
-def test_center_on():
+def test_center_on():  # yep
     image = ImageWidget()
     x = 10
     y = 10
@@ -48,7 +48,7 @@ def test_offset_to():
         image.offset_to(dx, dy)
 
 
-def test_offset_by():
+def test_offset_by():  # yep
     image = ImageWidget()
 
     # Pixels
@@ -66,48 +66,48 @@ def test_offset_by():
         image.offset_by(1 * u.arcsec, 1)
 
 
-def test_zoom_level():
+def test_zoom_level():   # yep
     image = ImageWidget()
     image.zoom_level = 5
     assert image.zoom_level == 5
 
 
-def test_zoom():
+def test_zoom():   # yep
     image = ImageWidget()
     image.zoom_level = 3
     val = 2
     image.zoom(val)
     assert image.zoom_level == 6
 
 
-@pytest.mark.xfail(reason='Not implemented yet')
+@pytest.mark.xfail(reason='Not implemented yet')   # Nope, note even sure what this is
 def test_select_points():
     image = ImageWidget()
     image.select_points()
 
 
-def test_get_selection():
+def test_get_selection():   # Um, how is this testing a selection?!?
     image = ImageWidget()
     marks = image.get_markers()
     assert isinstance(marks, Table) or marks is None
 
 
-def test_stop_marking():
+def test_stop_marking():   # In test_marking_options
     image = ImageWidget()
     # This is not much of a test...
     image.stop_marking(clear_markers=True)
     assert image.get_markers() is None
     assert image.is_marking is False
 
 
-def test_is_marking():
+def test_is_marking():   # In test_marking_options
     image = ImageWidget()
     assert image.is_marking in [True, False]
     with pytest.raises(AttributeError):
         image.is_marking = True
 
 
-def test_start_marking():
+def test_start_marking():   # In test_marking_options
     image = ImageWidget()
 
     # Setting these to check that start_marking affects them.
@@ -142,23 +142,23 @@ def test_start_marking():
     assert image.click_drag
 
 
-def test_add_markers():
+def test_add_markers():  # In test_marking_options
     image = ImageWidget()
     table = Table(data=np.random.randint(0, 100, [5, 2]),
                   names=['x', 'y'], dtype=('int', 'int'))
     image.add_markers(table, x_colname='x', y_colname='y',
                       skycoord_colname='coord')
 
 
-def test_set_markers():
+def test_set_markers(): # In test_marking_options
     image = ImageWidget()
     image.marker = {'color': 'yellow', 'radius': 10, 'type': 'cross'}
     assert 'cross' in str(image.marker)
     assert 'yellow' in str(image.marker)
     assert '10' in str(image.marker)
 
 
-def test_reset_markers():
+def test_reset_markers(): # In test_marking_options
     image = ImageWidget()
     # First test: this shouldn't raise any errors
     # (it also doesn't *do* anything...)
@@ -177,7 +177,7 @@ def test_reset_markers():
         image.get_markers(marker_name='test2')
 
 
-def test_remove_markers():
+def test_remove_markers(): # In test_marking_options
     image = ImageWidget()
     # Add a tag name...
     image._marktags.add(image._default_mark_tag_name)
@@ -186,7 +186,7 @@ def test_remove_markers():
     assert 'arf' in str(e.value)
 
 
-def test_stretch():
+def test_stretch():   # yep
     image = ImageWidget()
     with pytest.raises(ValueError) as e:
         image.stretch = 'not a valid value'
@@ -196,7 +196,7 @@ def test_stretch():
     assert isinstance(image.stretch, (ColorDistBase))
 
 
-def test_cuts():
+def test_cuts():   # yep
     image = ImageWidget()
 
     # An invalid string should raise an error
@@ -219,7 +219,7 @@ def test_cuts():
     assert image.cuts == (10, 100)
 
 
-def test_colormap():
+def test_colormap():   # yep
     image = ImageWidget()
     cmap_desired = 'gray'
     cmap_list = image.colormap_options
@@ -228,7 +228,7 @@ def test_colormap():
     image.set_colormap(cmap_desired)
 
 
-def test_cursor():
+def test_cursor():   # yep
     image = ImageWidget()
     assert image.cursor in ALLOWED_CURSOR_LOCATIONS
     with pytest.raises(ValueError):
@@ -237,7 +237,7 @@ def test_cursor():
     assert image.cursor == 'bottom'
 
 
-def test_click_drag():
+def test_click_drag():   # yep
     image = ImageWidget()
     # Set this to ensure that click_drag turns it off
     image._click_center = True
@@ -260,7 +260,7 @@ def test_click_drag():
     assert 'Interactive marking' in str(e.value)
 
 
-def test_click_center():
+def test_click_center():   # yep
     image = ImageWidget()
     assert (image.click_center is True) or (image.click_center is False)
 
@@ -283,7 +283,7 @@ def test_click_center():
     image.click_center = False
 
 
-def test_scroll_pan():
+def test_scroll_pan():   # yep
     image = ImageWidget()
 
     # Make sure scroll_pan is actually settable
@@ -292,13 +292,13 @@ def test_scroll_pan():
         assert image.scroll_pan is val
 
 
-def test_save(tmp_path):
+def test_save(tmp_path):   # yep
     image = ImageWidget()
     filename = 'woot.png'
     image.save(tmp_path / filename)
 
 
-def test_width_height():
+def test_width_height():   # yep
     image = ImageWidget(image_width=250, image_height=100)
     assert image.image_width == 250
     assert image.image_height == 100

astrowidgets/tests/test_api.py

@@ -7,7 +7,7 @@
 from astropy.nddata import CCDData
 from astropy.coordinates import SkyCoord
 
-from ..core import ImageWidget, RESERVED_MARKER_SET_NAMES
+from ..ginga import ImageWidget, RESERVED_MARKER_SET_NAMES
 
 
 def _make_fake_ccd(with_wcs=True):
@@ -42,7 +42,7 @@ def _make_fake_ccd(with_wcs=True):
     return CCDData(data=fake_image, wcs=wcs, unit='adu')
 
 
-def test_setting_image_width_height():
+def test_setting_image_width_height():   # yep
     image = ImageWidget()
     width = 200
     height = 300
@@ -51,7 +51,7 @@ def test_setting_image_width_height():
     assert image._viewer.get_window_size() == (width, height)
 
 
-def test_add_marker_does_not_modify_input_table():
+def test_add_marker_does_not_modify_input_table():   # in test_marking_operations
     # Regression test for #45
     # Adding markers should not modify the input data table
     image = ImageWidget(image_width=300, image_height=300,
@@ -67,7 +67,7 @@ def test_add_marker_does_not_modify_input_table():
     assert (in_table == orig_table).all()
 
 
-def test_adding_markers_as_world_recovers_with_get_markers():
+def test_adding_markers_as_world_recovers_with_get_markers():   # yep
     """
     Make sure that our internal conversion from world to pixel
     coordinates doesn't mess anything up.
@@ -128,7 +128,7 @@ def test_move_callback_includes_offset():
     assert float(y_out) == data_y + offset
 
 
-def test_can_add_markers_with_names():
+def test_can_add_markers_with_names():  # in test_marking_operations?
     """
     Test a few things related to naming marker sets
     """
@@ -185,7 +185,7 @@ def test_can_add_markers_with_names():
     assert image._interactive_marker_set_name in image._marktags
 
 
-def test_mark_with_reserved_name_raises_error():
+def test_mark_with_reserved_name_raises_error(): # in test_marking_operations
     npix_side = 200
     image = ImageWidget(image_width=npix_side,
                         image_height=npix_side)
@@ -258,7 +258,7 @@ def test_unknown_marker_name_error():
     assert f"No markers named '{bad_name}'" in str(e.value)
 
 
-def test_marker_name_has_no_marks_warning():
+def test_marker_name_has_no_marks_warning():   # in test_marking_operations
     """
     Regression test for https://github.com/astropy/astrowidgets/issues/97
 
@@ -301,7 +301,7 @@ def test_empty_marker_name_works_with_all():
     assert 'empty' not in marks['marker name']
 
 
-def test_add_single_marker():
+def test_add_single_marker():  # in test_marking_operations
     """
     Test a few things related to naming marker sets
     """