Refactor: Made eso kwargs keyword only

Author: nkphysics

astroquery/eso/core.py

@@ -48,7 +48,7 @@ def __init__(self):
         self._survey_list = None
         self.username = None
 
-    def _activate_form(self, response, form_index=0, form_id=None, inputs={},
+    def _activate_form(self, response, *, form_index=0, form_id=None, inputs={},
                        cache=True, method=None):
         """
         Parameters
@@ -191,7 +191,7 @@ def _activate_form(self, response, form_index=0, form_id=None, inputs={},
 
         return response
 
-    def _login(self, username=None, store_password=False,
+    def _login(self, *, username=None, store_password=False,
                reenter_password=False):
         """
         Login to the ESO User Portal.
@@ -257,7 +257,7 @@ def _login(self, username=None, store_password=False,
             keyring.set_password("astroquery:www.eso.org", username, password)
         return authenticated
 
-    def list_instruments(self, cache=True):
+    def list_instruments(self, *, cache=True):
         """ List all the available instrument-specific queries offered by the ESO archive.
 
         Returns
@@ -280,7 +280,7 @@ def list_instruments(self, cache=True):
                         self._instrument_list.append(instrument)
         return self._instrument_list
 
-    def list_surveys(self, cache=True):
+    def list_surveys(self, *, cache=True):
         """ List all the available surveys (phase 3) in the ESO archive.
 
         Returns
@@ -311,7 +311,7 @@ def list_surveys(self, cache=True):
                         self._survey_list.append(survey)
         return self._survey_list
 
-    def query_surveys(self, surveys='', cache=True,
+    def query_surveys(self, *, surveys='', cache=True,
                       help=False, open_form=False, **kwargs):
         """
         Query survey Phase 3 data contained in the ESO archive.
@@ -369,7 +369,7 @@ def query_surveys(self, surveys='', cache=True,
             else:
                 warnings.warn("Query returned no results", NoResultsWarning)
 
-    def query_main(self, column_filters={}, columns=[],
+    def query_main(self, *, column_filters={}, columns=[],
                    open_form=False, help=False, cache=True, **kwargs):
         """
         Query raw data contained in the ESO archive.
@@ -403,7 +403,7 @@ def query_main(self, column_filters={}, columns=[],
         return self._query(url, column_filters=column_filters, columns=columns,
                            open_form=open_form, help=help, cache=cache, **kwargs)
 
-    def query_instrument(self, instrument, column_filters={}, columns=[],
+    def query_instrument(self, instrument, *, column_filters={}, columns=[],
                          open_form=False, help=False, cache=True, **kwargs):
         """
         Query instrument-specific raw data contained in the ESO archive.
@@ -441,7 +441,7 @@ def query_instrument(self, instrument, column_filters={}, columns=[],
         return self._query(url, column_filters=column_filters, columns=columns,
                            open_form=open_form, help=help, cache=cache, **kwargs)
 
-    def _query(self, url, column_filters={}, columns=[],
+    def _query(self, url, *, column_filters={}, columns=[],
                open_form=False, help=False, cache=True, **kwargs):
 
         table = None
@@ -486,7 +486,7 @@ def _query(self, url, column_filters={}, columns=[],
             else:
                 warnings.warn("Query returned no results", NoResultsWarning)
 
-    def get_headers(self, product_ids, cache=True):
+    def get_headers(self, product_ids, *, cache=True):
         """
         Get the headers associated to a list of data product IDs
 
@@ -557,7 +557,7 @@ def get_headers(self, product_ids, cache=True):
         # Return as Table
         return Table(result)
 
-    def _check_existing_files(self, datasets, continuation=False,
+    def _check_existing_files(self, datasets, *, continuation=False,
                               destination=None):
         """Detect already downloaded datasets."""
 
@@ -628,7 +628,7 @@ def _download_file(self, url, local_filepath, **kwargs):
 
         return resp
 
-    def retrieve_data(self, datasets, continuation=False, destination=None,
+    def retrieve_data(self, datasets, *, continuation=False, destination=None,
                       with_calib='none', request_all_objects=False,
                       unzip=True, request_id=None):
         """
@@ -891,7 +891,7 @@ def verify_data_exists(self, dataset):
 
         return 'No data returned' not in content
 
-    def query_apex_quicklooks(self, project_id=None, help=False,
+    def query_apex_quicklooks(self, *, project_id=None, help=False,
                               open_form=False, cache=True, **kwargs):
         """
         APEX data are distributed with quicklook products identified with a
@@ -900,7 +900,7 @@ def query_apex_quicklooks(self, project_id=None, help=False,
 
         Examples
         --------
-        >>> tbl = Eso.query_apex_quicklooks('093.C-0144')
+        >>> tbl = Eso.query_apex_quicklooks(project_id='093.C-0144')
         >>> files = Eso.retrieve_data(tbl['Product ID'])
         """
 
@@ -944,7 +944,7 @@ def query_apex_quicklooks(self, project_id=None, help=False,
 
             return table
 
-    def _print_query_help(self, url, cache=True):
+    def _print_query_help(self, url, *, cache=True):
         """
         Download a form and print it in a quasi-human-readable way
         """
@@ -1006,7 +1006,7 @@ def _print_query_help(self, url, cache=True):
         log.info("\n".join(result_string))
         return result_string
 
-    def _print_surveys_help(self, url, cache=True):
+    def _print_surveys_help(self, url, *, cache=True):
         """
         Download a form and print it in a quasi-human-readable way
         """

astroquery/eso/tests/test_eso.py

@@ -85,7 +85,7 @@ def test_vvv(monkeypatch):
     monkeypatch.setattr(eso, '_request', eso_request)
     eso.cache_location = DATA_DIR
 
-    result_s = eso.query_surveys('VVV',
+    result_s = eso.query_surveys(surveys='VVV',
                                  coord1=266.41681662, coord2=-29.00782497,
                                  box='01 00 00',
                                  )

astroquery/eso/tests/test_eso_remote.py

@@ -37,7 +37,7 @@ def test_SgrAstar(self, tmp_path):
         assert len(surveys) > 0
         # result_s = eso.query_surveys('VVV', target='Sgr A*')
         # Equivalent, does not depend on SESAME:
-        result_s = eso.query_surveys('VVV', coord1=266.41681662,
+        result_s = eso.query_surveys(surveys='VVV', coord1=266.41681662,
                                      coord2=-29.00782497,
                                      box='01 00 00',
                                      cache=False)
@@ -57,7 +57,7 @@ def test_multisurvey(self, tmp_path):
         # first b333 was at 157
         # first pistol....?
 
-        result_s = eso.query_surveys(['VVV', 'XSHOOTER'],
+        result_s = eso.query_surveys(surveys=['VVV', 'XSHOOTER'],
                                      coord1=266.41681662,
                                      coord2=-29.00782497,
                                      box='01 00 00',
@@ -88,7 +88,7 @@ def test_empty_return(self):
 
         # Avoid SESAME
         with pytest.warns(NoResultsWarning):
-            result_s = eso.query_surveys(surveys[0], coord1=202.469575,
+            result_s = eso.query_surveys(surveys=surveys[0], coord1=202.469575,
                                          coord2=47.195258, cache=False)
 
         assert result_s is None
@@ -158,7 +158,7 @@ def test_apex_retrieval(self):
         eso = Eso()
 
         tbl = eso.query_apex_quicklooks(prog_id='095.F-9802')
-        tblb = eso.query_apex_quicklooks('095.F-9802')
+        tblb = eso.query_apex_quicklooks(project_id='095.F-9802')
 
         assert len(tbl) == 5
         assert set(tbl['Release Date']) == {'2015-07-17', '2015-07-18',
@@ -190,20 +190,20 @@ def test_each_survey_and_SgrAstar(self, tmp_path):
         surveys = eso.list_surveys(cache=False)
         for survey in surveys:
             if survey in SGRA_SURVEYS:
-                result_s = eso.query_surveys(survey, coord1=266.41681662,
+                result_s = eso.query_surveys(surveys=survey, coord1=266.41681662,
                                              coord2=-29.00782497,
                                              box='01 00 00',
                                              cache=False)
                 assert len(result_s) > 0
             else:
                 with pytest.warns(NoResultsWarning):
-                    result_s = eso.query_surveys(survey, coord1=266.41681662,
+                    result_s = eso.query_surveys(surveys=survey, coord1=266.41681662,
                                                  coord2=-29.00782497,
                                                  box='01 00 00',
                                                  cache=False)
                     assert result_s is None
 
-                    generic_result = eso.query_surveys(survey)
+                    generic_result = eso.query_surveys(surveys=survey)
                     assert len(generic_result) > 0
 
     def test_mixed_case_instrument(self, tmp_path):

docs/eso/eso.rst

@@ -282,7 +282,7 @@ The archive can be queried as follows:
 
 .. doctest-remote-data::
 
-    >>> table = eso.query_surveys('HARPS', cache=False, target="HD203608")
+    >>> table = eso.query_surveys(surveys='HARPS', cache=False, target="HD203608")
 
 The returned table has an ``ARCFILE`` column. It can be used to retrieve the datasets with
 :meth:`astroquery.eso.EsoClass.retrieve_data` (see next section).