DEP: Rename and deprecate selcols for columns

Author: bsipocz

CHANGES.rst

@@ -12,7 +12,8 @@ ipac.irsa
 - The IRSA module's backend has been refactored to favour VO services and to
   run the queries through TAP rather than Gator.
   New method ``query_tap`` is added to enable ADQL queries, async-named
-  methods have been removed. The ``cache`` and ``verbose`` kwargs have been
+  methods have been removed. The ``selcols`` kwarg has been renamed to
+  ``columns``, and the ``cache`` and ``verbose`` kwargs have been
   deprecated as they have no effect. [#2823]
 
 gaia

astroquery/ipac/irsa/core.py

@@ -60,10 +60,10 @@ def query_tap(self, query, *, maxrec=None):
         log.debug(f'TAP query: {query}')
         return self.tap.search(query, language='ADQL', maxrec=maxrec)
 
-    @deprecated_renamed_argument(("cache", "verbose"), (None, None), since="0.4.7")
+    @deprecated_renamed_argument(("selcols", "cache", "verbose"), ("columns", None, None), since="0.4.7")
     def query_region(self, coordinates=None, *, catalog=None, spatial='Cone',
                      radius=10 * u.arcsec, width=None, polygon=None,
-                     get_query_payload=False, selcols=None,
+                     get_query_payload=False, columns=None,
                      verbose=False, cache=True):
         """
         This function serves the same purpose as
@@ -102,7 +102,7 @@ def query_region(self, coordinates=None, *, catalog=None, spatial='Cone',
         get_query_payload : bool, optional
             If `True` then returns the dictionary sent as the HTTP request.
             Defaults to `False`.
-        selcols : str, optional
+        columns : str, optional
             Target column list with value separated by a comma(,)
 
         Returns
@@ -111,10 +111,8 @@ def query_region(self, coordinates=None, *, catalog=None, spatial='Cone',
         if catalog is None:
             raise InvalidQueryError("Catalog name is required!")
 
-        if selcols is None:
+        if columns is None:
             columns = '*'
-        else:
-            columns = selcols
 
         adql = f'SELECT {columns} FROM {catalog}'
 

astroquery/ipac/irsa/tests/test_irsa_remote.py

@@ -4,6 +4,7 @@
 import astropy.units as u
 from astropy.table import Table
 from astropy.coordinates import SkyCoord
+from astropy.utils.exceptions import AstropyDeprecationWarning
 
 try:
     # This requires pyvo 1.4
@@ -32,11 +33,20 @@ def test_query_region_cone(self, coordinates):
         # assert all columns are returned
         assert len(result.colnames) == 64
 
-    def test_query_selcols_radius(self):
+    def test_query_selcols_deprecated(self):
+        """
+        Test renamed selcols
+        """
+        with pytest.warns(AstropyDeprecationWarning, match='"selcols" was deprecated in version'):
+            result = Irsa.query_region("m31", catalog='fp_psc', selcols='ra,dec,j_m')
+
+        assert result.colnames == ['ra', 'dec', 'j_m']
+
+    def test_query_columns_radius(self):
         """
         Test selection of only a few columns, and using a bigger radius
         """
-        result = Irsa.query_region("m31", catalog='fp_psc', selcols='ra,dec,j_m', radius=0.5 * u.arcmin)
+        result = Irsa.query_region("m31", catalog='fp_psc', columns='ra,dec,j_m', radius=0.5 * u.arcmin)
         assert len(result) == 84
         # assert only selected columns are returned
         assert result.colnames == ['ra', 'dec', 'j_m']