Merge pull request #2230 from larrybradley/deprecation-tools

Add (private) deprecated_getattr helper function

Author: larrybradley

photutils/background/background_2d.py

@@ -10,7 +10,6 @@
 import numpy as np
 from astropy.nddata import NDData, block_replicate, reshape_as_blocks
 from astropy.utils import lazyproperty
-from astropy.utils.decorators import deprecated_renamed_argument
 from astropy.utils.exceptions import AstropyUserWarning
 from scipy.ndimage import generic_filter
 
@@ -20,6 +19,7 @@
 from photutils.background.interpolators import (BkgIDWInterpolator,
                                                 _BkgZoomInterpolator)
 from photutils.utils import ShepardIDWInterpolator
+from photutils.utils._deprecation import deprecated_renamed_argument
 from photutils.utils._parameters import as_pair, create_default_sigmaclip
 from photutils.utils._repr import make_repr
 from photutils.utils._stats import nanmedian, nanmin
@@ -182,7 +182,7 @@ class Background2D:
     map will simply be a constant image.
     """
 
-    @deprecated_renamed_argument('interpolator', None, '3.0')
+    @deprecated_renamed_argument('interpolator', None, '3.0', until='4.0')
     def __init__(self, data, box_size, *, mask=None, coverage_mask=None,
                  fill_value=0.0, exclude_percentile=10.0, filter_size=(3, 3),
                  filter_threshold=None, sigma_clip=SIGMA_CLIP,

photutils/background/tests/test_background_2d.py

@@ -735,7 +735,7 @@ def test_interpolator_keyword_deprecation(self, test_data):
         with pytest.warns(AstropyDeprecationWarning, match=match):
             interp = BkgZoomInterpolator()
 
-        match = '"interpolator" was deprecated'
+        match = "'interpolator' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             bkg = Background2D(test_data, (25, 25), interpolator=interp)
 

photutils/centroids/core.py

@@ -8,11 +8,11 @@
 
 import numpy as np
 from astropy.nddata import overlap_slices
-from astropy.utils.decorators import deprecated_renamed_argument
 from astropy.utils.exceptions import AstropyUserWarning
 
 from photutils.centroids._utils import _process_data_mask
-from photutils.utils._deprecation import deprecated_positional_kwargs
+from photutils.utils._deprecation import (deprecated_positional_kwargs,
+                                          deprecated_renamed_argument)
 from photutils.utils._parameters import as_pair
 from photutils.utils._quantity_helpers import process_quantities
 from photutils.utils._repr import make_repr
@@ -116,9 +116,9 @@ def centroid_com(data, mask=None):
 
 
 @deprecated_positional_kwargs(since='3.0', until='4.0')
-@deprecated_renamed_argument('xpeak', None, '3.0')
-@deprecated_renamed_argument('ypeak', None, '3.0')
-@deprecated_renamed_argument('search_boxsize', None, '3.0')
+@deprecated_renamed_argument('xpeak', None, '3.0', until='4.0')
+@deprecated_renamed_argument('ypeak', None, '3.0', until='4.0')
+@deprecated_renamed_argument('search_boxsize', None, '3.0', until='4.0')
 def centroid_quadratic(data, mask=None, fit_boxsize=5, xpeak=None,
                        ypeak=None, search_boxsize=None):
     """

photutils/detection/core.py

@@ -17,11 +17,11 @@
 from astropy.stats import gaussian_fwhm_to_sigma
 from astropy.table import QTable
 from astropy.utils import lazyproperty
-from astropy.utils.decorators import deprecated_renamed_argument
 from astropy.utils.exceptions import AstropyDeprecationWarning
 
 from photutils.detection.peakfinder import find_peaks
-from photutils.utils._deprecation import deprecated_positional_kwargs
+from photutils.utils._deprecation import (deprecated_positional_kwargs,
+                                          deprecated_renamed_argument)
 from photutils.utils._misc import _get_meta
 from photutils.utils._quantity_helpers import process_quantities
 from photutils.utils._repr import make_repr
@@ -205,8 +205,9 @@ class StarFinderCatalogBase(metaclass=abc.ABCMeta):
         value filtering will be performed.
     """
 
-    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0')
-    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0')
+    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0',
+                                 until='4.0')
+    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0', until='4.0')
     def __init__(self, data, xypos, kernel, *, n_brightest=None,
                  peak_max=None):
         # Validate the units, but do not strip them

photutils/detection/daofinder.py

@@ -8,14 +8,14 @@
 import astropy.units as u
 import numpy as np
 from astropy.utils import lazyproperty
-from astropy.utils.decorators import deprecated_renamed_argument
 
 from photutils.detection.core import (_DEPR_DEFAULT, StarFinderBase,
                                       StarFinderCatalogBase,
                                       _handle_deprecated_range,
                                       _StarFinderKernel, _validate_n_brightest)
 from photutils.utils._convolution import _filter_data
-from photutils.utils._deprecation import deprecated_positional_kwargs
+from photutils.utils._deprecation import (deprecated_positional_kwargs,
+                                          deprecated_renamed_argument)
 from photutils.utils._quantity_helpers import isscalar, process_quantities
 from photutils.utils._repr import make_repr
 from photutils.utils.exceptions import NoDetectionsWarning
@@ -204,8 +204,9 @@ class DAOStarFinder(StarFinderBase):
     """
 
     @deprecated_positional_kwargs(since='3.0', until='4.0')
-    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0')
-    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0')
+    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0',
+                                 until='4.0')
+    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0', until='4.0')
     def __init__(self, threshold, fwhm, ratio=1.0, theta=0.0,
                  sigma_radius=1.5, sharplo=_DEPR_DEFAULT,
                  sharphi=_DEPR_DEFAULT, roundlo=_DEPR_DEFAULT,

photutils/detection/irafstarfinder.py

@@ -7,15 +7,15 @@
 
 import numpy as np
 from astropy.utils import lazyproperty
-from astropy.utils.decorators import deprecated_renamed_argument
 from astropy.utils.exceptions import AstropyDeprecationWarning
 
 from photutils.detection.core import (_DEPR_DEFAULT, StarFinderBase,
                                       StarFinderCatalogBase,
                                       _handle_deprecated_range,
                                       _StarFinderKernel, _validate_n_brightest)
 from photutils.utils._convolution import _filter_data
-from photutils.utils._deprecation import deprecated_positional_kwargs
+from photutils.utils._deprecation import (deprecated_positional_kwargs,
+                                          deprecated_renamed_argument)
 from photutils.utils._quantity_helpers import isscalar, process_quantities
 from photutils.utils._repr import make_repr
 from photutils.utils.exceptions import NoDetectionsWarning
@@ -169,8 +169,9 @@ class IRAFStarFinder(StarFinderBase):
     """
 
     @deprecated_positional_kwargs(since='3.0', until='4.0')
-    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0')
-    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0')
+    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0',
+                                 until='4.0')
+    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0', until='4.0')
     def __init__(self, threshold, fwhm, sigma_radius=1.5,
                  minsep_fwhm=_DEPR_DEFAULT,
                  sharplo=_DEPR_DEFAULT, sharphi=_DEPR_DEFAULT,

photutils/detection/starfinder.py

@@ -7,12 +7,12 @@
 
 import numpy as np
 from astropy.utils import lazyproperty
-from astropy.utils.decorators import deprecated_renamed_argument
 
 from photutils.detection.core import (StarFinderBase, StarFinderCatalogBase,
                                       _validate_n_brightest)
 from photutils.utils._convolution import _filter_data
-from photutils.utils._deprecation import deprecated_positional_kwargs
+from photutils.utils._deprecation import (deprecated_positional_kwargs,
+                                          deprecated_renamed_argument)
 from photutils.utils._quantity_helpers import process_quantities
 from photutils.utils._repr import make_repr
 from photutils.utils.exceptions import NoDetectionsWarning
@@ -82,8 +82,9 @@ class StarFinder(StarFinderBase):
     """
 
     @deprecated_positional_kwargs(since='3.0', until='4.0')
-    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0')
-    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0')
+    @deprecated_renamed_argument('brightest', 'n_brightest', '3.0',
+                                 until='4.0')
+    @deprecated_renamed_argument('peakmax', 'peak_max', '3.0', until='4.0')
     def __init__(self, threshold, kernel, min_separation=None,
                  exclude_border=False, n_brightest=None, peak_max=None):
 

photutils/detection/tests/test_daofinder.py

@@ -551,7 +551,7 @@ def test_deprecated_brightest(self):
         Test that the deprecated 'brightest' keyword raises a warning
         and still works.
         """
-        match = '"brightest" was deprecated'
+        match = "'brightest' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = DAOStarFinder(threshold=5.0, fwhm=3.0, brightest=5)
         assert finder.n_brightest == 5
@@ -561,7 +561,7 @@ def test_deprecated_peakmax(self):
         Test that the deprecated 'peakmax' keyword raises a warning
         and still works.
         """
-        match = '"peakmax" was deprecated'
+        match = "'peakmax' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = DAOStarFinder(threshold=5.0, fwhm=3.0, peakmax=100.0)
         assert finder.peak_max == 100.0

photutils/detection/tests/test_irafstarfinder.py

@@ -502,7 +502,7 @@ def test_deprecated_brightest(self):
         Test that the deprecated 'brightest' keyword raises a warning
         and still works.
         """
-        match = '"brightest" was deprecated'
+        match = "'brightest' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = IRAFStarFinder(threshold=5.0, fwhm=3.0, brightest=5)
         assert finder.n_brightest == 5
@@ -512,7 +512,7 @@ def test_deprecated_peakmax(self):
         Test that the deprecated 'peakmax' keyword raises a warning
         and still works.
         """
-        match = '"peakmax" was deprecated'
+        match = "'peakmax' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = IRAFStarFinder(threshold=5.0, fwhm=3.0, peakmax=100.0)
         assert finder.peak_max == 100.0

photutils/detection/tests/test_starfinder.py

@@ -335,7 +335,7 @@ def test_deprecated_brightest(self, kernel):
         Test that the deprecated 'brightest' keyword raises a warning
         and still works.
         """
-        match = '"brightest" was deprecated'
+        match = "'brightest' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = StarFinder(threshold=5.0, kernel=kernel, brightest=5)
         assert finder.n_brightest == 5
@@ -345,7 +345,7 @@ def test_deprecated_peakmax(self, kernel):
         Test that the deprecated 'peakmax' keyword raises a warning
         and still works.
         """
-        match = '"peakmax" was deprecated'
+        match = "'peakmax' was deprecated"
         with pytest.warns(AstropyDeprecationWarning, match=match):
             finder = StarFinder(threshold=5.0, kernel=kernel, peakmax=100.0)
         assert finder.peak_max == 100.0