Merge pull request #2671 from nkphysics/kwarg-refactors-test-fixes

Cadc and Heasarc Kwarg refactors

Author: ceb8

CHANGES.rst

@@ -227,7 +227,7 @@ Infrastructure, Utility and Other Changes and Additions
 -------------------------------------------------------
 
 - Optional keyword arguments are now keyword only. [#1802, #2477, #2532,
-  #2597, #2601, #2609, #2655, #2656, #2661]
+  #2597, #2601, #2609, #2655, #2656, #2661, #2671]
 
 - New function, ``utils.cleanup_downloads.cleanup_saved_downloads``, is
   added to help the testcleanup narrative in narrative documentations. [#2384]

astroquery/cadc/core.py

@@ -70,7 +70,7 @@ class CadcClass(BaseQuery):
     CADCLOGIN_SERVICE_URI = conf.CADCLOGIN_SERVICE_URI
     TIMEOUT = conf.TIMEOUT
 
-    def __init__(self, url=None, auth_session=None):
+    def __init__(self, *, url=None, auth_session=None):
         """
         Initialize Cadc object
 
@@ -123,10 +123,10 @@ def data_link_url(self):
         if not hasattr(self, '_data_link_url'):
             self._data_link_url = get_access_url(
                 self.CADCDATALINK_SERVICE_URI,
-                "ivo://ivoa.net/std/DataLink#links-1.0")
+                capability="ivo://ivoa.net/std/DataLink#links-1.0")
         return self._data_link_url
 
-    def login(self, user=None, password=None, certificate_file=None):
+    def login(self, *, user=None, password=None, certificate_file=None):
         """
         login allows user to authenticate to the service. Both user/password
         and https client certificates are supported.
@@ -167,7 +167,7 @@ def login(self, user=None, password=None, certificate_file=None):
                 self.cadctap._session.cert = certificate_file
         if user and password:
             login_url = get_access_url(self.CADCLOGIN_SERVICE_URI,
-                                       'ivo://ivoa.net/std/UMS#login-0.1')
+                                       capability='ivo://ivoa.net/std/UMS#login-0.1')
             if login_url is None:
                 raise RuntimeError("No login URL")
             # need to login and get a cookie
@@ -223,7 +223,7 @@ def logout(self):
                 'Do not know how to log out from custom session')
 
     @class_or_instance
-    def query_region_async(self, coordinates, radius=0.016666666666667*u.deg,
+    def query_region_async(self, coordinates, *, radius=0.016666666666667*u.deg,
                            collection=None,
                            get_query_payload=False):
         """
@@ -311,7 +311,7 @@ def get_collections(self):
         return collections
 
     @class_or_instance
-    def get_images(self, coordinates, radius,
+    def get_images(self, coordinates, radius, *,
                    collection=None,
                    get_url_list=False,
                    show_progress=False):
@@ -340,8 +340,8 @@ def get_images(self, coordinates, radius,
         str if returning urls).
         """
 
-        filenames = self.get_images_async(coordinates, radius, collection,
-                                          get_url_list, show_progress)
+        filenames = self.get_images_async(coordinates, radius, collection=collection,
+                                          get_url_list=get_url_list, show_progress=show_progress)
 
         if get_url_list:
             return filenames
@@ -360,7 +360,7 @@ def get_images(self, coordinates, radius,
 
         return images
 
-    def get_images_async(self, coordinates, radius, collection=None,
+    def get_images_async(self, coordinates, radius, *, collection=None,
                          get_url_list=False, show_progress=False):
         """
         A coordinate-based query function that returns a list of
@@ -471,7 +471,7 @@ def get_image_list(self, query_result, coordinates, radius):
         return result
 
     @class_or_instance
-    def get_data_urls(self, query_result, include_auxiliaries=False):
+    def get_data_urls(self, query_result, *, include_auxiliaries=False):
         """
         Function to map the results of a CADC query into URLs to
         corresponding data that can be later downloaded.
@@ -538,7 +538,7 @@ def get_data_urls(self, query_result, include_auxiliaries=False):
                 result.append(service_def.access_url)
         return result
 
-    def get_tables(self, only_names=False):
+    def get_tables(self, *, only_names=False):
         """
         Gets all public tables
 
@@ -575,7 +575,7 @@ def get_table(self, table):
             if table == t.name:
                 return t
 
-    def exec_sync(self, query, maxrec=None, uploads=None, output_file=None,
+    def exec_sync(self, query, *, maxrec=None, uploads=None, output_file=None,
                   output_format='votable'):
         """
         Run a query and return the results or save them in an output_file
@@ -619,7 +619,7 @@ def exec_sync(self, query, maxrec=None, uploads=None, output_file=None,
             result.write(fname, format=output_format, overwrite=True)
         return result
 
-    def create_async(self, query, maxrec=None, uploads=None):
+    def create_async(self, query, *, maxrec=None, uploads=None):
         """
         Creates a TAP job to execute and returns it to the caller. The
         caller then can start the execution and monitor the job.
@@ -674,7 +674,7 @@ def load_async_job(self, jobid):
         return pyvo.dal.AsyncTAPJob('{}/async/{}'.format(
             self.cadctap.baseurl, jobid), session=self._auth_session)
 
-    def list_async_jobs(self, phases=None, after=None, last=None,
+    def list_async_jobs(self, *, phases=None, after=None, last=None,
                         short_description=True):
         """
         Returns all the asynchronous jobs
@@ -701,7 +701,7 @@ def list_async_jobs(self, phases=None, after=None, last=None,
         return self.cadctap.get_job_list(phases=phases, after=after, last=last,
                                          short_description=short_description)
 
-    def _parse_result(self, result, verbose=None):
+    def _parse_result(self, result, *, verbose=None):
         return result
 
     def _args_to_payload(self, *args, **kwargs):
@@ -736,7 +736,7 @@ def decorate(func):
 
 
 @static_vars(caps={})
-def get_access_url(service, capability=None):
+def get_access_url(service, *, capability=None):
     """
     Returns the URL corresponding to a service by doing a lookup in the cadc
     registry. It returns the access URL corresponding to cookie authentication.

astroquery/cadc/tests/test_cadctap.py

@@ -123,7 +123,7 @@ def test_list_async_jobs():
 
 
 @patch('astroquery.cadc.core.get_access_url',
-       Mock(side_effect=lambda x, y=None: 'https://some.url'))
+       Mock(side_effect=lambda x, capability=None: 'https://some.url'))
 @patch('astroquery.cadc.core.pyvo.dal.TAPService.capabilities', [])  # TAP capabilities not needed
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService.capabilities', [])  # DL capabilities not needed
 def test_auth():
@@ -135,7 +135,7 @@ def test_auth():
     password = 'password'
     cert = 'cert'
     with pytest.raises(AttributeError):
-        cadc.login(None, None, None)
+        cadc.login(user=None, password=None, certificate_file=None)
     with pytest.raises(AttributeError):
         cadc.login(user=user)
     with pytest.raises(AttributeError):
@@ -205,11 +205,11 @@ def raise_for_status(self):
                 warnings.filterwarnings("ignore", category=XMLParsedAsHTMLWarning)
 
             assert 'https://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/argus/tables' == \
-                cadc_core.get_access_url('mytap', 'ivo://ivoa.net/std/VOSI#tables-1.1')
+                cadc_core.get_access_url('mytap', capability='ivo://ivoa.net/std/VOSI#tables-1.1')
 
 
 @patch('astroquery.cadc.core.get_access_url',
-       Mock(side_effect=lambda x, y=None: 'https://some.url'))
+       Mock(side_effect=lambda x, capability=None: 'https://some.url'))
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService',
        Mock(return_value=Mock(capabilities=[])))  # DL capabilities not needed
 def test_get_data_urls():
@@ -259,7 +259,7 @@ class Result:
 
 
 @patch('astroquery.cadc.core.get_access_url',
-       Mock(side_effect=lambda x, y=None: 'https://some.url'))
+       Mock(side_effect=lambda x, capability=None: 'https://some.url'))
 def test_misc():
     cadc = Cadc()
 
@@ -288,7 +288,7 @@ def test_misc():
 
 
 @patch('astroquery.cadc.core.get_access_url',
-       Mock(side_effect=lambda x, y=None: 'https://some.url'))
+       Mock(side_effect=lambda x, capability=None: 'https://some.url'))
 @patch('astroquery.cadc.core.pyvo.dal.TAPService',
        Mock(return_value=Mock(capabilities=[])))  # TAP capabilities not needed
 @patch('astroquery.cadc.core.pyvo.dal.adhoc.DatalinkService',
@@ -359,7 +359,7 @@ def __init__(self, **param_dict):
 
 
 @patch('astroquery.cadc.core.get_access_url',
-       Mock(side_effect=lambda x, y=None: 'https://some.url'))
+       Mock(side_effect=lambda x, capability=None: 'https://some.url'))
 def test_exec_sync(tmp_path):
     # save results in a file
     # create the VOTable result

astroquery/heasarc/core.py

@@ -37,7 +37,7 @@ class HeasarcClass(BaseQuery):
     TIMEOUT = conf.timeout
     coord_systems = ['fk5', 'fk4', 'equatorial', 'galactic']
 
-    def query_async(self, request_payload, cache=True, url=None):
+    def query_async(self, request_payload, *, cache=True, url=None):
         """
         Submit a query based on a given request_payload. This allows detailed
         control of the query to be submitted.
@@ -50,7 +50,7 @@ def query_async(self, request_payload, cache=True, url=None):
                                  timeout=self.TIMEOUT, cache=cache)
         return response
 
-    def query_mission_list(self, cache=True, get_query_payload=False):
+    def query_mission_list(self, *, cache=True, get_query_payload=False):
         """
         Returns a list of all available mission tables with descriptions
         """
@@ -76,7 +76,7 @@ def query_mission_list(self, cache=True, get_query_payload=False):
                            data_start=3, data_end=-1)
         return table
 
-    def query_mission_cols(self, mission, cache=True, get_query_payload=False,
+    def query_mission_cols(self, mission, *, cache=True, get_query_payload=False,
                            **kwargs):
         """
         Returns a list containing the names of columns that can be returned for
@@ -108,7 +108,7 @@ def query_mission_cols(self, mission, cache=True, get_query_payload=False,
 
         return self._parse_result(response).colnames
 
-    def query_object_async(self, object_name, mission,
+    def query_object_async(self, object_name, mission, *,
                            cache=True, get_query_payload=False,
                            **kwargs):
         """
@@ -138,7 +138,7 @@ def query_object_async(self, object_name, mission,
         return self.query_async(request_payload, cache=cache)
 
     def query_region_async(self, position: Union[coordinates.SkyCoord, str],
-                           mission, radius, cache=True, get_query_payload=False,
+                           mission, radius, *, cache=True, get_query_payload=False,
                            **kwargs):
         """
         Query around specific set of coordinates within a given mission
@@ -245,7 +245,7 @@ def _blank_table_fallback(self, data):
         warnings.warn(NoResultsWarning("No matching rows were found in the query."))
         return emptytable
 
-    def _parse_result(self, response, verbose=False):
+    def _parse_result(self, response, *, verbose=False):
         # if verbose is False then suppress any VOTable related warnings
         if not verbose:
             commons.suppress_vo_warnings()

docs/cadc/cadc.rst

@@ -188,8 +188,7 @@ cutout coordinates and radius.
     >>> from astropy import units as u
     >>> cadc = Cadc()
     >>> coords = '01h45m07.5s +23d18m00s'
-    >>> radius = 0.1*u.deg
-    >>> results = cadc.query_region(coords, radius, collection='CFHT')
+    >>> results = cadc.query_region(coords, radius=0.1*u.deg, collection='CFHT')
     >>> filtered_results = results[results['time_exposure'] > 120.0]
     >>> image_list = cadc.get_image_list(filtered_results, coords, radius)  # doctest: +IGNORE_WARNINGS
     >>> print(image_list)   # doctest: +IGNORE_OUTPUT

docs/heasarc/heasarc.rst

@@ -263,7 +263,7 @@ tables listing the most recent INTEGRAL data.
     >>> table = heasarc.query_object('Crab', mission='integral_rev3_scw',
     ...                              radius='361 degree', time="2022-12-01 .. 2022-12-31",
     ...                              sortvar='START_DATE', resultmax=100000)
-    >>> table.pprint()
+    >>> table.pprint() # doctest: +IGNORE_OUTPUT
        SCW_ID    SCW_VER SCW_TYPE ... GOOD_OMC   DSIZE     SEARCH_OFFSET_ 
     ------------ ------- -------- ... -------- --------- -----------------
     258300400010 001     POINTING ...        0 123494400 5199.027 (CRAB)\n