Skip to content

Commit 9ab9810

Browse files
committed
Remove unneeded default marker names
1 parent 93b4e0e commit 9ab9810

File tree

3 files changed

+3
-38
lines changed

3 files changed

+3
-38
lines changed

src/astro_image_display_api/dummy_viewer.py

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ class ImageViewer:
3636
# Allowed locations for cursor display
3737
ALLOWED_CURSOR_LOCATIONS: tuple = ImageViewerInterface.ALLOWED_CURSOR_LOCATIONS
3838

39-
# List of marker names that are for internal use only
40-
RESERVED_MARKER_SET_NAMES: tuple = ImageViewerInterface.RESERVED_MARKER_SET_NAMES
41-
42-
# Default marker name for marking via API
43-
DEFAULT_MARKER_NAME: str = ImageViewerInterface.DEFAULT_MARKER_NAME
44-
4539
# some internal variable for keeping track of viewer state
4640
_interactive_marker_name: str = ""
4741
_previous_marker: Any = ""
@@ -206,11 +200,6 @@ def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
206200
if not coords and self._wcs is not None:
207201
coords = self._wcs.pixel_to_world(x, y)
208202

209-
if marker_name in self.RESERVED_MARKER_SET_NAMES:
210-
raise ValueError(f"Marker name {marker_name} not allowed.")
211-
212-
marker_name = marker_name if marker_name else self.DEFAULT_MARKER_NAME
213-
214203
to_add = Table(
215204
dict(
216205
x=x,
@@ -289,7 +278,7 @@ def get_markers(self, x_colname: str = 'x', y_colname: str = 'y',
289278
else:
290279
marker_name = [marker_name]
291280
elif marker_name is None:
292-
marker_name = [self.DEFAULT_MARKER_NAME]
281+
marker_name = ["_default_marker"]
293282

294283
to_stack = [self._markers[name] for name in marker_name if name in self._markers]
295284

src/astro_image_display_api/interface_definition.py

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
# Allowed locations for cursor display
1313
ALLOWED_CURSOR_LOCATIONS = ('top', 'bottom', None)
1414

15-
DEFAULT_MARKER_NAME = 'default-marker-name'
16-
17-
# List of marker names that are for internal use only
18-
RESERVED_MARKER_SET_NAMES = ('all',)
1915

2016
__all__ = [
2117
'ImageViewerInterface',
@@ -33,20 +29,13 @@ class ImageViewerInterface(Protocol):
3329
stretch_options: tuple
3430
autocut_options: tuple
3531
cursor: str
36-
marker: Any
3732
cuts: Any
3833
stretch: str
3934
# viewer: Any
4035

4136
# Allowed locations for cursor display
4237
ALLOWED_CURSOR_LOCATIONS: tuple = ALLOWED_CURSOR_LOCATIONS
4338

44-
# List of marker names that are for internal use only
45-
RESERVED_MARKER_SET_NAMES: tuple = RESERVED_MARKER_SET_NAMES
46-
47-
# Default marker name for marking via API
48-
DEFAULT_MARKER_NAME: str = DEFAULT_MARKER_NAME
49-
5039
# The methods, grouped loosely by purpose
5140

5241
# Methods for loading data

src/astro_image_display_api/widget_api_test.py

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,6 @@ def _get_marker_names_as_set(self):
6161
marker_names = set(marks)
6262
return marker_names
6363

64-
def test_default_marker_names(self):
65-
# Check only that default names are set to a non-empty string
66-
assert self.image.DEFAULT_MARKER_NAME
67-
6864
def test_width_height(self):
6965
assert self.image.image_width == 250
7066
assert self.image.image_height == 100
@@ -134,15 +130,12 @@ def test_marker_properties(self):
134130
# TODO: add test that checks that retrieving markers with an unknown name issues no error
135131

136132
def test_add_markers(self):
137-
original_marker_name = self.image.DEFAULT_MARKER_NAME
138133
data = np.arange(10).reshape(5, 2)
139134
orig_tab = Table(data=data, names=['x', 'y'], dtype=('float', 'float'))
140135
tab = Table(data=data, names=['x', 'y'], dtype=('float', 'float'))
141136
self.image.add_markers(tab, x_colname='x', y_colname='y',
142137
skycoord_colname='coord', marker_name='test1')
143138

144-
# Make sure setting didn't change the default name
145-
assert self.image.DEFAULT_MARKER_NAME == original_marker_name
146139

147140
# Regression test for GitHub Issue 45:
148141
# Adding markers should not modify the input data table.
@@ -176,12 +169,6 @@ def test_add_markers(self):
176169
self.image.remove_markers(marker_name='test1')
177170
marknames = self._get_marker_names_as_set()
178171
assert marknames == set(['test2'])
179-
# assert self.image.get_marker_names() == ['test2']
180-
181-
# Ensure unable to mark with reserved name
182-
for name in self.image.RESERVED_MARKER_SET_NAMES:
183-
with pytest.raises(ValueError, match='not allowed'):
184-
self.image.add_markers(tab, marker_name=name)
185172

186173
# Add markers with no marker name and check we can retrieve them
187174
# using the default marker name
@@ -190,15 +177,15 @@ def test_add_markers(self):
190177
# Don't care about the order of the marker names so use set instead of
191178
# list.
192179
marknames = self._get_marker_names_as_set()
193-
assert (set(marknames) == set(['test2', self.image.DEFAULT_MARKER_NAME]))
180+
assert (set(marknames) == set(['test2']))
194181

195182
# Clear markers to not pollute other tests.
196183
self.image.reset_markers()
197184
marknames = self._get_marker_names_as_set()
198185
assert len(marknames) == 0
199186
self._assert_empty_marker_table(self.image.get_markers(marker_name="all"))
200187
# Check that no markers remain after clearing
201-
tab = self.image.get_markers(marker_name=self.image.DEFAULT_MARKER_NAME)
188+
tab = self.image.get_markers()
202189
self._assert_empty_marker_table(tab)
203190

204191
# Check that retrieving a marker set that doesn't exist returns

0 commit comments

Comments
 (0)