Merge pull request #1809 from pllim/deprecate-this

MNT: Deprecate CubeViz, MosViz, and SpecViz
spacetelescope · Nov 2, 2022 · d16cb27 · d16cb27
2 parents 9e4acb8 + 66b5c46
commit d16cb27
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 17 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -33,6 +33,8 @@ API Changes
 Cubeviz
 ^^^^^^^
 
+- ``CubeViz`` is deprecated, use ``Cubeviz``. [#1809]
+
 Imviz
 ^^^^^
 
@@ -41,9 +43,13 @@ Mosviz
 
 - Removed unused ``MosvizProfileView`` viewer class. [#1797]
 
+- ``MosViz`` is deprecated, use ``Mosviz``. [#1809]
+
 Specviz
 ^^^^^^^
 
+- ``SpecViz`` is deprecated, use ``Specviz``. [#1809]
+
 Specviz2d
 ^^^^^^^^^
 

diff --git a/jdaviz/__init__.py b/jdaviz/__init__.py
@@ -8,9 +8,9 @@
 
 # top-level API as exposed to users
 from jdaviz.app import *  # noqa
-from jdaviz.configs.specviz import Specviz, SpecViz  # noqa
+from jdaviz.configs.specviz import Specviz  # noqa
 from jdaviz.configs.specviz2d import Specviz2d  # noqa
-from jdaviz.configs.mosviz import Mosviz, MosViz  # noqa
-from jdaviz.configs.cubeviz import Cubeviz, CubeViz  # noqa
+from jdaviz.configs.mosviz import Mosviz  # noqa
+from jdaviz.configs.cubeviz import Cubeviz  # noqa
 from jdaviz.configs.imviz import Imviz  # noqa
 from jdaviz.utils import enable_hot_reloading  # noqa
diff --git a/jdaviz/configs/cubeviz/__init__.py b/jdaviz/configs/cubeviz/__init__.py
@@ -1,2 +1,2 @@
 from .plugins import *  # noqa
-from .helper import Cubeviz, CubeViz  # noqa
+from .helper import Cubeviz  # noqa
diff --git a/jdaviz/configs/cubeviz/helper.py b/jdaviz/configs/cubeviz/helper.py
@@ -1,14 +1,14 @@
 import numpy as np
-
+from astropy.utils.decorators import deprecated
 from glue.core import BaseData
+
 from jdaviz.core.helpers import ImageConfigHelper
 from jdaviz.configs.default.plugins.line_lists.line_list_mixin import LineListMixin
 from jdaviz.configs.specviz import Specviz
 from jdaviz.core.events import (AddDataMessage,
                                 SliceSelectSliceMessage)
 
-
-__all__ = ['Cubeviz', 'CubeViz']
+__all__ = ['Cubeviz']
 
 
 class Cubeviz(ImageConfigHelper, LineListMixin):
@@ -113,8 +113,7 @@ def specviz(self):
         return self._specviz
 
 
-# TODO: Officially deprecate this with coordination with JDAT notebooks team.
-# For backward compatibility only.
+@deprecated('3.2', alternative='Cubeviz')
 class CubeViz(Cubeviz):
     """This class is pending deprecation. Please use `Cubeviz` instead."""
     pass

diff --git a/jdaviz/configs/mosviz/__init__.py b/jdaviz/configs/mosviz/__init__.py
@@ -1,2 +1,2 @@
 from .plugins import *  # noqa
-from .helper import Mosviz, MosViz  # noqa
+from .helper import Mosviz  # noqa
diff --git a/jdaviz/configs/mosviz/helper.py b/jdaviz/configs/mosviz/helper.py
@@ -8,6 +8,7 @@
 from astropy import units as u
 from astropy.coordinates import SkyCoord
 from astropy.table import QTable
+from astropy.utils.decorators import deprecated
 from echo import delay_callback
 from glue.core.exceptions import IncompatibleAttribute
 
@@ -19,7 +20,7 @@
 from jdaviz.configs.mosviz.plugins import jwst_header_to_skyregion
 from jdaviz.configs.default.plugins.line_lists.line_list_mixin import LineListMixin
 
-__all__ = ['Mosviz', 'MosViz']
+__all__ = ['Mosviz']
 
 
 class Mosviz(ConfigHelper, LineListMixin):
@@ -989,8 +990,7 @@ def get_spectrum_2d(self, row=None, apply_slider_redshift="Warn"):
         return self._get_spectrum('2D Spectra', row, apply_slider_redshift)
 
 
-# TODO: Officially deprecate this with coordination with JDAT notebooks team.
-# For backward compatibility only.
+@deprecated('3.2', alternative='Mosviz')
 class MosViz(Mosviz):
     """This class is pending deprecation. Please use `Mosviz` instead."""
     pass
diff --git a/jdaviz/configs/specviz/__init__.py b/jdaviz/configs/specviz/__init__.py
@@ -1,2 +1,2 @@
 from .plugins import *  # noqa
-from .helper import Specviz, SpecViz  # noqa
+from .helper import Specviz  # noqa
diff --git a/jdaviz/configs/specviz/helper.py b/jdaviz/configs/specviz/helper.py
@@ -1,13 +1,14 @@
 import warnings
 
 from astropy import units as u
+from astropy.utils.decorators import deprecated
 from specutils import SpectralRegion, Spectrum1D
 
 from jdaviz.core.helpers import ConfigHelper
 from jdaviz.core.events import RedshiftMessage
 from jdaviz.configs.default.plugins.line_lists.line_list_mixin import LineListMixin
 
-__all__ = ['Specviz', 'SpecViz']
+__all__ = ['Specviz']
 
 
 def _apply_redshift_to_spectra(spectra, redshift):
@@ -235,8 +236,7 @@ def set_spectrum_tick_format(self, fmt, axis=None):
         ).figure.axes[axis].tick_format = fmt
 
 
-# TODO: Officially deprecate this with coordination with JDAT notebooks team.
-# For backward compatibility only.
+@deprecated('3.2', alternative='Specviz')
 class SpecViz(Specviz):
     """This class is pending deprecation. Please use `Specviz` instead."""
     pass