Merge pull request #3089 from mkelley/mpc-deprecate-raw-response

Deprecate raw response from non-async method

Author: bsipocz

CHANGES.rst

@@ -43,8 +43,23 @@ mpc
 ^^^
 
 - Parse star catalog information when querying observations database [#2957]
+
 - Parse ephemeris with sky motion with three digit precision [#3026]
-- Raise EmptyResponseError when empty ephemeris reponse is returned [#3026]
+
+- Raise EmptyResponseError when empty ephemeris response is returned [#3026]
+
+- Deprecate ``get_raw_response`` parameter from ``MPC.get_observations``. The
+  raw response may be retrieved from the _async() method. [#3089]
+
+- Remove ``get_raw_response`` parameter from ``MPC.get_ephemeris`` and
+  ``MPC.get_observatory_codes`` without deprecation as the parameters were
+  ignored and had no effect. [#3089]
+
+- Fix bug in ``MPC.get_ephemeris`` that caused the ``cache`` keyword parameter
+  to be ignored. [#3089]
+
+- Remove ``comettype`` parameter from ``MPC.get_observations`` without
+  deprecation: it was undocumented, ignored, and had no effect.  [#3089]
 
 linelists.cdms
 ^^^^^^^^^^^^^^
@@ -191,6 +206,12 @@ mast
 - Support for case-insensitive criteria keyword arguments in ``mast.Observations.query_criteria`` and 
   ``mast.Catalogs.query_criteria``. [#3087]
 
+mpc
+^^^
+
+- Rename ``MPC.get_mpc_object_endpoint`` to ``MPC._get_mpc_object_endpoint`` to
+  indicate that it is a private method. [#3089]
+
 
 0.4.7 (2024-03-08)
 ==================

astroquery/mpc/core.py

@@ -17,6 +17,7 @@
 from . import conf
 from ..utils import async_to_sync, class_or_instance
 from ..exceptions import InvalidQueryError, EmptyResponseError
+from astropy.utils.decorators import deprecated_renamed_argument
 
 __all__ = ['MPCClass']
 
@@ -186,7 +187,7 @@ def query_object_async(self, target_type, *, get_query_payload=False, **kwargs):
 
         """
 
-        self.get_mpc_object_endpoint(target_type)
+        self._get_mpc_object_endpoint(target_type)
 
         kwargs['limit'] = 1
         return self.query_objects_async(target_type, get_query_payload=get_query_payload, **kwargs)
@@ -315,7 +316,7 @@ def query_objects_async(self, target_type, *, get_query_payload=False, **kwargs)
             Limit the number of results to the given value
 
         """
-        mpc_endpoint = self.get_mpc_object_endpoint(target_type)
+        mpc_endpoint = self._get_mpc_object_endpoint(target_type)
 
         if (target_type == 'comet'):
             kwargs['order_by_desc'] = "epoch"
@@ -329,7 +330,7 @@ def query_objects_async(self, target_type, *, get_query_payload=False, **kwargs)
         auth = (self.MPC_USERNAME, self.MPC_PASSWORD)
         return self._request('GET', mpc_endpoint, params=request_args, auth=auth)
 
-    def get_mpc_object_endpoint(self, target_type):
+    def _get_mpc_object_endpoint(self, target_type):
         mpc_endpoint = self.MPC_URL
         if target_type == 'asteroid':
             mpc_endpoint = mpc_endpoint + '/search_orbits'
@@ -344,8 +345,7 @@ def get_ephemeris_async(self, target, *, location='500', start=None, step='1d',
                             proper_motion='total', proper_motion_unit='arcsec/h',
                             suppress_daytime=False, suppress_set=False,
                             perturbed=True, unc_links=False,
-                            get_query_payload=False,
-                            get_raw_response=False, cache=False):
+                            get_query_payload=False, cache=False):
         r"""
         Object ephemerides from the Minor Planet Ephemeris Service.
 
@@ -436,10 +436,6 @@ def get_ephemeris_async(self, target, *, location='500', start=None, step='1d',
             Return the HTTP request parameters as a dictionary
             (default: ``False``).
 
-        get_raw_response : bool, optional
-            Return raw data without parsing into a table (default:
-            ``False``).
-
         cache : bool
             Defaults to False. If set overrides global caching behavior.
             See :ref:`caching documentation <astroquery_cache>`.
@@ -486,7 +482,7 @@ def get_ephemeris_async(self, target, *, location='500', start=None, step='1d',
         | P/2003 CP7 | Comet P/2003 CP7 (LINEAR-NEAT)    |
         +------------+-----------------------------------+
 
-        For comets, P/ and C/ are interchangable.  The designation
+        For comets, P/ and C/ are interchangeable.  The designation
         may also be in a packed format:
 
         +------------+-----------------------------------+
@@ -601,21 +597,18 @@ def get_ephemeris_async(self, target, *, location='500', start=None, step='1d',
             return request_args
 
         self.query_type = 'ephemeris'
-        response = self._request('POST', self.MPES_URL, data=request_args)
+        response = self._request('POST', self.MPES_URL, data=request_args, cache=cache)
 
         return response
 
     @class_or_instance
-    def get_observatory_codes_async(self, *, get_raw_response=False, cache=True):
+    def get_observatory_codes_async(self, *, cache=True):
         """
         Table of observatory codes from the IAU Minor Planet Center.
 
 
         Parameters
         ----------
-        get_raw_response : bool, optional
-            Return raw data without parsing into a table (default:
-            `False`).
 
         cache : bool
             Defaults to True. If set overrides global caching behavior.
@@ -771,9 +764,10 @@ def _args_to_ephemeris_payload(self, **kwargs):
         return request_args
 
     @class_or_instance
+    @deprecated_renamed_argument("get_raw_response", None, since="0.4.8",
+                                 alternative="async methods")
     def get_observations_async(self, targetid, *,
                                id_type=None,
-                               comettype=None,
                                get_mpcformat=False,
                                get_raw_response=False,
                                get_query_payload=False,
@@ -783,6 +777,11 @@ def get_observations_async(self, targetid, *,
         from the `Minor Planet Center observations database
         <https://minorplanetcenter.net/db_search>`_.
 
+        .. deprecated:: 0.4.8
+           The ``get_raw_response`` keyword argument is deprecated.  The
+           `~MPCClass.get_observations_async` method will return a raw response.
+
+
         Parameters
         ----------
         targetid : int or str