Merge pull request astropy#3607 from karlhillx/fix-3605-naifid-typo

Fix NAIF ID typos in Most: nafid -> naifid

Author: bsipocz

CHANGES.rst

@@ -132,6 +132,14 @@ imcce
 - Change the URL for SkyBot and Miriade Web Services [#3595]
 - Adapted the ``Miriade`` Class to the new outputs of the Web Service [#3595]
 
+ipac.irsa
+^^^^^^^^^
+
+- Fix NAIF ID input mode in ``Most``: the parameter and value ``nafid``
+  were typos; the API expects ``naifid``. Old ``obj_nafid`` keyword and
+  ``"nafid_input"`` ``input_mode`` still work but emit
+  ``AstropyDeprecationWarning``. [#3607]
+
 
 mast
 ^^^^

astroquery/ipac/irsa/most.py

@@ -7,6 +7,8 @@
 
 from astropy.io import votable, fits
 from astropy.table import Table
+from astropy.utils.decorators import deprecated_renamed_argument
+from astropy.utils.exceptions import AstropyDeprecationWarning
 
 from astroquery.query import BaseQuery
 from astroquery.utils import class_or_instance
@@ -56,8 +58,8 @@ def _validate_nafid_input_type(self, params):
             If the input does not have the minimum required parameters set to
             an at least truthy value.
         """
-        if not params.get("obj_nafid", False):
-            raise ValueError("When input type is 'nafid_input' key 'obj_nafid' is required.")
+        if not params.get("obj_naifid", False):
+            raise ValueError("When input type is 'naifid_input' key 'obj_naifid' is required.")
 
     def _validate_mpc_input_type(self, params):
         """
@@ -148,15 +150,15 @@ def _validate_input(self, params):
 
         if input_type == "name_input":
             self._validate_name_input_type(params)
-        elif input_type == "nafid_input":
+        elif input_type == "naifid_input":
             self._validate_nafid_input_type(params)
         elif input_type == "mpc_input":
             self._validate_mpc_input_type(params)
         elif input_type == "manual_input":
             self._validate_manual_input_type(params)
         else:
             raise ValueError(
-                "Unrecognized 'input_type'. Expected `name_input`, `nafid_input` "
+                "Unrecognized 'input_type'. Expected `name_input`, `naifid_input` "
                 f"`mpc_input` or `manual_input`, got {input_type} instead."
             )
 
@@ -229,8 +231,9 @@ def list_catalogs(self):
             catalogs.remove("--- Internal use only:")
         return catalogs
 
+    @deprecated_renamed_argument('obj_nafid', 'obj_naifid', since='0.4.12')
     def get_images(self, catalog="wise_merge", input_mode="name_input", ephem_step=0.25,
-                   obs_begin=None, obs_end=None, obj_name=None, obj_nafid=None, obj_type=None,
+                   obs_begin=None, obs_end=None, obj_name=None, obj_naifid=None, obj_type=None,
                    mpc_data=None, body_designation=None, epoch=None, eccentricity=None,
                    inclination=None, arg_perihelion=None, ascend_node=None, semimajor_axis=None,
                    mean_anomaly=None, perih_dist=None, perih_time=None, get_query_payload=False,
@@ -268,8 +271,8 @@ def get_images(self, catalog="wise_merge", input_mode="name_input", ephem_step=0
         obj_name : str or None
             Object name.
             Required when input mode is ``"name_input"``.
-        obj_nafid : str or None
-            Object NAIFD.
+        obj_naifid : str or None
+            Object NAIF ID.
             Required when input mode is ``"naifid_input"``.
         obj_type : str or None
             Object type, ``"Asteroid"`` or ``Comet``.
@@ -328,6 +331,14 @@ def get_images(self, catalog="wise_merge", input_mode="name_input", ephem_step=0
         images : list
             A list of `~astropy.io.fits.HDUList` objects.
         """
+        if input_mode == "nafid_input":
+            warnings.warn(
+                "'nafid_input' is deprecated; use 'naifid_input' instead (the API value is 'naifid_input').",
+                AstropyDeprecationWarning,
+                stacklevel=2,
+            )
+            input_mode = "naifid_input"
+
         # We insist on output_mode being regular so that it executes quicker,
         # and we insist on tarballs so the download is quicker. We ignore
         # whatever else user provides, but leave the parameters as arguments to
@@ -339,7 +350,7 @@ def get_images(self, catalog="wise_merge", input_mode="name_input", ephem_step=0
             obs_end=obs_end,
             ephem_step=ephem_step,
             obj_name=obj_name,
-            obj_nafid=obj_nafid,
+            obj_naifid=obj_naifid,
             obj_type=obj_type,
             mpc_data=mpc_data,
             body_designation=body_designation,
@@ -376,9 +387,10 @@ def get_images(self, catalog="wise_merge", input_mode="name_input", ephem_step=0
         return images
 
     @class_or_instance
+    @deprecated_renamed_argument('obj_nafid', 'obj_naifid', since='0.4.12')
     def query_object(self, catalog="wise_merge", input_mode="name_input", output_mode="Regular",
                      ephem_step=0.25, with_tarballs=False, obs_begin=None, obs_end=None,
-                     obj_name=None, obj_nafid=None, obj_type=None, mpc_data=None,
+                     obj_name=None, obj_naifid=None, obj_type=None, mpc_data=None,
                      body_designation=None, epoch=None, eccentricity=None, inclination=None,
                      arg_perihelion=None, ascend_node=None, semimajor_axis=None, mean_anomaly=None,
                      perih_dist=None, perih_time=None, get_query_payload=False):
@@ -437,8 +449,8 @@ def query_object(self, catalog="wise_merge", input_mode="name_input", output_mod
         obj_name : str or None
             Object name.
             Required when input mode is ``"name_input"``.
-        obj_nafid : str or None
-            Object NAIFD
+        obj_naifid : str or None
+            Object NAIF ID.
             Required when input mode is ``"naifid_input"``.
         obj_type : str or None
             Object type, ``"Asteroid"`` or ``Comet``
@@ -498,6 +510,14 @@ def query_object(self, catalog="wise_merge", input_mode="name_input", output_mod
             in ``"VOTable"`` an `~astropy.io.votable.tree.VOTableFile`. See
             module help for more details on the content of these tables.
         """
+        if input_mode == "nafid_input":
+            warnings.warn(
+                "'nafid_input' is deprecated; use 'naifid_input' instead (the API value is 'naifid_input').",
+                AstropyDeprecationWarning,
+                stacklevel=2,
+            )
+            input_mode = "naifid_input"
+
         # This is a map between the keyword names used by the MOST cgi-bin
         # service and their more user-friendly names. For example,
         # input_type -> input_mode or fits_region_files --> with tarballs
@@ -510,7 +530,7 @@ def query_object(self, catalog="wise_merge", input_mode="name_input", output_mod
             "ephem_step": ephem_step,
             "fits_region_files": "on" if with_tarballs else "",
             "obj_name": obj_name,
-            "obj_nafid": obj_nafid,
+            "obj_naifid": obj_naifid,
             "obj_type": obj_type,
             "mpc_data": mpc_data,
             "body_designation": body_designation,

astroquery/ipac/irsa/tests/test_most.py

@@ -6,9 +6,10 @@
 
 from astropy.io import votable
 from astropy.table import Table
+from astropy.utils.diff import report_diff_values
+from astropy.utils.exceptions import AstropyDeprecationWarning
 from astroquery.utils.mocks import MockResponse
 from astroquery.ipac.irsa import Most
-from astropy.utils.diff import report_diff_values
 
 
 # each MOST query is given a PID and a temporary directory availible publicly
@@ -248,3 +249,30 @@ def test_gator(patch_requests):
     tbl = Table.read(data_path("most_gator.tbl"), format="ipac")
     silent_stream = io.StringIO()
     assert report_diff_values(tbl, response, silent_stream)
+
+
+def test_naifid_input(patch_requests):
+    """NAIF ID input mode works with the correct 'naifid_input' spelling."""
+    response = Most.query_object(
+        obj_naifid="606",
+        input_mode="naifid_input",
+        output_mode="Brief",
+    )
+    assert len(response) > 0
+
+
+def test_nafid_deprecation(patch_requests):
+    """Deprecated 'obj_nafid' and 'nafid_input' emit AstropyDeprecationWarning."""
+    with pytest.warns(AstropyDeprecationWarning, match="obj_nafid"):
+        Most.query_object(
+            obj_nafid="606",
+            input_mode="naifid_input",
+            output_mode="Brief",
+        )
+
+    with pytest.warns(AstropyDeprecationWarning, match="naifid_input"):
+        Most.query_object(
+            obj_naifid="606",
+            input_mode="nafid_input",
+            output_mode="Brief",
+        )