Refactor: Made gaia kwargs keyword only

Author: nkphysics

astroquery/gaia/core.py

@@ -46,7 +46,7 @@ class GaiaClass(TapPlus):
     VALID_DATALINK_RETRIEVAL_TYPES = conf.VALID_DATALINK_RETRIEVAL_TYPES
     GAIA_MESSAGES = "notification?action=GetNotifications"
 
-    def __init__(self, tap_plus_conn_handler=None,
+    def __init__(self, *, tap_plus_conn_handler=None,
                  datalink_handler=None,
                  gaia_tap_server='https://gea.esac.esa.int/',
                  gaia_data_server='https://gea.esac.esa.int/',
@@ -79,7 +79,7 @@ def __init__(self, tap_plus_conn_handler=None,
         if show_server_messages:
             self.get_status_messages()
 
-    def login(self, user=None, password=None, credentials_file=None,
+    def login(self, *, user=None, password=None, credentials_file=None,
               verbose=False):
         """Performs a login.
         User and password arguments can be used or a file that contains
@@ -118,7 +118,7 @@ def login(self, user=None, password=None, credentials_file=None,
             log.error("Logging out from TAP server")
             TapPlus.logout(self, verbose=verbose)
 
-    def login_gui(self, verbose=False):
+    def login_gui(self, *, verbose=False):
         """Performs a login using a GUI dialog
 
         Parameters
@@ -143,7 +143,7 @@ def login_gui(self, verbose=False):
             log.error("Logging out from TAP server")
             TapPlus.logout(self, verbose=verbose)
 
-    def logout(self, verbose=False):
+    def logout(self, *, verbose=False):
         """Performs a logout
 
         Parameters
@@ -163,8 +163,9 @@ def logout(self, verbose=False):
         except HTTPError:
             log.error("Error logging out data server")
 
-    def load_data(self, ids, data_release=None, data_structure='INDIVIDUAL', retrieval_type="ALL", valid_data=False,
-                  band=None, avoid_datatype_check=False, format="votable", output_file=None,
+    def load_data(self, ids, *, data_release=None, data_structure='INDIVIDUAL',
+                  retrieval_type="ALL", valid_data=False, band=None,
+                  avoid_datatype_check=False, format="votable", output_file=None,
                   overwrite_output_file=False, verbose=False):
         """Loads the specified table
         TAP+ only
@@ -348,7 +349,7 @@ def __get_data_files(output_file, path):
                 files[key] = tables
         return files
 
-    def get_datalinks(self, ids, verbose=False):
+    def get_datalinks(self, ids, *, verbose=False):
         """Gets datalinks associated to the provided identifiers
         TAP+ only
 
@@ -365,7 +366,7 @@ def get_datalinks(self, ids, verbose=False):
         """
         return self.__gaiadata.get_datalinks(ids=ids, verbose=verbose)
 
-    def __query_object(self, coordinate, radius=None, width=None, height=None,
+    def __query_object(self, coordinate, *, radius=None, width=None, height=None,
                        async_job=False, verbose=False, columns=[]):
         """Launches a job
         TAP & TAP+
@@ -444,7 +445,7 @@ def __query_object(self, coordinate, radius=None, width=None, height=None,
                 job = self.launch_job(query, verbose=verbose)
         return job.get_results()
 
-    def query_object(self, coordinate, radius=None, width=None, height=None,
+    def query_object(self, coordinate, *, radius=None, width=None, height=None,
                      verbose=False, columns=[]):
         """Launches a job
         TAP & TAP+
@@ -468,9 +469,11 @@ def query_object(self, coordinate, radius=None, width=None, height=None,
         -------
         The job results (astropy.table).
         """
-        return self.__query_object(coordinate, radius, width, height, async_job=False, verbose=verbose, columns=columns)
+        return self.__query_object(coordinate, radius=radius,
+                                   width=width, height=height, async_job=False,
+                                   verbose=verbose, columns=columns)
 
-    def query_object_async(self, coordinate, radius=None, width=None,
+    def query_object_async(self, coordinate, *, radius=None, width=None,
                            height=None, verbose=False, columns=[]):
         """Launches a job (async)
         TAP & TAP+
@@ -494,9 +497,11 @@ def query_object_async(self, coordinate, radius=None, width=None,
         -------
         The job results (astropy.table).
         """
-        return self.__query_object(coordinate, radius, width, height, async_job=True, verbose=verbose, columns=columns)
+        return self.__query_object(coordinate, radius=radius, width=width,
+                                   height=height, async_job=True, verbose=verbose,
+                                   columns=columns)
 
-    def __cone_search(self, coordinate, radius, table_name=None,
+    def __cone_search(self, coordinate, radius, *, table_name=None,
                       ra_column_name=MAIN_GAIA_TABLE_RA,
                       dec_column_name=MAIN_GAIA_TABLE_DEC,
                       async_job=False,
@@ -589,7 +594,7 @@ def __cone_search(self, coordinate, radius, table_name=None,
                                    verbose=verbose,
                                    dump_to_file=dump_to_file)
 
-    def cone_search(self, coordinate, radius=None,
+    def cone_search(self, coordinate, *, radius=None,
                     table_name=None,
                     ra_column_name=MAIN_GAIA_TABLE_RA,
                     dec_column_name=MAIN_GAIA_TABLE_DEC,
@@ -639,7 +644,7 @@ def cone_search(self, coordinate, radius=None,
                                   verbose=verbose,
                                   dump_to_file=dump_to_file, columns=columns)
 
-    def cone_search_async(self, coordinate, radius=None,
+    def cone_search_async(self, coordinate, *, radius=None,
                           table_name=None,
                           ra_column_name=MAIN_GAIA_TABLE_RA,
                           dec_column_name=MAIN_GAIA_TABLE_DEC,
@@ -733,7 +738,7 @@ def correct_table_units(table):
             elif isinstance(col.unit, str):
                 col.unit = col.unit.replace(".", " ").replace("'", "")
 
-    def load_user(self, user_id, verbose=False):
+    def load_user(self, user_id, *, verbose=False):
         """Loads the specified user
         TAP+ only
 
@@ -752,7 +757,7 @@ def load_user(self, user_id, verbose=False):
         return self.is_valid_user(user_id=user_id,
                                   verbose=verbose)
 
-    def cross_match(self, full_qualified_table_name_a=None,
+    def cross_match(self, *, full_qualified_table_name_a=None,
                     full_qualified_table_name_b=None,
                     results_table_name=None,
                     radius=1.0,
@@ -818,7 +823,7 @@ def cross_match(self, full_qualified_table_name_a=None,
                                      upload_resource=None,
                                      upload_table_name=None)
 
-    def launch_job(self, query, name=None, output_file=None,
+    def launch_job(self, query, *, name=None, output_file=None,
                    output_format="votable", verbose=False,
                    dump_to_file=False, upload_resource=None,
                    upload_table_name=None):
@@ -861,7 +866,7 @@ def launch_job(self, query, name=None, output_file=None,
                                   upload_resource=upload_resource,
                                   upload_table_name=upload_table_name)
 
-    def launch_job_async(self, query, name=None, output_file=None,
+    def launch_job_async(self, query, *, name=None, output_file=None,
                          output_format="votable", verbose=False,
                          dump_to_file=False, background=False,
                          upload_resource=None, upload_table_name=None,

astroquery/gaia/tests/test_gaia_remote.py

@@ -40,19 +40,19 @@ def test_cone_search_row_limit():
     Gaia = GaiaClass()
     coord = SkyCoord(ra=280, dec=-60, unit=(u.degree, u.degree), frame='icrs')
     radius = u.Quantity(0.1, u.deg)
-    j = Gaia.cone_search_async(coord, radius)
+    j = Gaia.cone_search_async(coord, radius=radius)
     r = j.get_results()
 
     assert len(r) == Gaia.ROW_LIMIT
 
     Gaia.ROW_LIMIT = 10
-    j = Gaia.cone_search_async(coord, radius)
+    j = Gaia.cone_search_async(coord, radius=radius)
     r = j.get_results()
 
     assert len(r) == 10 == Gaia.ROW_LIMIT
 
     Gaia.ROW_LIMIT = -1
-    j = Gaia.cone_search_async(coord, radius)
+    j = Gaia.cone_search_async(coord, radius=radius)
     r = j.get_results()
 
     assert len(r) == 1218

astroquery/gaia/tests/test_gaiatap.py

@@ -60,7 +60,7 @@ def mock_querier():
     launch_response.set_data(method="POST", body=job_data)
     # The query contains decimals: default response is more robust.
     conn_handler.set_default_response(launch_response)
-    return GaiaClass(conn_handler, tapplus, show_server_messages=False)
+    return GaiaClass(tap_plus_conn_handler=conn_handler, datalink_handler=tapplus, show_server_messages=False)
 
 
 @pytest.fixture(scope="module")
@@ -82,7 +82,7 @@ def mock_querier_async():
     results_response.set_data(method="GET", body=job_data)
     conn_handler.set_response("async/" + jobid + "/results/result", results_response)
 
-    return GaiaClass(conn_handler, tapplus, show_server_messages=False)
+    return GaiaClass(tap_plus_conn_handler=conn_handler, datalink_handler=tapplus, show_server_messages=False)
 
 
 def test_show_message():
@@ -100,7 +100,7 @@ def test_show_message():
     connHandler.set_response(tableRequest, dummy_response)
 
     tapplus = TapPlus("http://test:1111/tap", connhandler=connHandler)
-    GaiaClass(connHandler, tapplus, show_server_messages=True)
+    GaiaClass(tap_plus_conn_handler=connHandler, datalink_handler=tapplus, show_server_messages=True)
 
 
 def test_query_object(column_attrs, mock_querier):
@@ -140,7 +140,7 @@ def test_query_object_async(column_attrs, mock_querier_async):
 
 
 def test_cone_search_sync(column_attrs, mock_querier):
-    job = mock_querier.cone_search(skycoord, 1 * u.deg)
+    job = mock_querier.cone_search(skycoord, radius=1 * u.deg)
     assert job.async_ is False
     assert job.get_phase() == "COMPLETED"
     assert job.failed is False
@@ -153,7 +153,7 @@ def test_cone_search_sync(column_attrs, mock_querier):
 
 def test_cone_search_async(column_attrs, mock_querier_async):
     radius = 1.0 * u.deg
-    job = mock_querier_async.cone_search_async(skycoord, radius)
+    job = mock_querier_async.cone_search_async(skycoord, radius=radius)
     assert job.async_ is True
     assert job.get_phase() == "COMPLETED"
     assert job.failed is False
@@ -168,17 +168,17 @@ def test_cone_search_async(column_attrs, mock_querier_async):
     # The preceding tests should have used the default value.
     assert 'gaiadr3.gaia_source' in job.parameters['query']
     with conf.set_temp("MAIN_GAIA_TABLE", "name_from_conf"):
-        job = mock_querier_async.cone_search_async(skycoord, radius)
+        job = mock_querier_async.cone_search_async(skycoord, radius=radius)
         assert "name_from_conf" in job.parameters["query"]
         # Changing the value through the class should overrule conf.
         mock_querier_async.MAIN_GAIA_TABLE = "name_from_class"
-        job = mock_querier_async.cone_search_async(skycoord, radius)
+        job = mock_querier_async.cone_search_async(skycoord, radius=radius)
         assert "name_from_class" in job.parameters["query"]
 
 
 def test_load_data():
     dummy_handler = DummyTapHandler()
-    tap = GaiaClass(dummy_handler, dummy_handler, show_server_messages=False)
+    tap = GaiaClass(tap_plus_conn_handler=dummy_handler, datalink_handler=dummy_handler, show_server_messages=False)
 
     ids = "1,2,3,4"
     retrieval_type = "epoch_photometry"
@@ -211,11 +211,10 @@ def test_load_data():
 
 def test_get_datalinks():
     dummy_handler = DummyTapHandler()
-    tap = GaiaClass(dummy_handler, dummy_handler, show_server_messages=False)
+    tap = GaiaClass(tap_plus_conn_handler=dummy_handler, datalink_handler=dummy_handler, show_server_messages=False)
     ids = ["1", "2", "3", "4"]
-    verbose = True
-    tap.get_datalinks(ids, verbose)
-    dummy_handler.check_call("get_datalinks", {"ids": ids, "verbose": verbose})
+    tap.get_datalinks(ids, verbose=True)
+    dummy_handler.check_call("get_datalinks", {"ids": ids, "verbose": True})
 
 
 def test_xmatch(mock_querier_async):
@@ -310,11 +309,11 @@ def test_xmatch(mock_querier_async):
 def test_login(mock_login):
     conn_handler = DummyConnHandler()
     tapplus = TapPlus("http://test:1111/tap", connhandler=conn_handler)
-    tap = GaiaClass(conn_handler, tapplus, show_server_messages=False)
-    tap.login("user", "password")
+    tap = GaiaClass(tap_plus_conn_handler=conn_handler, datalink_handler=tapplus, show_server_messages=False)
+    tap.login(user="user", password="password")
     assert (mock_login.call_count == 2)
     mock_login.side_effect = HTTPError("Login error")
-    tap.login("user", "password")
+    tap.login(user="user", password="password")
     assert (mock_login.call_count == 3)
 
 
@@ -323,19 +322,19 @@ def test_login(mock_login):
 def test_login_gui(mock_login_gui, mock_login):
     conn_handler = DummyConnHandler()
     tapplus = TapPlus("http://test:1111/tap", connhandler=conn_handler)
-    tap = GaiaClass(conn_handler, tapplus, show_server_messages=False)
+    tap = GaiaClass(tap_plus_conn_handler=conn_handler, datalink_handler=tapplus, show_server_messages=False)
     tap.login_gui()
     assert (mock_login_gui.call_count == 1)
     mock_login_gui.side_effect = HTTPError("Login error")
-    tap.login("user", "password")
+    tap.login(user="user", password="password")
     assert (mock_login.call_count == 1)
 
 
 @patch.object(TapPlus, 'logout')
 def test_logout(mock_logout):
     conn_handler = DummyConnHandler()
     tapplus = TapPlus("http://test:1111/tap", connhandler=conn_handler)
-    tap = GaiaClass(conn_handler, tapplus, show_server_messages=False)
+    tap = GaiaClass(tap_plus_conn_handler=conn_handler, datalink_handler=tapplus, show_server_messages=False)
     tap.logout()
     assert (mock_logout.call_count == 2)
     mock_logout.side_effect = HTTPError("Login error")

docs/gaia/gaia.rst

@@ -164,8 +164,7 @@ radius argument.
   >>>
   >>> Gaia.ROW_LIMIT = 50  # Ensure the default row limit.
   >>> coord = SkyCoord(ra=280, dec=-60, unit=(u.degree, u.degree), frame='icrs')
-  >>> radius = u.Quantity(1.0, u.deg)
-  >>> j = Gaia.cone_search_async(coord, radius)
+  >>> j = Gaia.cone_search_async(coord, radius=u.Quantity(1.0, u.deg))
   INFO: Query finished. [astroquery.utils.tap.core]
   >>> r = j.get_results()
   >>> r.pprint()